Interface IIdentityProviderClient

Namespace: System.Dynamic.ExpandoObject

Syntax

[GeneratedCode("NSwag", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public interface IIdentityProviderClient

Methods

GetAllAsync(CancellationToken)

Get all identity providers

Declaration

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

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

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

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

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 Picturepark configuration

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

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

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

UpdateAsync(string, IdentityProviderEditable, CancellationToken)

Update identity provider

Declaration

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 Picturepark configuration

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