Class IdentityProviderClient
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Syntax
[GeneratedCode("NSwag", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public class IdentityProviderClient : ClientBase, IIdentityProviderClient
Constructors
IdentityProviderClient(IPictureparkServiceSettings, HttpClient)
Declaration
public IdentityProviderClient(IPictureparkServiceSettings configuration, HttpClient httpClient)
Parameters
| IPictureparkServiceSettings configuration |
| HttpClient httpClient |
Properties
JsonSerializerSettings
Declaration
protected JsonSerializerSettings JsonSerializerSettings { get; }
Property Value
| JsonSerializerSettings |
ReadResponseAsString
Methods
GetAllAsync(CancellationToken)
Get all identity providers
Declaration
public virtual Task<ICollection<IdentityProvider>> GetAllAsync(CancellationToken cancellationToken = default)
Parameters
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<ICollection<IdentityProvider>>
Array of identity providers |
Implements
Remarks
Gets all identity providers configured
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 |
GetAllBasicInfosAsync(CancellationToken)
Get basic info for all providers
Declaration
public virtual Task<ICollection<IdentityProviderBasicInfo>> GetAllBasicInfosAsync(CancellationToken cancellationToken = default)
Parameters
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<ICollection<IdentityProviderBasicInfo>>
Array of identity provider basic information |
Implements
Remarks
Gets basic information for all identity providers configured
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 identity provider
Declaration
public virtual Task<IdentityProvider> GetAsync(string id, CancellationToken cancellationToken = default)
Parameters
|
string
id
Identity provider ID. |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<IdentityProvider>
Represents an identity provider defined in IdentityServer and its Fotoware Alto configuration |
Implements
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 |
GetSynchronizableAttributesAsync(CancellationToken)
Get synchronizable attributes
Declaration
public virtual Task<ICollection<string>> GetSynchronizableAttributesAsync(CancellationToken cancellationToken = default)
Parameters
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<ICollection<string>>
Names of user attributes |
Implements
Remarks
Returns names of user attributes that can be synchronized from identity provider claims and therefore can be used in ClaimMapping.
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 |
ReadObjectResponseAsync<T>(HttpResponseMessage, IReadOnlyDictionary<string, IEnumerable<string>>, CancellationToken)
Declaration
protected virtual Task<IdentityProviderClient.ObjectResponseResult<T>> ReadObjectResponseAsync<T>(HttpResponseMessage response, IReadOnlyDictionary<string, IEnumerable<string>> headers, CancellationToken cancellationToken)
Parameters
| HttpResponseMessage response |
| IReadOnlyDictionary<string, IEnumerable<string>> headers |
| CancellationToken cancellationToken |
Returns
| Task<IdentityProviderClient.ObjectResponseResult<T>> |
Type Parameters
| T |
UpdateAsync(string, IdentityProviderEditable, CancellationToken)
Update identity provider
Declaration
public virtual Task<IdentityProvider> UpdateAsync(string id, IdentityProviderEditable provider, CancellationToken cancellationToken = default)
Parameters
|
string
id
Identity provider ID. |
|
IdentityProviderEditable
provider
Update request |
|
CancellationToken
cancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
|
Task<IdentityProvider>
Represents an identity provider defined in IdentityServer and its Fotoware Alto configuration |
Implements
Remarks
Identity provider has to be already created via UI
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 |