Interface IUserClient
Namespace: System.Dynamic.ExpandoObject
Syntax
[GeneratedCode("NSwag", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public interface IUserClientMethods
AggregateAsync(UserAggregationRequest, CancellationToken)
Aggregate users
Declaration
Task<ObjectAggregationResult> AggregateAsync(UserAggregationRequest request, CancellationToken cancellationToken = default)Parameters
|
UserAggregationRequest
request
User aggregation request. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<ObjectAggregationResult>
Aggregation based on the request |
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
ArchiveAsync(string, CancellationToken)
Archive user
Declaration
Task ArchiveAsync(string id, CancellationToken cancellationToken = default)Parameters
|
string
id
User ID |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task
OK |
Remarks
Only deleted users can be archived. If a user, before being deleted, was an owner of contents, schemas or permissions sets, the archiving through this endpoint won't be possible:
in such a case the archiving will be executed automatically by the system after the retention time is passed.
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
AssignUserRolesAsync(UserRoleAssignManyRequest, CancellationToken)
Assign or unassign userRoles
Declaration
Task<BusinessProcess> AssignUserRolesAsync(UserRoleAssignManyRequest request, CancellationToken cancellationToken = default)Parameters
|
UserRoleAssignManyRequest
request
Information about users to modify and kind of operation |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<BusinessProcess>
Business process |
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
CancelDeletionRequestAsync(string, CancellationToken)
Cancels a user triggered deletion request and returns user to Reviewed state.
Declaration
Task CancelDeletionRequestAsync(string id, CancellationToken cancellationToken = default)Parameters
|
string
id
User ID to action on. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task
OK |
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
CreateAsync(UserCreateRequest, CancellationToken)
Create user
Declaration
Task<UserDetail> CreateAsync(UserCreateRequest request, CancellationToken cancellationToken = default)Parameters
|
UserCreateRequest
request
Requested user information. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<UserDetail>
Newly created user |
Remarks
User will not be invited.
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
DeleteAsync(string, UserDeleteRequest, CancellationToken)
Delete user
Declaration
Task DeleteAsync(string id, UserDeleteRequest request, CancellationToken cancellationToken = default)Parameters
|
string
id
User ID |
|
UserDeleteRequest
request
Request with details about deletion |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task
OK |
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
GetAsync(string, CancellationToken)
Get user
Declaration
Task<UserDetail> GetAsync(string id, CancellationToken cancellationToken = default)Parameters
|
string
id
User ID to search for. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<UserDetail>
Requested user details |
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
GetByOwnerTokenAsync(string, CancellationToken)
Get user by owner token
Declaration
Task<UserDetail> GetByOwnerTokenAsync(string tokenId, CancellationToken cancellationToken = default)Parameters
|
string
tokenId
ID of the owner token. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<UserDetail>
User details of the user referenced by the owner token |
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
GetManyAsync(IEnumerable<string>, CancellationToken)
Get multiple users
Declaration
Task<ICollection<UserDetail>> GetManyAsync(IEnumerable<string> ids = null, CancellationToken cancellationToken = default)Parameters
|
IEnumerable<string>
ids
User IDs. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<ICollection<UserDetail>>
Details of all the users who were found |
Remarks
Can fetch 100 users at most.
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
InviteAsync(string, CancellationToken)
Invite user
Declaration
Task InviteAsync(string id, CancellationToken cancellationToken = default)Parameters
|
string
id
User ID to action on. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task
OK |
Remarks
Formally invites a user, e.g. sends an invitation email. Transitions AuthorizationState to Invited, implicitly reviews user.
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
InviteManyAsync(UserInviteManyRequest, CancellationToken)
Invite multiple users
Declaration
Task<BusinessProcess> InviteManyAsync(UserInviteManyRequest request, CancellationToken cancellationToken = default)Parameters
|
UserInviteManyRequest
request
Information about users to invite |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<BusinessProcess>
Business process |
Remarks
Formally invites users, e.g. sends an invitation email. Transitions to Invited, implicitly reviews user. The operation is executed asynchronously and is not awaited. Call WaitForCompletion to wait for the process to finish.
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
ListAsync(UserListRequest, CancellationToken)
List users, result contains only essential info about user. Requires the ListUsers or the ManageUsers UserRight.
Declaration
Task<UserListResult> ListAsync(UserListRequest request, CancellationToken cancellationToken = default)Parameters
|
UserListRequest
request
User list request. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<UserListResult>
Result of the list users |
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
LockAsync(string, UserLockRequest, CancellationToken)
Lock / unlock user
Declaration
Task LockAsync(string id, UserLockRequest request, CancellationToken cancellationToken = default)Parameters
|
string
id
User ID to action on. |
|
UserLockRequest
request
Request detailing if the user should be locked or unlocked. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task
OK |
Remarks
Does not affect AuthorizationState of user.
If User is already in desired state, this will be returned as error.
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
LockManyAsync(UserLockManyRequest, CancellationToken)
Change lock state of multiple users
Declaration
Task<BusinessProcess> LockManyAsync(UserLockManyRequest request, CancellationToken cancellationToken = default)Parameters
|
UserLockManyRequest
request
Information about users to update and the desired lock state |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<BusinessProcess>
Business process |
Remarks
Does not affect AuthorizationState of users
Users which are already in desired state will be returned as errors. The operation is executed asynchronously and is not awaited. Call WaitForCompletion to wait for the process to finish.
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
ReInviteManyAsync(UserReinviteManyRequest, CancellationToken)
Reinvite users
Declaration
Task<BusinessProcess> ReInviteManyAsync(UserReinviteManyRequest request, CancellationToken cancellationToken = default)Parameters
|
UserReinviteManyRequest
request
Information about users to reinvite |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<BusinessProcess>
Business process |
Remarks
Formally re-invites users, e.g. sends an invitation email. The operation is executed asynchronously and is not awaited. Call WaitForCompletion to wait for the process to finish.
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
ReinviteAsync(string, CancellationToken)
Reinvite user
Declaration
Task ReinviteAsync(string id, CancellationToken cancellationToken = default)Parameters
|
string
id
User ID to action on. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task
OK |
Remarks
Formally re-invites a user, e.g. sends an invitation email.
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
RestoreAsync(string, CancellationToken)
Restore user
Declaration
Task RestoreAsync(string id, CancellationToken cancellationToken = default)Parameters
|
string
id
User ID to action on. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task
OK |
Remarks
Restores previously deleted user, who was not cleaned up yet.
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
ReviewAsync(string, UserReviewRequest, CancellationToken)
Change user's review state
Declaration
Task ReviewAsync(string id, UserReviewRequest request, CancellationToken cancellationToken = default)Parameters
|
string
id
User ID to action on. |
|
UserReviewRequest
request
Request detailing if the user should be set as reviewed or to be reviewed. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task
OK |
Remarks
Users with AuthorizationState != ToBeReviewed are considered reviewed.
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
ReviewManyAsync(UserReviewManyRequest, CancellationToken)
Change Review state of multiple users
Declaration
Task<BusinessProcess> ReviewManyAsync(UserReviewManyRequest request, CancellationToken cancellationToken = default)Parameters
|
UserReviewManyRequest
request
Information about users to update and the desired review state |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<BusinessProcess>
Business process |
Remarks
Users with AuthorizationState != ToBeReviewed are considered reviewed. The operation is executed asynchronously and is not awaited. Call WaitForCompletion to wait for the process to finish.
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
SearchAsync(UserSearchRequest, CancellationToken)
Search users
Declaration
Task<UserSearchResult> SearchAsync(UserSearchRequest request, CancellationToken cancellationToken = default)Parameters
|
UserSearchRequest
request
User search request. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<UserSearchResult>
Result of the user search |
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
UpdateAsync(string, UserUpdateRequest, CancellationToken)
Update user
Declaration
Task<UserDetail> UpdateAsync(string id, UserUpdateRequest request, CancellationToken cancellationToken = default)Parameters
|
string
id
User ID to action on. |
|
UserUpdateRequest
request
New user information. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<UserDetail>
User details after the update of the user |
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |
UpdateIdentityProviderManyAsync(UserUpdateIdentityProviderManyRequest, CancellationToken)
Update identity provider on multiple users
Declaration
Task<BusinessProcess> UpdateIdentityProviderManyAsync(UserUpdateIdentityProviderManyRequest request, CancellationToken cancellationToken = default)Parameters
|
UserUpdateIdentityProviderManyRequest
request
User update identity provider request. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<BusinessProcess>
Business process |
Exceptions
|
ApiException
A server side error occurred. |
|
PictureparkValidationException
Validation exception |
|
PictureparkForbiddenException
Forbidden |
|
PictureparkNotFoundException
Entity not found |
|
PictureparkConflictException
Version conflict |
|
PictureparkTooManyRequestsException
Too many requests |
|
PictureparkException
Internal server error |