Class SelfServiceProfilesClient

Namespace

Auth0.ManagementApi.Clients

Assembly

Auth0.ManagementApi.dll

Client to manage Self Service Profiles.

public class SelfServiceProfilesClient : BaseClient, ISelfServiceProfilesClient

Inheritance

object

BaseClient

SelfServiceProfilesClient

Implements

ISelfServiceProfilesClient

Inherited Members

BaseClient.Connection

BaseClient.BaseUri

BaseClient.DefaultHeaders

BaseClient.BuildUri(string, IDictionary<string, string>)

BaseClient.BuildUri(string, IList<Tuple<string, string>>)

BaseClient.EncodePath(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SelfServiceProfilesClient(IManagementConnection, Uri, IDictionary<string, string>)

public SelfServiceProfilesClient(IManagementConnection connection, Uri baseUri, IDictionary<string, string> defaultHeaders)

Parameters

connection IManagementConnection

baseUri Uri

defaultHeaders IDictionary<string, string>

Methods

CreateAsync(SelfServiceProfileCreateRequest, CancellationToken)

Create self-service-profile.

public Task<SelfServiceProfile> CreateAsync(SelfServiceProfileCreateRequest request, CancellationToken cancellationToken = default)

Parameters

request SelfServiceProfileCreateRequest

SelfServiceProfileCreateRequest

cancellationToken CancellationToken

CancellationToken

Returns

Task<SelfServiceProfile>

SelfServiceProfile

CreateSsoTicketAsync(string, SelfServiceSsoTicketCreateRequest, CancellationToken)

Creates an sso-access ticket to initiate the Self Service SSO Flow using a self-service profile

public Task<SelfServiceSsoTicket> CreateSsoTicketAsync(string id, SelfServiceSsoTicketCreateRequest request, CancellationToken cancellationToken = default)

Parameters

id string

The id of the sso-profile to retrieve

request SelfServiceSsoTicketCreateRequest

SelfServiceSsoTicketCreateRequest

cancellationToken CancellationToken

CancellationToken

Returns

Task<SelfServiceSsoTicket>

SelfServiceSsoTicket

DeleteAsync(string, CancellationToken)

Delete a self-service-profile by id.

public Task DeleteAsync(string id, CancellationToken cancellationToken = default)

Parameters

id string

Self-Service-Profile ID

cancellationToken CancellationToken

CancellationToken

Returns

Task

GetAllAsync(PaginationInfo, CancellationToken)

Retrieve self-service-profile information.

public Task<IPagedList<SelfServiceProfile>> GetAllAsync(PaginationInfo pagination = null, CancellationToken cancellationToken = default)

Parameters

pagination PaginationInfo

PaginationInfo

cancellationToken CancellationToken

CancellationToken

Returns

Task<IPagedList<SelfServiceProfile>>

IPagedList<T> of SelfServiceProfile

GetAsync(string, CancellationToken)

Retrieve self-service-profile by id.

public Task<SelfServiceProfile> GetAsync(string id, CancellationToken cancellationToken = default)

Parameters

id string

Self-Service-Profile ID

cancellationToken CancellationToken

CancellationToken

Returns

Task<SelfServiceProfile>

SelfServiceProfile

GetCustomTextForSelfServiceProfileAsync(string, string, string, CancellationToken)

Retrieves text customizations for a given self-service profile, language and Self Service SSO Flow page

public Task<object> GetCustomTextForSelfServiceProfileAsync(string id, string language, string page, CancellationToken cancellationToken = default)

Parameters

id string

The id of the self-service profile.

language string

The language of the custom text.

page string

The page where the custom text is shown.

cancellationToken CancellationToken

CancellationToken

Returns

Task<object>

The list of custom text keys and values.

RevokeSsoTicketAsync(string, string, CancellationToken)

Revokes an SSO access ticket and invalidates associated sessions. The ticket will no longer be accepted to initiate a Self-Service SSO session. If any users have already started a session through this ticket, their session will be terminated. Clients should expect a 202 Accepted response upon successful processing, indicating that the request has been acknowledged and that the revocation is underway but may not be fully completed at the time of response. If the specified ticket does not exist, a 202 Accepted response is also returned, signaling that no further action is required. Clients should treat these 202 responses as an acknowledgment that the request has been accepted and is in progress, even if the ticket was not found.

public Task RevokeSsoTicketAsync(string profileId, string ticketId, CancellationToken cancellationToken = default)

Parameters

profileId string

The id of the self-service profile

ticketId string

The id of the ticket to revoke

cancellationToken CancellationToken

CancellationToken

Returns

Task

SelfServiceSsoTicket

SetCustomTextForSelfServiceProfileAsync(string, string, string, object, CancellationToken)

Updates text customizations for a given self-service profile, language and Self Service SSO Flow page.

public Task<object> SetCustomTextForSelfServiceProfileAsync(string id, string language, string page, object body, CancellationToken cancellationToken = default)

Parameters

id string

The id of the self-service profile.

language string

The language of the custom text.

page string

The page where the custom text is shown.

body object

The list of text keys and values to customize the self-service SSO page. Values can be plain text or rich HTML content limited to basic styling tags and hyperlinks.

cancellationToken CancellationToken

CancellationToken

Returns

Task<object>

The resulting list of custom text keys and values.

UpdateAsync(string, SelfServiceProfileUpdateRequest, CancellationToken)

Retrieve self-service-profile by id.

public Task<SelfServiceProfile> UpdateAsync(string id, SelfServiceProfileUpdateRequest request, CancellationToken cancellationToken = default)

Parameters

id string

Self-Service-Profile ID

request SelfServiceProfileUpdateRequest

SelfServiceProfileUpdateRequest

cancellationToken CancellationToken

CancellationToken

Returns

Task<SelfServiceProfile>

SelfServiceProfile