Class DomainsClient

A client that communicates with the Okta management API.

Inheritance
System.Object
OktaClient
DomainsClient
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Okta.Sdk
Assembly: Okta.Sdk.dll
Syntax
public sealed class DomainsClient : OktaClient, IOktaClient, IDomainsClient

Methods

CreateCertificateAsync(IDomainCertificate, String, CancellationToken)

Creates the Certificate for the Domain.

Declaration
public 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
public 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
public 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
public 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
public 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
public 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.

Implements