Interface ICustomDomainsClient
- Namespace
- Auth0.ManagementApi.Clients
- Assembly
- Auth0.ManagementApi.dll
public interface ICustomDomainsClient
Methods
CreateAsync(CustomDomainCreateRequest, CancellationToken)
Creates a new custom domain and returns it.
Task<CustomDomain> CreateAsync(CustomDomainCreateRequest request, CancellationToken cancellationToken = default)
Parameters
request
CustomDomainCreateRequestA CustomDomainCreateRequest representing the new domain.
cancellationToken
CancellationTokenThe cancellation token to cancel operation.
Returns
- Task<CustomDomain>
The CustomDomain containing the newly created custom domain.
Remarks
The custom domain will need to be verified before it starts accepting requests.
DeleteAsync(string, CancellationToken)
Deletes a custom domain by its ID.
Task DeleteAsync(string id, CancellationToken cancellationToken = default)
Parameters
id
stringThe ID of the domain to delete.
cancellationToken
CancellationTokenThe cancellation token to cancel operation.
Returns
Remarks
When deleted, Auth0 will stop serving requests for this domain.
GetAllAsync(CancellationToken)
Retrieves the status of every custom domain.
Task<IList<CustomDomain>> GetAllAsync(CancellationToken cancellationToken = default)
Parameters
cancellationToken
CancellationToken
Returns
- Task<IList<CustomDomain>>
A IList<T> containing the details of every custom domain.
GetAsync(string, CancellationToken)
Retrieves a custom domain status by its ID
Task<CustomDomain> GetAsync(string id, CancellationToken cancellationToken = default)
Parameters
id
stringThe ID of the domain to retrieve.
cancellationToken
CancellationTokenThe cancellation token to cancel operation.
Returns
- Task<CustomDomain>
The CustomDomain that was requested.
VerifyAsync(string, CancellationToken)
Run the verification process for the custom domain.
Task<CustomDomainVerificationResponse> VerifyAsync(string id, CancellationToken cancellationToken = default)
Parameters
id
stringThe ID of the domain to verify.
cancellationToken
CancellationTokenThe cancellation token to cancel operation.
Returns
- Task<CustomDomainVerificationResponse>
The CustomDomainVerification that was requested.