Interface ISchemaPermissionSetClient
Namespace: System.Dynamic.ExpandoObject
Syntax
[GeneratedCode("NSwag", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public interface ISchemaPermissionSetClientMethods
CreateAsync(SchemaPermissionSetCreateRequest, CancellationToken)
Create schema permission set
Declaration
Task<SchemaPermissionSetDetail> CreateAsync(SchemaPermissionSetCreateRequest permissionSet, CancellationToken cancellationToken = default)Parameters
|
SchemaPermissionSetCreateRequest
permissionSet
Permission set |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<SchemaPermissionSetDetail>
Detail of a schema permission set |
Remarks
Creates new schema permission set based on supplied 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 |
CreateManyAsync(SchemaPermissionSetCreateManyRequest, CancellationToken)
Create multiple schema permission sets
Declaration
Task<BulkResponse> CreateManyAsync(SchemaPermissionSetCreateManyRequest request, CancellationToken cancellationToken = default)Parameters
|
SchemaPermissionSetCreateManyRequest
request
Request to update multiple schema permission sets. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<BulkResponse>
Response to a bulk operation |
Remarks
Creates new schema permission sets based on supplied requests.
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, CancellationToken)
Delete schema permission set
Declaration
Task DeleteAsync(string id, CancellationToken cancellationToken = default)Parameters
|
string
id
Schema permission set ID. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Task |
Remarks
Deletes the schema permission set specified by the ID.
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 |
DeleteManyAsync(PermissionSetDeleteManyRequest, CancellationToken)
Delete multiple schema permission sets
Declaration
Task<BulkResponse> DeleteManyAsync(PermissionSetDeleteManyRequest request, CancellationToken cancellationToken = default)Parameters
|
PermissionSetDeleteManyRequest
request
Request to delete multiple permission sets. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<BulkResponse>
Response to a bulk operation |
Remarks
Deletes the schema permission sets specified by the IDs.
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 schema permission set
Declaration
Task<SchemaPermissionSetDetail> GetAsync(string id, CancellationToken cancellationToken = default)Parameters
|
string
id
Schema permission set ID. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<SchemaPermissionSetDetail>
Detail of a schema permission set |
Remarks
Gets the schema permission set detail information by the schema permission set ID.
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 schema permission sets
Declaration
Task<ICollection<SchemaPermissionSetDetail>> GetManyAsync(IEnumerable<string> ids = null, CancellationToken cancellationToken = default)Parameters
|
IEnumerable<string>
ids
Ids |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<ICollection<SchemaPermissionSetDetail>>
Array of Detail of a schema permission set |
Remarks
Gets multiple schema permission set details by the schema permission set IDs.
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 |
GetPermissionsAsync(string, CancellationToken)
Get permissions for schema permission set
Declaration
Task<ICollection<PermissionSetRight>> GetPermissionsAsync(string id, CancellationToken cancellationToken = default)Parameters
|
string
id
Schema permission set ID. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<ICollection<PermissionSetRight>>
Array of Permission set rights |
Remarks
Returns permissions for the schema permission set for the current 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 |
GetPermissionsManyAsync(IEnumerable<string>, CancellationToken)
Get permissions for multiple schema permission sets
Declaration
Task<ICollection<PermissionSetUserPermissionRights>> GetPermissionsManyAsync(IEnumerable<string> ids = null, CancellationToken cancellationToken = default)Parameters
|
IEnumerable<string>
ids
Ids |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<ICollection<PermissionSetUserPermissionRights>>
Array of Rights that the current user has on a permission set |
Remarks
Returns permissions for multiple schema permission sets for the current 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 |
SearchAsync(PermissionSetSearchRequest, CancellationToken)
Search schema permission set
Declaration
Task<PermissionSetSearchResult> SearchAsync(PermissionSetSearchRequest request, CancellationToken cancellationToken = default)Parameters
|
PermissionSetSearchRequest
request
Request to search permission sets. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<PermissionSetSearchResult>
Result of a permission set search operation |
Remarks
Searches schema permission sets as specified in the search 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 |
TransferOwnershipAsync(string, PermissionSetOwnershipTransferRequest, CancellationToken)
Transfer ownership of schema permission set
Declaration
Task TransferOwnershipAsync(string id, PermissionSetOwnershipTransferRequest request, CancellationToken cancellationToken = default)Parameters
|
string
id
Schema permission set ID. |
|
PermissionSetOwnershipTransferRequest
request
Request to transfer the ownership of a permission set. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Task |
Remarks
Transfers ownership of schema permission set to supplied 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 |
TransferOwnershipManyAsync(PermissionSetOwnershipTransferManyRequest, CancellationToken)
Transfer ownership of multiple schema permission sets
Declaration
Task TransferOwnershipManyAsync(PermissionSetOwnershipTransferManyRequest request, CancellationToken cancellationToken = default)Parameters
|
PermissionSetOwnershipTransferManyRequest
request
Request to transfer the ownership of multiple permission sets. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Task |
Remarks
Transfers ownership of multiple schema permission sets to respective supplied 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 |
UpdateAsync(string, SchemaPermissionSetUpdateRequest, CancellationToken)
Update schema permission set
Declaration
Task<SchemaPermissionSetDetail> UpdateAsync(string id, SchemaPermissionSetUpdateRequest permissionSet, CancellationToken cancellationToken = default)Parameters
|
string
id
Schema permission set ID. |
|
SchemaPermissionSetUpdateRequest
permissionSet
Permission set |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<SchemaPermissionSetDetail>
Detail of a schema permission set |
Remarks
Updates the schema permission set specified by the ID and based on supplied 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 |
UpdateManyAsync(SchemaPermissionSetUpdateManyRequest, CancellationToken)
Update multiple schema permission sets
Declaration
Task<BulkResponse> UpdateManyAsync(SchemaPermissionSetUpdateManyRequest request, CancellationToken cancellationToken = default)Parameters
|
SchemaPermissionSetUpdateManyRequest
request
Request to update multiple schema permissions sets. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<BulkResponse>
Response to a bulk operation |
Remarks
Updates the schema permission sets specified by the IDs and based on supplied 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 |