Interface IUserClient
Namespace: System.Dynamic.ExpandoObject
Syntax
public interface IUserClient
Methods
AggregateAsync(UserAggregationRequest, CancellationToken)
Aggregate users
Declaration
Task<ObjectAggregationResult> AggregateAsync(UserAggregationRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
UserAggregationRequest
request
User aggregation request. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.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 |
PictureparkException
Internal server error |
ArchiveAsync(String, CancellationToken)
Archive user
Declaration
Task ArchiveAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
User ID |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task
OK |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
AssignUserRolesAsync(UserRoleAssignManyRequest, CancellationToken)
Assign or unassign userRoles
Declaration
Task<BusinessProcess> AssignUserRolesAsync(UserRoleAssignManyRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
UserRoleAssignManyRequest
request
Information about users to modify and kind of operation |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<BusinessProcess>
Business process |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
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(CancellationToken))
Parameters
System.String
id
User ID to action on. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task
OK |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
CreateAsync(UserCreateRequest, CancellationToken)
Create user
Declaration
Task<UserDetail> CreateAsync(UserCreateRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
UserCreateRequest
request
Requested user information. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<UserDetail>
Newly created user |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
DeleteAsync(String, UserDeleteRequest, CancellationToken)
Delete user
Declaration
Task DeleteAsync(string id, UserDeleteRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
User ID |
UserDeleteRequest
request
Request with details about deletion |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task
OK |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
GetAsync(String, CancellationToken)
Get user
Declaration
Task<UserDetail> GetAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
User ID to search for. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<UserDetail>
Requested user details |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
GetByOwnerTokenAsync(String, CancellationToken)
Get user by owner token
Declaration
Task<UserDetail> GetByOwnerTokenAsync(string tokenId, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
tokenId
ID of the owner token. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.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 |
PictureparkException
Internal server error |
GetManyAsync(IEnumerable<String>, CancellationToken)
Get multiple users
Declaration
Task<ICollection<UserDetail>> GetManyAsync(IEnumerable<string> ids = null, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.Collections.Generic.IEnumerable<System.String>
ids
User IDs. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<System.Collections.Generic.ICollection<UserDetail>>
Details of all the users who were found |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
InviteAsync(String, CancellationToken)
Invite user
Declaration
Task InviteAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
User ID to action on. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task
OK |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
InviteManyAsync(UserInviteManyRequest, CancellationToken)
Invite multiple users
Declaration
Task<BusinessProcess> InviteManyAsync(UserInviteManyRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
UserInviteManyRequest
request
Information about users to invite |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<BusinessProcess>
Business process |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
LockAsync(String, UserLockRequest, CancellationToken)
Lock / unlock user
Declaration
Task LockAsync(string id, UserLockRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
User ID to action on. |
UserLockRequest
request
Request detailing if the user should be locked or unlocked. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task
OK |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
LockManyAsync(UserLockManyRequest, CancellationToken)
Change lock state of multiple users
Declaration
Task<BusinessProcess> LockManyAsync(UserLockManyRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
UserLockManyRequest
request
Information about users to update and the desired lock state |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<BusinessProcess>
Business process |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
ReinviteAsync(String, CancellationToken)
Reinvite user
Declaration
Task ReinviteAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
User ID to action on. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task
OK |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
ReInviteManyAsync(UserReinviteManyRequest, CancellationToken)
Reinvite users
Declaration
Task<BusinessProcess> ReInviteManyAsync(UserReinviteManyRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
UserReinviteManyRequest
request
Information about users to reinvite |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<BusinessProcess>
Business process |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
RestoreAsync(String, CancellationToken)
Restore user
Declaration
Task RestoreAsync(string id, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
User ID to action on. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task
OK |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
ReviewAsync(String, UserReviewRequest, CancellationToken)
Change user's review state
Declaration
Task ReviewAsync(string id, UserReviewRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
User ID to action on. |
UserReviewRequest
request
Request detailing if the user should be set as reviewed or to be reviewed. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task
OK |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
ReviewManyAsync(UserReviewManyRequest, CancellationToken)
Change Review state of multiple users
Declaration
Task<BusinessProcess> ReviewManyAsync(UserReviewManyRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
UserReviewManyRequest
request
Information about users to update and the desired review state |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<BusinessProcess>
Business process |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |
SearchAsync(UserSearchRequest, CancellationToken)
Search users
Declaration
Task<UserSearchResult> SearchAsync(UserSearchRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
UserSearchRequest
request
User search request. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.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 |
PictureparkException
Internal server error |
UpdateAsync(String, UserUpdateRequest, CancellationToken)
Update user
Declaration
Task<UserDetail> UpdateAsync(string id, UserUpdateRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.String
id
User ID to action on. |
UserUpdateRequest
request
New user information. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.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 |
PictureparkException
Internal server error |
UpdateIdentityProviderManyAsync(UserUpdateIdentityProviderManyRequest, CancellationToken)
Update identity provider on multiple users
Declaration
Task<BusinessProcess> UpdateIdentityProviderManyAsync(UserUpdateIdentityProviderManyRequest request, CancellationToken cancellationToken = default(CancellationToken))
Parameters
UserUpdateIdentityProviderManyRequest
request
User update identity provider request. |
System.Threading.CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
System.Threading.Tasks.Task<BusinessProcess>
Business process |
Exceptions
ApiException
A server side error occurred. |
PictureparkValidationException
Validation exception |
PictureparkForbiddenException
Forbidden |
PictureparkNotFoundException
Entity not found |
PictureparkConflictException
Version conflict |
PictureparkException
Internal server error |