Interface IDomainsClient

A client that works with Okta Domain resources.

Namespace: Okta.Sdk

Assembly: Okta.Sdk.dll

Syntax

public interface IDomainsClient

Methods

CreateCertificateAsync(IDomainCertificate, String, CancellationToken)

Creates the Certificate for the Domain.

Declaration

Task CreateCertificateAsync(IDomainCertificate certificate, string domainId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
IDomainCertificate	certificate	The IDomainCertificate resource.
System.String	domainId
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task	A Task that represents the asynchronous operation.

CreateDomainAsync(IDomain, CancellationToken)

Creates your domain.

Declaration

Task<IDomain> CreateDomainAsync(IDomain domain, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
IDomain	domain	The IDomain resource.
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<IDomain>	The IDomain response.

DeleteDomainAsync(String, CancellationToken)

Deletes a Domain by id.

Declaration

Task DeleteDomainAsync(string domainId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	domainId
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task	A Task that represents the asynchronous operation.

GetDomainAsync(String, CancellationToken)

Fetches a Domain by id.

Declaration

Task<IDomain> GetDomainAsync(string domainId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	domainId
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<IDomain>	The IDomain response.

ListDomainsAsync(CancellationToken)

List all verified custom Domains for the org.

Declaration

Task<IDomainListResponse> ListDomainsAsync(CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<IDomainListResponse>	The IDomainListResponse response.

VerifyDomainAsync(String, CancellationToken)

Verifies the Domain by id.

Declaration

Task<IDomain> VerifyDomainAsync(string domainId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	domainId
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<IDomain>	The IDomain response.