Class IdentityDomainsClient

Service client instance for IdentityDomains.

Inheritance

object

ClientBase

IdentityDomainsClient

Implements

IDisposable

Inherited Members

ClientBase.logger

ClientBase.restClient

ClientBase.service

ClientBase.userAgent

ClientBase.Dispose()

ClientBase.Dispose(bool)

ClientBase.SetEndpoint(string)

ClientBase.GetEndpoint()

ClientBase.GetUserAgent()

ClientBase.SetRealmSpecificEndpointTemplate(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.IdentitydomainsService

Assembly: OCI.DotNetSDK.Identitydomains.dll

Syntax

public class IdentityDomainsClient : ClientBase, IDisposable

Constructors

IdentityDomainsClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)

Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.

Declaration

public IdentityDomainsClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)

Parameters

Type	Name	Description
IBasicAuthenticationDetailsProvider	authenticationDetailsProvider	The authentication details provider. Required.
ClientConfiguration	clientConfiguration	The client configuration that contains settings to adjust REST client behaviors. Optional.
string	endpoint	The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional.

Methods

CreateApiKey(CreateApiKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a user's API key.

Declaration

public Task<CreateApiKeyResponse> CreateApiKey(CreateApiKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateApiKeyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateApiKeyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateApiKey API.

CreateApp(CreateAppRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create an App

Declaration

public Task<CreateAppResponse> CreateApp(CreateAppRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateAppRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateAppResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateApp API.

CreateAppRole(CreateAppRoleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create an AppRole

Declaration

public Task<CreateAppRoleResponse> CreateAppRole(CreateAppRoleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateAppRoleRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateAppRoleResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateAppRole API.

CreateApprovalWorkflow(CreateApprovalWorkflowRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create ApprovalWorkflow

Declaration

public Task<CreateApprovalWorkflowResponse> CreateApprovalWorkflow(CreateApprovalWorkflowRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateApprovalWorkflowRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateApprovalWorkflowResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateApprovalWorkflow API.

CreateApprovalWorkflowAssignment(CreateApprovalWorkflowAssignmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create Approval Workflow Assignment

Declaration

public Task<CreateApprovalWorkflowAssignmentResponse> CreateApprovalWorkflowAssignment(CreateApprovalWorkflowAssignmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateApprovalWorkflowAssignmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateApprovalWorkflowAssignmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateApprovalWorkflowAssignment API.

CreateApprovalWorkflowStep(CreateApprovalWorkflowStepRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create ApprovalWorkflowStep

Declaration

public Task<CreateApprovalWorkflowStepResponse> CreateApprovalWorkflowStep(CreateApprovalWorkflowStepRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateApprovalWorkflowStepRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateApprovalWorkflowStepResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateApprovalWorkflowStep API.

CreateAuthToken(CreateAuthTokenRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a user's Auth token.

Declaration

public Task<CreateAuthTokenResponse> CreateAuthToken(CreateAuthTokenRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateAuthTokenRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateAuthTokenResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateAuthToken API.

CreateAuthenticationFactorsRemover(CreateAuthenticationFactorsRemoverRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Remove All Authentication Factor Channels for a User

Declaration

public Task<CreateAuthenticationFactorsRemoverResponse> CreateAuthenticationFactorsRemover(CreateAuthenticationFactorsRemoverRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateAuthenticationFactorsRemoverRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateAuthenticationFactorsRemoverResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateAuthenticationFactorsRemover API.

CreateCloudGate(CreateCloudGateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a Cloud Gate

Declaration

public Task<CreateCloudGateResponse> CreateCloudGate(CreateCloudGateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateCloudGateRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateCloudGateResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateCloudGate API.

CreateCloudGateMapping(CreateCloudGateMappingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a Cloud Gate mapping

Declaration

public Task<CreateCloudGateMappingResponse> CreateCloudGateMapping(CreateCloudGateMappingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateCloudGateMappingRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateCloudGateMappingResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateCloudGateMapping API.

CreateCloudGateServer(CreateCloudGateServerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a Cloud Gate server

Declaration

public Task<CreateCloudGateServerResponse> CreateCloudGateServer(CreateCloudGateServerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateCloudGateServerRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateCloudGateServerResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateCloudGateServer API.

CreateCondition(CreateConditionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a Condition

Declaration

public Task<CreateConditionResponse> CreateCondition(CreateConditionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateConditionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateConditionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateCondition API.

CreateCustomerSecretKey(CreateCustomerSecretKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a user's customer secret key.

Declaration

public Task<CreateCustomerSecretKeyResponse> CreateCustomerSecretKey(CreateCustomerSecretKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateCustomerSecretKeyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateCustomerSecretKeyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateCustomerSecretKey API.

CreateDynamicResourceGroup(CreateDynamicResourceGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a Dynamic Resource Group.

Declaration

public Task<CreateDynamicResourceGroupResponse> CreateDynamicResourceGroup(CreateDynamicResourceGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateDynamicResourceGroupRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateDynamicResourceGroupResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateDynamicResourceGroup API.

CreateGrant(CreateGrantRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Add a Grantee to an AppRole

Declaration

public Task<CreateGrantResponse> CreateGrant(CreateGrantRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateGrantRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateGrantResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateGrant API.

CreateGroup(CreateGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a group.

Declaration

public Task<CreateGroupResponse> CreateGroup(CreateGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateGroupRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateGroupResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateGroup API.

CreateIdentityPropagationTrust(CreateIdentityPropagationTrustRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Register a new Identity Propagation Trust configuration.

Declaration

public Task<CreateIdentityPropagationTrustResponse> CreateIdentityPropagationTrust(CreateIdentityPropagationTrustRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateIdentityPropagationTrustRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateIdentityPropagationTrustResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateIdentityPropagationTrust API.

CreateIdentityProvider(CreateIdentityProviderRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create an Identity Provider

Declaration

public Task<CreateIdentityProviderResponse> CreateIdentityProvider(CreateIdentityProviderRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateIdentityProviderRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateIdentityProviderResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateIdentityProvider API.

CreateMe(CreateMeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Self register a user.

Declaration

public Task<CreateMeResponse> CreateMe(CreateMeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateMeRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateMeResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateMe API.

CreateMyApiKey(CreateMyApiKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Add a user's own API key.

Declaration

public Task<CreateMyApiKeyResponse> CreateMyApiKey(CreateMyApiKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateMyApiKeyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateMyApiKeyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateMyApiKey API.

CreateMyAuthToken(CreateMyAuthTokenRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a user's own Auth token.

Declaration

public Task<CreateMyAuthTokenResponse> CreateMyAuthToken(CreateMyAuthTokenRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateMyAuthTokenRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateMyAuthTokenResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateMyAuthToken API.

CreateMyAuthenticationFactorInitiator(CreateMyAuthenticationFactorInitiatorRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Initiate Self Service Enrollment using the Requested MFA Factor

Declaration

public Task<CreateMyAuthenticationFactorInitiatorResponse> CreateMyAuthenticationFactorInitiator(CreateMyAuthenticationFactorInitiatorRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateMyAuthenticationFactorInitiatorRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateMyAuthenticationFactorInitiatorResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateMyAuthenticationFactorInitiator API.

CreateMyAuthenticationFactorValidator(CreateMyAuthenticationFactorValidatorRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Validate Self Service Enrollment using the Requested MFA Factor

Declaration

public Task<CreateMyAuthenticationFactorValidatorResponse> CreateMyAuthenticationFactorValidator(CreateMyAuthenticationFactorValidatorRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateMyAuthenticationFactorValidatorRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateMyAuthenticationFactorValidatorResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateMyAuthenticationFactorValidator API.

CreateMyAuthenticationFactorsRemover(CreateMyAuthenticationFactorsRemoverRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Remove All Authentication Factor Channels for a User

Declaration

public Task<CreateMyAuthenticationFactorsRemoverResponse> CreateMyAuthenticationFactorsRemover(CreateMyAuthenticationFactorsRemoverRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateMyAuthenticationFactorsRemoverRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateMyAuthenticationFactorsRemoverResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateMyAuthenticationFactorsRemover API.

CreateMyCustomerSecretKey(CreateMyCustomerSecretKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Add a user's own customer secret key.

Declaration

public Task<CreateMyCustomerSecretKeyResponse> CreateMyCustomerSecretKey(CreateMyCustomerSecretKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateMyCustomerSecretKeyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateMyCustomerSecretKeyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateMyCustomerSecretKey API.

CreateMyOAuth2ClientCredential(CreateMyOAuth2ClientCredentialRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a user's own OAuth2 client credential.

Declaration

public Task<CreateMyOAuth2ClientCredentialResponse> CreateMyOAuth2ClientCredential(CreateMyOAuth2ClientCredentialRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateMyOAuth2ClientCredentialRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateMyOAuth2ClientCredentialResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateMyOAuth2ClientCredential API.

CreateMyRequest(CreateMyRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a Request

Declaration

public Task<CreateMyRequestResponse> CreateMyRequest(CreateMyRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateMyRequestRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateMyRequestResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateMyRequest API.

CreateMySmtpCredential(CreateMySmtpCredentialRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a user's own SMTP credential.

Declaration

public Task<CreateMySmtpCredentialResponse> CreateMySmtpCredential(CreateMySmtpCredentialRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateMySmtpCredentialRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateMySmtpCredentialResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateMySmtpCredential API.

CreateMySupportAccount(CreateMySupportAccountRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a user's own support account.

Declaration

public Task<CreateMySupportAccountResponse> CreateMySupportAccount(CreateMySupportAccountRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateMySupportAccountRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateMySupportAccountResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateMySupportAccount API.

CreateMyUserDbCredential(CreateMyUserDbCredentialRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a user's own database (DB) credential.

Declaration

public Task<CreateMyUserDbCredentialResponse> CreateMyUserDbCredential(CreateMyUserDbCredentialRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateMyUserDbCredentialRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateMyUserDbCredentialResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateMyUserDbCredential API.

CreateNetworkPerimeter(CreateNetworkPerimeterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a NetworkPerimeter

Declaration

public Task<CreateNetworkPerimeterResponse> CreateNetworkPerimeter(CreateNetworkPerimeterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateNetworkPerimeterRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateNetworkPerimeterResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateNetworkPerimeter API.

CreateOAuth2ClientCredential(CreateOAuth2ClientCredentialRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Add a user's OAuth2 client credentials.

Declaration

public Task<CreateOAuth2ClientCredentialResponse> CreateOAuth2ClientCredential(CreateOAuth2ClientCredentialRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateOAuth2ClientCredentialRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateOAuth2ClientCredentialResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateOAuth2ClientCredential API.

CreateOAuthClientCertificate(CreateOAuthClientCertificateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create an OAuth Client Certificate

Declaration

public Task<CreateOAuthClientCertificateResponse> CreateOAuthClientCertificate(CreateOAuthClientCertificateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateOAuthClientCertificateRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateOAuthClientCertificateResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateOAuthClientCertificate API.

CreateOAuthPartnerCertificate(CreateOAuthPartnerCertificateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create an OAuth Partner Certificate

Declaration

public Task<CreateOAuthPartnerCertificateResponse> CreateOAuthPartnerCertificate(CreateOAuthPartnerCertificateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateOAuthPartnerCertificateRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateOAuthPartnerCertificateResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateOAuthPartnerCertificate API.

CreatePasswordPolicy(CreatePasswordPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a password policy.

Declaration

public Task<CreatePasswordPolicyResponse> CreatePasswordPolicy(CreatePasswordPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreatePasswordPolicyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreatePasswordPolicyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreatePasswordPolicy API.

CreatePolicy(CreatePolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a Policy

Declaration

public Task<CreatePolicyResponse> CreatePolicy(CreatePolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreatePolicyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreatePolicyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreatePolicy API.

CreateRule(CreateRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a Rule

Declaration

public Task<CreateRuleResponse> CreateRule(CreateRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateRuleRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateRuleResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateRule API.

CreateSecurityQuestion(CreateSecurityQuestionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a security question.

Declaration

public Task<CreateSecurityQuestionResponse> CreateSecurityQuestion(CreateSecurityQuestionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateSecurityQuestionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateSecurityQuestionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateSecurityQuestion API.

CreateSelfRegistrationProfile(CreateSelfRegistrationProfileRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a self-registration profile.

Declaration

public Task<CreateSelfRegistrationProfileResponse> CreateSelfRegistrationProfile(CreateSelfRegistrationProfileRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateSelfRegistrationProfileRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateSelfRegistrationProfileResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateSelfRegistrationProfile API.

CreateSmtpCredential(CreateSmtpCredentialRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a user's SMTP credentials.

Declaration

public Task<CreateSmtpCredentialResponse> CreateSmtpCredential(CreateSmtpCredentialRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateSmtpCredentialRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateSmtpCredentialResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateSmtpCredential API.

CreateSocialIdentityProvider(CreateSocialIdentityProviderRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a Social Identity Provider

Declaration

public Task<CreateSocialIdentityProviderResponse> CreateSocialIdentityProvider(CreateSocialIdentityProviderRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateSocialIdentityProviderRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateSocialIdentityProviderResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateSocialIdentityProvider API.

CreateUser(CreateUserRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a user.

Declaration

public Task<CreateUserResponse> CreateUser(CreateUserRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateUserRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateUserResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateUser API.

CreateUserDbCredential(CreateUserDbCredentialRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a user's database (DB) credentials.

Declaration

public Task<CreateUserDbCredentialResponse> CreateUserDbCredential(CreateUserDbCredentialRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateUserDbCredentialRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateUserDbCredentialResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateUserDbCredential API.

DeleteApiKey(DeleteApiKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a user's API key.

Declaration

public Task<DeleteApiKeyResponse> DeleteApiKey(DeleteApiKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteApiKeyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteApiKeyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteApiKey API.

DeleteApp(DeleteAppRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete an App

Declaration

public Task<DeleteAppResponse> DeleteApp(DeleteAppRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteAppRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteAppResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteApp API.

DeleteAppRole(DeleteAppRoleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete an AppRole

Declaration

public Task<DeleteAppRoleResponse> DeleteAppRole(DeleteAppRoleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteAppRoleRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteAppRoleResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteAppRole API.

DeleteApprovalWorkflow(DeleteApprovalWorkflowRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete ApprovalWorkflow

Declaration

public Task<DeleteApprovalWorkflowResponse> DeleteApprovalWorkflow(DeleteApprovalWorkflowRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteApprovalWorkflowRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteApprovalWorkflowResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteApprovalWorkflow API.

DeleteApprovalWorkflowAssignment(DeleteApprovalWorkflowAssignmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete Approval Workflow Assignment

Declaration

public Task<DeleteApprovalWorkflowAssignmentResponse> DeleteApprovalWorkflowAssignment(DeleteApprovalWorkflowAssignmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteApprovalWorkflowAssignmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteApprovalWorkflowAssignmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteApprovalWorkflowAssignment API.

DeleteApprovalWorkflowStep(DeleteApprovalWorkflowStepRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete ApprovalWorkflowStep

Declaration

public Task<DeleteApprovalWorkflowStepResponse> DeleteApprovalWorkflowStep(DeleteApprovalWorkflowStepRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteApprovalWorkflowStepRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteApprovalWorkflowStepResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteApprovalWorkflowStep API.

DeleteAuthToken(DeleteAuthTokenRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a user's Auth token.

Declaration

public Task<DeleteAuthTokenResponse> DeleteAuthToken(DeleteAuthTokenRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteAuthTokenRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteAuthTokenResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteAuthToken API.

DeleteCloudGate(DeleteCloudGateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a Cloud Gate

Declaration

public Task<DeleteCloudGateResponse> DeleteCloudGate(DeleteCloudGateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteCloudGateRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteCloudGateResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteCloudGate API.

DeleteCloudGateMapping(DeleteCloudGateMappingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a Cloud Gate mapping

Declaration

public Task<DeleteCloudGateMappingResponse> DeleteCloudGateMapping(DeleteCloudGateMappingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteCloudGateMappingRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteCloudGateMappingResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteCloudGateMapping API.

DeleteCloudGateServer(DeleteCloudGateServerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a Cloud Gate server

Declaration

public Task<DeleteCloudGateServerResponse> DeleteCloudGateServer(DeleteCloudGateServerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteCloudGateServerRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteCloudGateServerResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteCloudGateServer API.

DeleteCondition(DeleteConditionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a Condition

Declaration

public Task<DeleteConditionResponse> DeleteCondition(DeleteConditionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteConditionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteConditionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteCondition API.

DeleteCustomerSecretKey(DeleteCustomerSecretKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a user's customer secret key.

Declaration

public Task<DeleteCustomerSecretKeyResponse> DeleteCustomerSecretKey(DeleteCustomerSecretKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteCustomerSecretKeyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteCustomerSecretKeyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteCustomerSecretKey API.

DeleteDynamicResourceGroup(DeleteDynamicResourceGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a Dynamic Resource Group.

Declaration

public Task<DeleteDynamicResourceGroupResponse> DeleteDynamicResourceGroup(DeleteDynamicResourceGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteDynamicResourceGroupRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteDynamicResourceGroupResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteDynamicResourceGroup API.

DeleteGrant(DeleteGrantRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Remove a Grantee from an AppRole

Declaration

public Task<DeleteGrantResponse> DeleteGrant(DeleteGrantRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteGrantRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteGrantResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteGrant API.

DeleteGroup(DeleteGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a group.

Declaration

public Task<DeleteGroupResponse> DeleteGroup(DeleteGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteGroupRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteGroupResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteGroup API.

DeleteIdentityPropagationTrust(DeleteIdentityPropagationTrustRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete an existing Identity Propagation Trust configuration.

Declaration

public Task<DeleteIdentityPropagationTrustResponse> DeleteIdentityPropagationTrust(DeleteIdentityPropagationTrustRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteIdentityPropagationTrustRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteIdentityPropagationTrustResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteIdentityPropagationTrust API.

DeleteIdentityProvider(DeleteIdentityProviderRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete an Identity Provider

Declaration

public Task<DeleteIdentityProviderResponse> DeleteIdentityProvider(DeleteIdentityProviderRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteIdentityProviderRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteIdentityProviderResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteIdentityProvider API.

DeleteMyApiKey(DeleteMyApiKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a user's own API key.

Declaration

public Task<DeleteMyApiKeyResponse> DeleteMyApiKey(DeleteMyApiKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteMyApiKeyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteMyApiKeyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteMyApiKey API.

DeleteMyAuthToken(DeleteMyAuthTokenRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a user's own Auth token.

Declaration

public Task<DeleteMyAuthTokenResponse> DeleteMyAuthToken(DeleteMyAuthTokenRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteMyAuthTokenRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteMyAuthTokenResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteMyAuthToken API.

DeleteMyCustomerSecretKey(DeleteMyCustomerSecretKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a user's own customer secret key.

Declaration

public Task<DeleteMyCustomerSecretKeyResponse> DeleteMyCustomerSecretKey(DeleteMyCustomerSecretKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteMyCustomerSecretKeyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteMyCustomerSecretKeyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteMyCustomerSecretKey API.

DeleteMyDevice(DeleteMyDeviceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a Device

Declaration

public Task<DeleteMyDeviceResponse> DeleteMyDevice(DeleteMyDeviceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteMyDeviceRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteMyDeviceResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteMyDevice API.

DeleteMyOAuth2ClientCredential(DeleteMyOAuth2ClientCredentialRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a user's own OAuth2 client credential.

Declaration

public Task<DeleteMyOAuth2ClientCredentialResponse> DeleteMyOAuth2ClientCredential(DeleteMyOAuth2ClientCredentialRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteMyOAuth2ClientCredentialRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteMyOAuth2ClientCredentialResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteMyOAuth2ClientCredential API.

DeleteMySmtpCredential(DeleteMySmtpCredentialRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a user's own SMTP credential.

Declaration

public Task<DeleteMySmtpCredentialResponse> DeleteMySmtpCredential(DeleteMySmtpCredentialRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteMySmtpCredentialRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteMySmtpCredentialResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteMySmtpCredential API.

DeleteMySupportAccount(DeleteMySupportAccountRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a user's own support account.

Declaration

public Task<DeleteMySupportAccountResponse> DeleteMySupportAccount(DeleteMySupportAccountRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteMySupportAccountRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteMySupportAccountResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteMySupportAccount API.

DeleteMyTrustedUserAgent(DeleteMyTrustedUserAgentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a Trusted User Agent

Declaration

public Task<DeleteMyTrustedUserAgentResponse> DeleteMyTrustedUserAgent(DeleteMyTrustedUserAgentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteMyTrustedUserAgentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteMyTrustedUserAgentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteMyTrustedUserAgent API.

DeleteMyUserDbCredential(DeleteMyUserDbCredentialRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a user's own database (DB) credential.

Declaration

public Task<DeleteMyUserDbCredentialResponse> DeleteMyUserDbCredential(DeleteMyUserDbCredentialRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteMyUserDbCredentialRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteMyUserDbCredentialResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteMyUserDbCredential API.

DeleteNetworkPerimeter(DeleteNetworkPerimeterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a NetworkPerimeter

Declaration

public Task<DeleteNetworkPerimeterResponse> DeleteNetworkPerimeter(DeleteNetworkPerimeterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteNetworkPerimeterRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteNetworkPerimeterResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteNetworkPerimeter API.

DeleteOAuth2ClientCredential(DeleteOAuth2ClientCredentialRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a user's OAuth2 client credentials.

Declaration

public Task<DeleteOAuth2ClientCredentialResponse> DeleteOAuth2ClientCredential(DeleteOAuth2ClientCredentialRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteOAuth2ClientCredentialRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteOAuth2ClientCredentialResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteOAuth2ClientCredential API.

DeleteOAuthClientCertificate(DeleteOAuthClientCertificateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete an OAuth Client Certificate

Declaration

public Task<DeleteOAuthClientCertificateResponse> DeleteOAuthClientCertificate(DeleteOAuthClientCertificateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteOAuthClientCertificateRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteOAuthClientCertificateResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteOAuthClientCertificate API.

DeleteOAuthPartnerCertificate(DeleteOAuthPartnerCertificateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete an OAuth Partner Certificate

Declaration

public Task<DeleteOAuthPartnerCertificateResponse> DeleteOAuthPartnerCertificate(DeleteOAuthPartnerCertificateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteOAuthPartnerCertificateRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteOAuthPartnerCertificateResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteOAuthPartnerCertificate API.

DeletePasswordPolicy(DeletePasswordPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a password policy.

Declaration

public Task<DeletePasswordPolicyResponse> DeletePasswordPolicy(DeletePasswordPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeletePasswordPolicyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeletePasswordPolicyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeletePasswordPolicy API.

DeletePolicy(DeletePolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a Policy

Declaration

public Task<DeletePolicyResponse> DeletePolicy(DeletePolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeletePolicyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeletePolicyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeletePolicy API.

DeleteRule(DeleteRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a Rule

Declaration

public Task<DeleteRuleResponse> DeleteRule(DeleteRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteRuleRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteRuleResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteRule API.

DeleteSecurityQuestion(DeleteSecurityQuestionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a security question.

Declaration

public Task<DeleteSecurityQuestionResponse> DeleteSecurityQuestion(DeleteSecurityQuestionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteSecurityQuestionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteSecurityQuestionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteSecurityQuestion API.

DeleteSelfRegistrationProfile(DeleteSelfRegistrationProfileRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a self-registration profile.

Declaration

public Task<DeleteSelfRegistrationProfileResponse> DeleteSelfRegistrationProfile(DeleteSelfRegistrationProfileRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteSelfRegistrationProfileRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteSelfRegistrationProfileResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteSelfRegistrationProfile API.

DeleteSmtpCredential(DeleteSmtpCredentialRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a user's SMTP credentials.

Declaration

public Task<DeleteSmtpCredentialResponse> DeleteSmtpCredential(DeleteSmtpCredentialRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteSmtpCredentialRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteSmtpCredentialResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteSmtpCredential API.

DeleteSocialIdentityProvider(DeleteSocialIdentityProviderRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a Social Identity Provider

Declaration

public Task<DeleteSocialIdentityProviderResponse> DeleteSocialIdentityProvider(DeleteSocialIdentityProviderRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteSocialIdentityProviderRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteSocialIdentityProviderResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteSocialIdentityProvider API.

DeleteUser(DeleteUserRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a user.

Declaration

public Task<DeleteUserResponse> DeleteUser(DeleteUserRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteUserRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteUserResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteUser API.

DeleteUserDbCredential(DeleteUserDbCredentialRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a user's database (DB) credentials.

Declaration

public Task<DeleteUserDbCredentialResponse> DeleteUserDbCredential(DeleteUserDbCredentialRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteUserDbCredentialRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteUserDbCredentialResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteUserDbCredential API.

GetAccountMgmtInfo(GetAccountMgmtInfoRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get Account Mgmt Info

Declaration

public Task<GetAccountMgmtInfoResponse> GetAccountMgmtInfo(GetAccountMgmtInfoRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetAccountMgmtInfoRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetAccountMgmtInfoResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetAccountMgmtInfo API.

GetAccountRecoverySetting(GetAccountRecoverySettingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get an account recovery setting.

Declaration

public Task<GetAccountRecoverySettingResponse> GetAccountRecoverySetting(GetAccountRecoverySettingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetAccountRecoverySettingRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetAccountRecoverySettingResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetAccountRecoverySetting API.

GetApiKey(GetApiKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a user's API key.

Declaration

public Task<GetApiKeyResponse> GetApiKey(GetApiKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetApiKeyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetApiKeyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetApiKey API.

GetApp(GetAppRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get an App

Declaration

public Task<GetAppResponse> GetApp(GetAppRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetAppRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetAppResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetApp API.

GetAppRole(GetAppRoleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get an AppRole

Declaration

public Task<GetAppRoleResponse> GetAppRole(GetAppRoleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetAppRoleRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetAppRoleResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetAppRole API.

GetApprovalWorkflow(GetApprovalWorkflowRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get ApprovalWorkflow

Declaration

public Task<GetApprovalWorkflowResponse> GetApprovalWorkflow(GetApprovalWorkflowRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetApprovalWorkflowRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetApprovalWorkflowResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetApprovalWorkflow API.

GetApprovalWorkflowAssignment(GetApprovalWorkflowAssignmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get an Approval Workflow Assignment

Declaration

public Task<GetApprovalWorkflowAssignmentResponse> GetApprovalWorkflowAssignment(GetApprovalWorkflowAssignmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetApprovalWorkflowAssignmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetApprovalWorkflowAssignmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetApprovalWorkflowAssignment API.

GetApprovalWorkflowStep(GetApprovalWorkflowStepRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get ApprovalWorkflowStep

Declaration

public Task<GetApprovalWorkflowStepResponse> GetApprovalWorkflowStep(GetApprovalWorkflowStepRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetApprovalWorkflowStepRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetApprovalWorkflowStepResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetApprovalWorkflowStep API.

GetAuthToken(GetAuthTokenRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a user's Auth token.

Declaration

public Task<GetAuthTokenResponse> GetAuthToken(GetAuthTokenRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetAuthTokenRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetAuthTokenResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetAuthToken API.

GetAuthenticationFactorSetting(GetAuthenticationFactorSettingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get Authentication Factor Settings

Declaration

public Task<GetAuthenticationFactorSettingResponse> GetAuthenticationFactorSetting(GetAuthenticationFactorSettingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetAuthenticationFactorSettingRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetAuthenticationFactorSettingResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetAuthenticationFactorSetting API.

GetBrandingSetting(GetBrandingSettingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get Branding Settings

Declaration

public Task<GetBrandingSettingResponse> GetBrandingSetting(GetBrandingSettingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetBrandingSettingRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetBrandingSettingResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetBrandingSetting API.

GetCloudGate(GetCloudGateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a Cloud Gate

Declaration

public Task<GetCloudGateResponse> GetCloudGate(GetCloudGateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetCloudGateRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetCloudGateResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetCloudGate API.

GetCloudGateMapping(GetCloudGateMappingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a Cloud Gate mapping

Declaration

public Task<GetCloudGateMappingResponse> GetCloudGateMapping(GetCloudGateMappingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetCloudGateMappingRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetCloudGateMappingResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetCloudGateMapping API.

GetCloudGateServer(GetCloudGateServerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a Cloud Gate server

Declaration

public Task<GetCloudGateServerResponse> GetCloudGateServer(GetCloudGateServerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetCloudGateServerRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetCloudGateServerResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetCloudGateServer API.

GetCondition(GetConditionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a Condition

Declaration

public Task<GetConditionResponse> GetCondition(GetConditionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetConditionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetConditionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetCondition API.

GetCustomerSecretKey(GetCustomerSecretKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a user's customer secret key.

Declaration

public Task<GetCustomerSecretKeyResponse> GetCustomerSecretKey(GetCustomerSecretKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetCustomerSecretKeyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetCustomerSecretKeyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetCustomerSecretKey API.

GetDynamicResourceGroup(GetDynamicResourceGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a Dynamic Resource Group.

Declaration

public Task<GetDynamicResourceGroupResponse> GetDynamicResourceGroup(GetDynamicResourceGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetDynamicResourceGroupRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetDynamicResourceGroupResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetDynamicResourceGroup API.

GetGrant(GetGrantRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a Grant

Declaration

public Task<GetGrantResponse> GetGrant(GetGrantRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetGrantRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetGrantResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetGrant API.

GetGroup(GetGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a group. <b>Important:</b> The Group SEARCH and GET operations on users and members will throw an exception if the response has more than 10,000 members. To avoid the exception, use the pagination filter to GET or SEARCH group members.

Declaration

public Task<GetGroupResponse> GetGroup(GetGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetGroupRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetGroupResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetGroup API.

GetIdentityPropagationTrust(GetIdentityPropagationTrustRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get an existing Identity Propagation Trust configuration.

Declaration

public Task<GetIdentityPropagationTrustResponse> GetIdentityPropagationTrust(GetIdentityPropagationTrustRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetIdentityPropagationTrustRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetIdentityPropagationTrustResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetIdentityPropagationTrust API.

GetIdentityProvider(GetIdentityProviderRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get an Identity Provider

Declaration

public Task<GetIdentityProviderResponse> GetIdentityProvider(GetIdentityProviderRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetIdentityProviderRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetIdentityProviderResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetIdentityProvider API.

GetIdentitySetting(GetIdentitySettingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get an Identity setting.

Declaration

public Task<GetIdentitySettingResponse> GetIdentitySetting(GetIdentitySettingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetIdentitySettingRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetIdentitySettingResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetIdentitySetting API.

GetKmsiSetting(GetKmsiSettingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get KmsiSettings

Declaration

public Task<GetKmsiSettingResponse> GetKmsiSetting(GetKmsiSettingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetKmsiSettingRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetKmsiSettingResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetKmsiSetting API.

GetMe(GetMeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a user's own information.

Declaration

public Task<GetMeResponse> GetMe(GetMeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetMeRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetMeResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetMe API.

GetMyApiKey(GetMyApiKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a user's own API key.

Declaration

public Task<GetMyApiKeyResponse> GetMyApiKey(GetMyApiKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetMyApiKeyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetMyApiKeyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetMyApiKey API.

GetMyAuthToken(GetMyAuthTokenRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a user's own Auth token.

Declaration

public Task<GetMyAuthTokenResponse> GetMyAuthToken(GetMyAuthTokenRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetMyAuthTokenRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetMyAuthTokenResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetMyAuthToken API.

GetMyCompletedApproval(GetMyCompletedApprovalRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get My MyCompletedApproval

Declaration

public Task<GetMyCompletedApprovalResponse> GetMyCompletedApproval(GetMyCompletedApprovalRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetMyCompletedApprovalRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetMyCompletedApprovalResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetMyCompletedApproval API.

GetMyCustomerSecretKey(GetMyCustomerSecretKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a user's own customer secret key.

Declaration

public Task<GetMyCustomerSecretKeyResponse> GetMyCustomerSecretKey(GetMyCustomerSecretKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetMyCustomerSecretKeyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetMyCustomerSecretKeyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetMyCustomerSecretKey API.

GetMyDevice(GetMyDeviceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a Device

Declaration

public Task<GetMyDeviceResponse> GetMyDevice(GetMyDeviceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetMyDeviceRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetMyDeviceResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetMyDevice API.

GetMyOAuth2ClientCredential(GetMyOAuth2ClientCredentialRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a user's own OAuth2 client credential.

Declaration

public Task<GetMyOAuth2ClientCredentialResponse> GetMyOAuth2ClientCredential(GetMyOAuth2ClientCredentialRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetMyOAuth2ClientCredentialRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetMyOAuth2ClientCredentialResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetMyOAuth2ClientCredential API.

GetMyPendingApproval(GetMyPendingApprovalRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get My MyPendingApproval

Declaration

public Task<GetMyPendingApprovalResponse> GetMyPendingApproval(GetMyPendingApprovalRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetMyPendingApprovalRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetMyPendingApprovalResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetMyPendingApproval API.

GetMyRequest(GetMyRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get My Requests

Declaration

public Task<GetMyRequestResponse> GetMyRequest(GetMyRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetMyRequestRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetMyRequestResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetMyRequest API.

GetMySmtpCredential(GetMySmtpCredentialRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a user's own SMTP credential.

Declaration

public Task<GetMySmtpCredentialResponse> GetMySmtpCredential(GetMySmtpCredentialRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetMySmtpCredentialRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetMySmtpCredentialResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetMySmtpCredential API.

GetMySupportAccount(GetMySupportAccountRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a user's own support account.

Declaration

public Task<GetMySupportAccountResponse> GetMySupportAccount(GetMySupportAccountRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetMySupportAccountRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetMySupportAccountResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetMySupportAccount API.

GetMyTrustedUserAgent(GetMyTrustedUserAgentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a Trusted User Agent

Declaration

public Task<GetMyTrustedUserAgentResponse> GetMyTrustedUserAgent(GetMyTrustedUserAgentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetMyTrustedUserAgentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetMyTrustedUserAgentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetMyTrustedUserAgent API.

GetMyUserDbCredential(GetMyUserDbCredentialRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a user's own database (DB) credential.

Declaration

public Task<GetMyUserDbCredentialResponse> GetMyUserDbCredential(GetMyUserDbCredentialRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetMyUserDbCredentialRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetMyUserDbCredentialResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetMyUserDbCredential API.

GetNetworkPerimeter(GetNetworkPerimeterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a NetworkPerimeter

Declaration

public Task<GetNetworkPerimeterResponse> GetNetworkPerimeter(GetNetworkPerimeterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetNetworkPerimeterRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetNetworkPerimeterResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetNetworkPerimeter API.

GetNotificationSetting(GetNotificationSettingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get Notification Settings

Declaration

public Task<GetNotificationSettingResponse> GetNotificationSetting(GetNotificationSettingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetNotificationSettingRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetNotificationSettingResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetNotificationSetting API.

GetOAuth2ClientCredential(GetOAuth2ClientCredentialRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a user's OAuth2 client credentials.

Declaration

public Task<GetOAuth2ClientCredentialResponse> GetOAuth2ClientCredential(GetOAuth2ClientCredentialRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetOAuth2ClientCredentialRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetOAuth2ClientCredentialResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetOAuth2ClientCredential API.

GetOAuthClientCertificate(GetOAuthClientCertificateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get OAuth Client Certificates

Declaration

public Task<GetOAuthClientCertificateResponse> GetOAuthClientCertificate(GetOAuthClientCertificateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetOAuthClientCertificateRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetOAuthClientCertificateResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetOAuthClientCertificate API.

GetOAuthPartnerCertificate(GetOAuthPartnerCertificateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get an OAuth Partner Certificate

Declaration

public Task<GetOAuthPartnerCertificateResponse> GetOAuthPartnerCertificate(GetOAuthPartnerCertificateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetOAuthPartnerCertificateRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetOAuthPartnerCertificateResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetOAuthPartnerCertificate API.

GetPasswordPolicy(GetPasswordPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a password policy.

Declaration

public Task<GetPasswordPolicyResponse> GetPasswordPolicy(GetPasswordPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetPasswordPolicyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetPasswordPolicyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetPasswordPolicy API.

GetPolicy(GetPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a Policy

Declaration

public Task<GetPolicyResponse> GetPolicy(GetPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetPolicyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetPolicyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetPolicy API.

GetRule(GetRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a Rule

Declaration

public Task<GetRuleResponse> GetRule(GetRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetRuleRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetRuleResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetRule API.

GetSchema(GetSchemaRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a Schema

Declaration

public Task<GetSchemaResponse> GetSchema(GetSchemaRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetSchemaRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetSchemaResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetSchema API.

GetSecurityQuestion(GetSecurityQuestionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a security question.

Declaration

public Task<GetSecurityQuestionResponse> GetSecurityQuestion(GetSecurityQuestionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetSecurityQuestionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetSecurityQuestionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetSecurityQuestion API.

GetSecurityQuestionSetting(GetSecurityQuestionSettingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a security question setting.

Declaration

public Task<GetSecurityQuestionSettingResponse> GetSecurityQuestionSetting(GetSecurityQuestionSettingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetSecurityQuestionSettingRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetSecurityQuestionSettingResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetSecurityQuestionSetting API.

GetSelfRegistrationProfile(GetSelfRegistrationProfileRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a self-registration profile.

Declaration

public Task<GetSelfRegistrationProfileResponse> GetSelfRegistrationProfile(GetSelfRegistrationProfileRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetSelfRegistrationProfileRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetSelfRegistrationProfileResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetSelfRegistrationProfile API.

GetSetting(GetSettingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get Settings

Declaration

public Task<GetSettingResponse> GetSetting(GetSettingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetSettingRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetSettingResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetSetting API.

GetSmtpCredential(GetSmtpCredentialRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a user's SMTP credentials.

Declaration

public Task<GetSmtpCredentialResponse> GetSmtpCredential(GetSmtpCredentialRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetSmtpCredentialRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetSmtpCredentialResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetSmtpCredential API.

GetSocialIdentityProvider(GetSocialIdentityProviderRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a Social Identity Provider

Declaration

public Task<GetSocialIdentityProviderResponse> GetSocialIdentityProvider(GetSocialIdentityProviderRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetSocialIdentityProviderRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetSocialIdentityProviderResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetSocialIdentityProvider API.

GetUser(GetUserRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a user.

Declaration

public Task<GetUserResponse> GetUser(GetUserRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetUserRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetUserResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetUser API.

GetUserAttributesSetting(GetUserAttributesSettingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get User Schema Attribute Settings

Declaration

public Task<GetUserAttributesSettingResponse> GetUserAttributesSetting(GetUserAttributesSettingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetUserAttributesSettingRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetUserAttributesSettingResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetUserAttributesSetting API.

GetUserDbCredential(GetUserDbCredentialRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a user's database (DB) credentials.

Declaration

public Task<GetUserDbCredentialResponse> GetUserDbCredential(GetUserDbCredentialRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetUserDbCredentialRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetUserDbCredentialResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetUserDbCredential API.

ListAccountMgmtInfos(ListAccountMgmtInfosRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search Account Mgmt Info

Declaration

public Task<ListAccountMgmtInfosResponse> ListAccountMgmtInfos(ListAccountMgmtInfosRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListAccountMgmtInfosRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListAccountMgmtInfosResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListAccountMgmtInfos API.

ListAccountRecoverySettings(ListAccountRecoverySettingsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for account recovery settings.

Declaration

public Task<ListAccountRecoverySettingsResponse> ListAccountRecoverySettings(ListAccountRecoverySettingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListAccountRecoverySettingsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListAccountRecoverySettingsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListAccountRecoverySettings API.

ListApiKeys(ListApiKeysRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search API keys.

Declaration

public Task<ListApiKeysResponse> ListApiKeys(ListApiKeysRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListApiKeysRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListApiKeysResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListApiKeys API.

ListAppRoles(ListAppRolesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search AppRoles

Declaration

public Task<ListAppRolesResponse> ListAppRoles(ListAppRolesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListAppRolesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListAppRolesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListAppRoles API.

ListApprovalWorkflowAssignments(ListApprovalWorkflowAssignmentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search Approval Workflow Assignments

Declaration

public Task<ListApprovalWorkflowAssignmentsResponse> ListApprovalWorkflowAssignments(ListApprovalWorkflowAssignmentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListApprovalWorkflowAssignmentsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListApprovalWorkflowAssignmentsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListApprovalWorkflowAssignments API.

ListApprovalWorkflowSteps(ListApprovalWorkflowStepsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search ApprovalWorkflowStep

Declaration

public Task<ListApprovalWorkflowStepsResponse> ListApprovalWorkflowSteps(ListApprovalWorkflowStepsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListApprovalWorkflowStepsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListApprovalWorkflowStepsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListApprovalWorkflowSteps API.

ListApprovalWorkflows(ListApprovalWorkflowsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search ApprovalWorkflow

Declaration

public Task<ListApprovalWorkflowsResponse> ListApprovalWorkflows(ListApprovalWorkflowsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListApprovalWorkflowsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListApprovalWorkflowsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListApprovalWorkflows API.

ListApps(ListAppsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search Apps

Declaration

public Task<ListAppsResponse> ListApps(ListAppsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListAppsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListAppsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListApps API.

ListAuthTokens(ListAuthTokensRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for Auth tokens.

Declaration

public Task<ListAuthTokensResponse> ListAuthTokens(ListAuthTokensRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListAuthTokensRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListAuthTokensResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListAuthTokens API.

ListAuthenticationFactorSettings(ListAuthenticationFactorSettingsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search Authentication Factor Settings

Declaration

public Task<ListAuthenticationFactorSettingsResponse> ListAuthenticationFactorSettings(ListAuthenticationFactorSettingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListAuthenticationFactorSettingsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListAuthenticationFactorSettingsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListAuthenticationFactorSettings API.

ListBrandingSettings(ListBrandingSettingsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search Branding Settings

Declaration

public Task<ListBrandingSettingsResponse> ListBrandingSettings(ListBrandingSettingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListBrandingSettingsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListBrandingSettingsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListBrandingSettings API.

ListCloudGateMappings(ListCloudGateMappingsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search Cloud Gate mappings

Declaration

public Task<ListCloudGateMappingsResponse> ListCloudGateMappings(ListCloudGateMappingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListCloudGateMappingsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListCloudGateMappingsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListCloudGateMappings API.

ListCloudGateServers(ListCloudGateServersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search Cloud Gate servers

Declaration

public Task<ListCloudGateServersResponse> ListCloudGateServers(ListCloudGateServersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListCloudGateServersRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListCloudGateServersResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListCloudGateServers API.

ListCloudGates(ListCloudGatesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search Cloud Gates

Declaration

public Task<ListCloudGatesResponse> ListCloudGates(ListCloudGatesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListCloudGatesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListCloudGatesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListCloudGates API.

ListConditions(ListConditionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search Conditions

Declaration

public Task<ListConditionsResponse> ListConditions(ListConditionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListConditionsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListConditionsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListConditions API.

ListCustomerSecretKeys(ListCustomerSecretKeysRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for a user's customer secret keys.

Declaration

public Task<ListCustomerSecretKeysResponse> ListCustomerSecretKeys(ListCustomerSecretKeysRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListCustomerSecretKeysRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListCustomerSecretKeysResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListCustomerSecretKeys API.

ListDynamicResourceGroups(ListDynamicResourceGroupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for Dynamic Resource Groups.

Declaration

public Task<ListDynamicResourceGroupsResponse> ListDynamicResourceGroups(ListDynamicResourceGroupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDynamicResourceGroupsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListDynamicResourceGroupsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListDynamicResourceGroups API.

ListGrants(ListGrantsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search Grants

Declaration

public Task<ListGrantsResponse> ListGrants(ListGrantsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListGrantsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListGrantsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListGrants API.

ListGroups(ListGroupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for groups. <b>Important:</b> The Group SEARCH and GET operations on users and members will throw an exception if the response has more than 10,000 members. To avoid the exception, use the pagination filter to GET or SEARCH group members.

Declaration

public Task<ListGroupsResponse> ListGroups(ListGroupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListGroupsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListGroupsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListGroups API.

ListIdentityPropagationTrusts(ListIdentityPropagationTrustsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

List the Identity Propagation Trust configurations.

Declaration

public Task<ListIdentityPropagationTrustsResponse> ListIdentityPropagationTrusts(ListIdentityPropagationTrustsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListIdentityPropagationTrustsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListIdentityPropagationTrustsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListIdentityPropagationTrusts API.

ListIdentityProviders(ListIdentityProvidersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search Identity Providers

Declaration

public Task<ListIdentityProvidersResponse> ListIdentityProviders(ListIdentityProvidersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListIdentityProvidersRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListIdentityProvidersResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListIdentityProviders API.

ListIdentitySettings(ListIdentitySettingsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for Identity settings.

Declaration

public Task<ListIdentitySettingsResponse> ListIdentitySettings(ListIdentitySettingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListIdentitySettingsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListIdentitySettingsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListIdentitySettings API.

ListKmsiSettings(ListKmsiSettingsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search KmsiSettings

Declaration

public Task<ListKmsiSettingsResponse> ListKmsiSettings(ListKmsiSettingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListKmsiSettingsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListKmsiSettingsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListKmsiSettings API.

ListMyApiKeys(ListMyApiKeysRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for a user's own API key.

Declaration

public Task<ListMyApiKeysResponse> ListMyApiKeys(ListMyApiKeysRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListMyApiKeysRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListMyApiKeysResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListMyApiKeys API.

ListMyApps(ListMyAppsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search My Apps

Declaration

public Task<ListMyAppsResponse> ListMyApps(ListMyAppsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListMyAppsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListMyAppsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListMyApps API.

ListMyAuthTokens(ListMyAuthTokensRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for a user's own Auth token.

Declaration

public Task<ListMyAuthTokensResponse> ListMyAuthTokens(ListMyAuthTokensRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListMyAuthTokensRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListMyAuthTokensResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListMyAuthTokens API.

ListMyCompletedApprovals(ListMyCompletedApprovalsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search My MyCompletedApproval

Declaration

public Task<ListMyCompletedApprovalsResponse> ListMyCompletedApprovals(ListMyCompletedApprovalsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListMyCompletedApprovalsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListMyCompletedApprovalsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListMyCompletedApprovals API.

ListMyCustomerSecretKeys(ListMyCustomerSecretKeysRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for a user's own customer secret key.

Declaration

public Task<ListMyCustomerSecretKeysResponse> ListMyCustomerSecretKeys(ListMyCustomerSecretKeysRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListMyCustomerSecretKeysRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListMyCustomerSecretKeysResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListMyCustomerSecretKeys API.

ListMyDevices(ListMyDevicesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search Devices

Declaration

public Task<ListMyDevicesResponse> ListMyDevices(ListMyDevicesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListMyDevicesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListMyDevicesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListMyDevices API.

ListMyGroups(ListMyGroupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for 'My Groups'.

Declaration

public Task<ListMyGroupsResponse> ListMyGroups(ListMyGroupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListMyGroupsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListMyGroupsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListMyGroups API.

ListMyOAuth2ClientCredentials(ListMyOAuth2ClientCredentialsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for a user's own OAuth2 client credential.

Declaration

public Task<ListMyOAuth2ClientCredentialsResponse> ListMyOAuth2ClientCredentials(ListMyOAuth2ClientCredentialsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListMyOAuth2ClientCredentialsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListMyOAuth2ClientCredentialsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListMyOAuth2ClientCredentials API.

ListMyPendingApprovals(ListMyPendingApprovalsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search My Approvals

Declaration

public Task<ListMyPendingApprovalsResponse> ListMyPendingApprovals(ListMyPendingApprovalsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListMyPendingApprovalsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListMyPendingApprovalsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListMyPendingApprovals API.

ListMyRequestableGroups(ListMyRequestableGroupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search My Requestable Groups

Declaration

public Task<ListMyRequestableGroupsResponse> ListMyRequestableGroups(ListMyRequestableGroupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListMyRequestableGroupsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListMyRequestableGroupsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListMyRequestableGroups API.

ListMyRequests(ListMyRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search My Requests

Declaration

public Task<ListMyRequestsResponse> ListMyRequests(ListMyRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListMyRequestsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListMyRequestsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListMyRequests API.

ListMySmtpCredentials(ListMySmtpCredentialsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for a user's own SMTP credential.

Declaration

public Task<ListMySmtpCredentialsResponse> ListMySmtpCredentials(ListMySmtpCredentialsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListMySmtpCredentialsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListMySmtpCredentialsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListMySmtpCredentials API.

ListMySupportAccounts(ListMySupportAccountsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for a user's own support account.

Declaration

public Task<ListMySupportAccountsResponse> ListMySupportAccounts(ListMySupportAccountsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListMySupportAccountsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListMySupportAccountsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListMySupportAccounts API.

ListMyTrustedUserAgents(ListMyTrustedUserAgentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search Trusted User Agents

Declaration

public Task<ListMyTrustedUserAgentsResponse> ListMyTrustedUserAgents(ListMyTrustedUserAgentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListMyTrustedUserAgentsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListMyTrustedUserAgentsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListMyTrustedUserAgents API.

ListMyUserDbCredentials(ListMyUserDbCredentialsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for a user's own database (DB) credential.

Declaration

public Task<ListMyUserDbCredentialsResponse> ListMyUserDbCredentials(ListMyUserDbCredentialsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListMyUserDbCredentialsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListMyUserDbCredentialsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListMyUserDbCredentials API.

ListNetworkPerimeters(ListNetworkPerimetersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search NetworkPerimeters

Declaration

public Task<ListNetworkPerimetersResponse> ListNetworkPerimeters(ListNetworkPerimetersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListNetworkPerimetersRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListNetworkPerimetersResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListNetworkPerimeters API.

ListNotificationSettings(ListNotificationSettingsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search Notification Settings

Declaration

public Task<ListNotificationSettingsResponse> ListNotificationSettings(ListNotificationSettingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListNotificationSettingsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListNotificationSettingsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListNotificationSettings API.

ListOAuth2ClientCredentials(ListOAuth2ClientCredentialsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for a user's OAuth2 client credentials.

Declaration

public Task<ListOAuth2ClientCredentialsResponse> ListOAuth2ClientCredentials(ListOAuth2ClientCredentialsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListOAuth2ClientCredentialsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListOAuth2ClientCredentialsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListOAuth2ClientCredentials API.

ListOAuthClientCertificates(ListOAuthClientCertificatesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search OAuth Client Certificates

Declaration

public Task<ListOAuthClientCertificatesResponse> ListOAuthClientCertificates(ListOAuthClientCertificatesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListOAuthClientCertificatesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListOAuthClientCertificatesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListOAuthClientCertificates API.

ListOAuthPartnerCertificates(ListOAuthPartnerCertificatesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search OAuth Partner Certificates

Declaration

public Task<ListOAuthPartnerCertificatesResponse> ListOAuthPartnerCertificates(ListOAuthPartnerCertificatesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListOAuthPartnerCertificatesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListOAuthPartnerCertificatesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListOAuthPartnerCertificates API.

ListPasswordPolicies(ListPasswordPoliciesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for password policies.

Declaration

public Task<ListPasswordPoliciesResponse> ListPasswordPolicies(ListPasswordPoliciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListPasswordPoliciesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListPasswordPoliciesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListPasswordPolicies API.

ListPolicies(ListPoliciesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search Policies

Declaration

public Task<ListPoliciesResponse> ListPolicies(ListPoliciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListPoliciesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListPoliciesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListPolicies API.

ListResourceTypeSchemaAttributes(ListResourceTypeSchemaAttributesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search Resource Type Schema Attributes

Declaration

public Task<ListResourceTypeSchemaAttributesResponse> ListResourceTypeSchemaAttributes(ListResourceTypeSchemaAttributesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListResourceTypeSchemaAttributesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListResourceTypeSchemaAttributesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListResourceTypeSchemaAttributes API.

ListRules(ListRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search Rules

Declaration

public Task<ListRulesResponse> ListRules(ListRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListRulesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListRulesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListRules API.

ListSchemas(ListSchemasRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search Schemas

Declaration

public Task<ListSchemasResponse> ListSchemas(ListSchemasRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSchemasRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListSchemasResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSchemas API.

ListSecurityQuestionSettings(ListSecurityQuestionSettingsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for security question settings.

Declaration

public Task<ListSecurityQuestionSettingsResponse> ListSecurityQuestionSettings(ListSecurityQuestionSettingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSecurityQuestionSettingsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListSecurityQuestionSettingsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSecurityQuestionSettings API.

ListSecurityQuestions(ListSecurityQuestionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for security questions.

Declaration

public Task<ListSecurityQuestionsResponse> ListSecurityQuestions(ListSecurityQuestionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSecurityQuestionsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListSecurityQuestionsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSecurityQuestions API.

ListSelfRegistrationProfiles(ListSelfRegistrationProfilesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for self-registration profiles.

Declaration

public Task<ListSelfRegistrationProfilesResponse> ListSelfRegistrationProfiles(ListSelfRegistrationProfilesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSelfRegistrationProfilesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListSelfRegistrationProfilesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSelfRegistrationProfiles API.

ListSettings(ListSettingsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search Settings

Declaration

public Task<ListSettingsResponse> ListSettings(ListSettingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSettingsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListSettingsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSettings API.

ListSmtpCredentials(ListSmtpCredentialsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for SMTP credentials.

Declaration

public Task<ListSmtpCredentialsResponse> ListSmtpCredentials(ListSmtpCredentialsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSmtpCredentialsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListSmtpCredentialsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSmtpCredentials API.

ListSocialIdentityProviders(ListSocialIdentityProvidersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search Social Identity Providers

Declaration

public Task<ListSocialIdentityProvidersResponse> ListSocialIdentityProviders(ListSocialIdentityProvidersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSocialIdentityProvidersRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListSocialIdentityProvidersResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSocialIdentityProviders API.

ListUserAttributesSettings(ListUserAttributesSettingsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search User Schema Attribute Settings

Declaration

public Task<ListUserAttributesSettingsResponse> ListUserAttributesSettings(ListUserAttributesSettingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListUserAttributesSettingsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListUserAttributesSettingsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListUserAttributesSettings API.

ListUserDbCredentials(ListUserDbCredentialsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for a user's database (DB) credentials.

Declaration

public Task<ListUserDbCredentialsResponse> ListUserDbCredentials(ListUserDbCredentialsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListUserDbCredentialsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListUserDbCredentialsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListUserDbCredentials API.

ListUsers(ListUsersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for users.

Declaration

public Task<ListUsersResponse> ListUsers(ListUsersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListUsersRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListUsersResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListUsers API.

PatchAccountRecoverySetting(PatchAccountRecoverySettingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update an account recovery setting.

Declaration

public Task<PatchAccountRecoverySettingResponse> PatchAccountRecoverySetting(PatchAccountRecoverySettingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchAccountRecoverySettingRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchAccountRecoverySettingResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchAccountRecoverySetting API.

PatchApiKey(PatchApiKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a user's API key.

Declaration

public Task<PatchApiKeyResponse> PatchApiKey(PatchApiKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchApiKeyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchApiKeyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchApiKey API.

PatchApp(PatchAppRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update an App

Declaration

public Task<PatchAppResponse> PatchApp(PatchAppRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchAppRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchAppResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchApp API.

PatchAppRole(PatchAppRoleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update an AppRole

Declaration

public Task<PatchAppRoleResponse> PatchAppRole(PatchAppRoleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchAppRoleRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchAppRoleResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchAppRole API.

PatchApprovalWorkflow(PatchApprovalWorkflowRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update ApprovalWorkflow

Declaration

public Task<PatchApprovalWorkflowResponse> PatchApprovalWorkflow(PatchApprovalWorkflowRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchApprovalWorkflowRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchApprovalWorkflowResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchApprovalWorkflow API.

PatchApprovalWorkflowStep(PatchApprovalWorkflowStepRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update ApprovalWorkflowStep

Declaration

public Task<PatchApprovalWorkflowStepResponse> PatchApprovalWorkflowStep(PatchApprovalWorkflowStepRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchApprovalWorkflowStepRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchApprovalWorkflowStepResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchApprovalWorkflowStep API.

PatchAuthToken(PatchAuthTokenRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a user's Auth token.

Declaration

public Task<PatchAuthTokenResponse> PatchAuthToken(PatchAuthTokenRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchAuthTokenRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchAuthTokenResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchAuthToken API.

PatchCloudGate(PatchCloudGateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a Cloud Gate

Declaration

public Task<PatchCloudGateResponse> PatchCloudGate(PatchCloudGateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchCloudGateRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchCloudGateResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchCloudGate API.

PatchCloudGateMapping(PatchCloudGateMappingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a Cloud Gate mapping

Declaration

public Task<PatchCloudGateMappingResponse> PatchCloudGateMapping(PatchCloudGateMappingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchCloudGateMappingRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchCloudGateMappingResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchCloudGateMapping API.

PatchCloudGateServer(PatchCloudGateServerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a Cloud Gate server

Declaration

public Task<PatchCloudGateServerResponse> PatchCloudGateServer(PatchCloudGateServerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchCloudGateServerRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchCloudGateServerResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchCloudGateServer API.

PatchCondition(PatchConditionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a Condition

Declaration

public Task<PatchConditionResponse> PatchCondition(PatchConditionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchConditionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchConditionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchCondition API.

PatchCustomerSecretKey(PatchCustomerSecretKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a user's customer secret key.

Declaration

public Task<PatchCustomerSecretKeyResponse> PatchCustomerSecretKey(PatchCustomerSecretKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchCustomerSecretKeyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchCustomerSecretKeyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchCustomerSecretKey API.

PatchDynamicResourceGroup(PatchDynamicResourceGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a Dynamic Resource Group.

Declaration

public Task<PatchDynamicResourceGroupResponse> PatchDynamicResourceGroup(PatchDynamicResourceGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchDynamicResourceGroupRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchDynamicResourceGroupResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchDynamicResourceGroup API.

PatchGrant(PatchGrantRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a Grant

Declaration

public Task<PatchGrantResponse> PatchGrant(PatchGrantRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchGrantRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchGrantResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchGrant API.

PatchGroup(PatchGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a group.

Declaration

public Task<PatchGroupResponse> PatchGroup(PatchGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchGroupRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchGroupResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchGroup API.

PatchIdentityPropagationTrust(PatchIdentityPropagationTrustRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update an existing Identity Propagation Trust configuration.

Declaration

public Task<PatchIdentityPropagationTrustResponse> PatchIdentityPropagationTrust(PatchIdentityPropagationTrustRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchIdentityPropagationTrustRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchIdentityPropagationTrustResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchIdentityPropagationTrust API.

PatchIdentityProvider(PatchIdentityProviderRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update an Identity Provider

Declaration

public Task<PatchIdentityProviderResponse> PatchIdentityProvider(PatchIdentityProviderRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchIdentityProviderRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchIdentityProviderResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchIdentityProvider API.

PatchIdentitySetting(PatchIdentitySettingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update an Identity setting.

Declaration

public Task<PatchIdentitySettingResponse> PatchIdentitySetting(PatchIdentitySettingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchIdentitySettingRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchIdentitySettingResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchIdentitySetting API.

PatchKmsiSetting(PatchKmsiSettingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a Setting

Declaration

public Task<PatchKmsiSettingResponse> PatchKmsiSetting(PatchKmsiSettingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchKmsiSettingRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchKmsiSettingResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchKmsiSetting API.

PatchMe(PatchMeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a user's own information.

Declaration

public Task<PatchMeResponse> PatchMe(PatchMeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchMeRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchMeResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchMe API.

PatchMyApiKey(PatchMyApiKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a user's own API key.

Declaration

public Task<PatchMyApiKeyResponse> PatchMyApiKey(PatchMyApiKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchMyApiKeyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchMyApiKeyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchMyApiKey API.

PatchMyAuthToken(PatchMyAuthTokenRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a user's own Auth token.

Declaration

public Task<PatchMyAuthTokenResponse> PatchMyAuthToken(PatchMyAuthTokenRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchMyAuthTokenRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchMyAuthTokenResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchMyAuthToken API.

PatchMyCustomerSecretKey(PatchMyCustomerSecretKeyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a user's own customer secret key.

Declaration

public Task<PatchMyCustomerSecretKeyResponse> PatchMyCustomerSecretKey(PatchMyCustomerSecretKeyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchMyCustomerSecretKeyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchMyCustomerSecretKeyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchMyCustomerSecretKey API.

PatchMyDevice(PatchMyDeviceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a Device

Declaration

public Task<PatchMyDeviceResponse> PatchMyDevice(PatchMyDeviceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchMyDeviceRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchMyDeviceResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchMyDevice API.

PatchMyOAuth2ClientCredential(PatchMyOAuth2ClientCredentialRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a user's own OAuth2 client credential.

Declaration

public Task<PatchMyOAuth2ClientCredentialResponse> PatchMyOAuth2ClientCredential(PatchMyOAuth2ClientCredentialRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchMyOAuth2ClientCredentialRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchMyOAuth2ClientCredentialResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchMyOAuth2ClientCredential API.

PatchMyPendingApproval(PatchMyPendingApprovalRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update MyPendingApproval

Declaration

public Task<PatchMyPendingApprovalResponse> PatchMyPendingApproval(PatchMyPendingApprovalRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchMyPendingApprovalRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchMyPendingApprovalResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchMyPendingApproval API.

PatchMyRequest(PatchMyRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update My Requests

Declaration

public Task<PatchMyRequestResponse> PatchMyRequest(PatchMyRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchMyRequestRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchMyRequestResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchMyRequest API.

PatchMySmtpCredential(PatchMySmtpCredentialRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a user's own SMTP credential.

Declaration

public Task<PatchMySmtpCredentialResponse> PatchMySmtpCredential(PatchMySmtpCredentialRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchMySmtpCredentialRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchMySmtpCredentialResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchMySmtpCredential API.

PatchNetworkPerimeter(PatchNetworkPerimeterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a NetworkPerimeter

Declaration

public Task<PatchNetworkPerimeterResponse> PatchNetworkPerimeter(PatchNetworkPerimeterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchNetworkPerimeterRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchNetworkPerimeterResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchNetworkPerimeter API.

PatchOAuth2ClientCredential(PatchOAuth2ClientCredentialRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a user's OAuth2 client credentials.

Declaration

public Task<PatchOAuth2ClientCredentialResponse> PatchOAuth2ClientCredential(PatchOAuth2ClientCredentialRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchOAuth2ClientCredentialRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchOAuth2ClientCredentialResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchOAuth2ClientCredential API.

PatchPasswordPolicy(PatchPasswordPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a password policy.

Declaration

public Task<PatchPasswordPolicyResponse> PatchPasswordPolicy(PatchPasswordPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchPasswordPolicyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchPasswordPolicyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchPasswordPolicy API.

PatchPolicy(PatchPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a Policy

Declaration

public Task<PatchPolicyResponse> PatchPolicy(PatchPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchPolicyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchPolicyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchPolicy API.

PatchRule(PatchRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a Rule

Declaration

public Task<PatchRuleResponse> PatchRule(PatchRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchRuleRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchRuleResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchRule API.

PatchSchema(PatchSchemaRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a Schema Def

Declaration

public Task<PatchSchemaResponse> PatchSchema(PatchSchemaRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchSchemaRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchSchemaResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchSchema API.

PatchSecurityQuestion(PatchSecurityQuestionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a security question.

Declaration

public Task<PatchSecurityQuestionResponse> PatchSecurityQuestion(PatchSecurityQuestionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchSecurityQuestionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchSecurityQuestionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchSecurityQuestion API.

PatchSecurityQuestionSetting(PatchSecurityQuestionSettingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a security question setting.

Declaration

public Task<PatchSecurityQuestionSettingResponse> PatchSecurityQuestionSetting(PatchSecurityQuestionSettingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchSecurityQuestionSettingRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchSecurityQuestionSettingResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchSecurityQuestionSetting API.

PatchSelfRegistrationProfile(PatchSelfRegistrationProfileRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a self-registration profile.

Declaration

public Task<PatchSelfRegistrationProfileResponse> PatchSelfRegistrationProfile(PatchSelfRegistrationProfileRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchSelfRegistrationProfileRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchSelfRegistrationProfileResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchSelfRegistrationProfile API.

PatchSetting(PatchSettingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a Setting

Declaration

public Task<PatchSettingResponse> PatchSetting(PatchSettingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchSettingRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchSettingResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchSetting API.

PatchSmtpCredential(PatchSmtpCredentialRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a user's SMTP credentials.

Declaration

public Task<PatchSmtpCredentialResponse> PatchSmtpCredential(PatchSmtpCredentialRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchSmtpCredentialRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchSmtpCredentialResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchSmtpCredential API.

PatchSocialIdentityProvider(PatchSocialIdentityProviderRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a Social Identity Provider

Declaration

public Task<PatchSocialIdentityProviderResponse> PatchSocialIdentityProvider(PatchSocialIdentityProviderRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchSocialIdentityProviderRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchSocialIdentityProviderResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchSocialIdentityProvider API.

PatchUser(PatchUserRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a user.

Declaration

public Task<PatchUserResponse> PatchUser(PatchUserRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchUserRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchUserResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchUser API.

PatchUserAttributesSetting(PatchUserAttributesSettingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update User Schema Attribute Settings

Declaration

public Task<PatchUserAttributesSettingResponse> PatchUserAttributesSetting(PatchUserAttributesSettingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PatchUserAttributesSettingRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PatchUserAttributesSettingResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PatchUserAttributesSetting API.

PutAccountRecoverySetting(PutAccountRecoverySettingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Replace an account recovery setting.

Declaration

public Task<PutAccountRecoverySettingResponse> PutAccountRecoverySetting(PutAccountRecoverySettingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PutAccountRecoverySettingRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PutAccountRecoverySettingResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PutAccountRecoverySetting API.

PutApp(PutAppRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Replace an App

Declaration

public Task<PutAppResponse> PutApp(PutAppRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PutAppRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PutAppResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PutApp API.

PutAppStatusChanger(PutAppStatusChangerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Activate/Deactivate an App

Declaration

public Task<PutAppStatusChangerResponse> PutAppStatusChanger(PutAppStatusChangerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PutAppStatusChangerRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PutAppStatusChangerResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PutAppStatusChanger API.

PutApprovalWorkflow(PutApprovalWorkflowRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Replace ApprovalWorkflow

Declaration

public Task<PutApprovalWorkflowResponse> PutApprovalWorkflow(PutApprovalWorkflowRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PutApprovalWorkflowRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PutApprovalWorkflowResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PutApprovalWorkflow API.

PutAuthenticationFactorSetting(PutAuthenticationFactorSettingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Replace Authentication Factor Settings

Declaration

public Task<PutAuthenticationFactorSettingResponse> PutAuthenticationFactorSetting(PutAuthenticationFactorSettingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PutAuthenticationFactorSettingRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PutAuthenticationFactorSettingResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PutAuthenticationFactorSetting API.

PutCloudGate(PutCloudGateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Replace a Cloud Gate

Declaration

public Task<PutCloudGateResponse> PutCloudGate(PutCloudGateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PutCloudGateRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PutCloudGateResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PutCloudGate API.

PutCloudGateMapping(PutCloudGateMappingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Replace a Cloud Gate mapping

Declaration

public Task<PutCloudGateMappingResponse> PutCloudGateMapping(PutCloudGateMappingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PutCloudGateMappingRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PutCloudGateMappingResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PutCloudGateMapping API.

PutCloudGateServer(PutCloudGateServerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Replace a Cloud Gate server

Declaration

public Task<PutCloudGateServerResponse> PutCloudGateServer(PutCloudGateServerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PutCloudGateServerRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PutCloudGateServerResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PutCloudGateServer API.

PutCondition(PutConditionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Replace a Condition

Declaration

public Task<PutConditionResponse> PutCondition(PutConditionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PutConditionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PutConditionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PutCondition API.

PutDynamicResourceGroup(PutDynamicResourceGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Replace a Dynamic Resource Group.

Declaration

public Task<PutDynamicResourceGroupResponse> PutDynamicResourceGroup(PutDynamicResourceGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PutDynamicResourceGroupRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PutDynamicResourceGroupResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PutDynamicResourceGroup API.

PutGroup(PutGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Replace a group.

Declaration

public Task<PutGroupResponse> PutGroup(PutGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PutGroupRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PutGroupResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PutGroup API.

PutIdentityPropagationTrust(PutIdentityPropagationTrustRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Replace an existing Identity Propagation Trust configuration.

Declaration

public Task<PutIdentityPropagationTrustResponse> PutIdentityPropagationTrust(PutIdentityPropagationTrustRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PutIdentityPropagationTrustRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PutIdentityPropagationTrustResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PutIdentityPropagationTrust API.

PutIdentityProvider(PutIdentityProviderRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Replace an Identity Provider

Declaration

public Task<PutIdentityProviderResponse> PutIdentityProvider(PutIdentityProviderRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PutIdentityProviderRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PutIdentityProviderResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PutIdentityProvider API.

PutIdentitySetting(PutIdentitySettingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Replace an Identity setting.

Declaration

public Task<PutIdentitySettingResponse> PutIdentitySetting(PutIdentitySettingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PutIdentitySettingRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PutIdentitySettingResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PutIdentitySetting API.

PutKmsiSetting(PutKmsiSettingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Replace KmsiSettings

Declaration

public Task<PutKmsiSettingResponse> PutKmsiSetting(PutKmsiSettingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PutKmsiSettingRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PutKmsiSettingResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PutKmsiSetting API.

PutMe(PutMeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Replace a user's own information.

Declaration

public Task<PutMeResponse> PutMe(PutMeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PutMeRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PutMeResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PutMe API.

PutMePasswordChanger(PutMePasswordChangerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a user's own password.

Declaration

public Task<PutMePasswordChangerResponse> PutMePasswordChanger(PutMePasswordChangerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PutMePasswordChangerRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PutMePasswordChangerResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PutMePasswordChanger API.

PutNetworkPerimeter(PutNetworkPerimeterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Replace a NetworkPerimeter

Declaration

public Task<PutNetworkPerimeterResponse> PutNetworkPerimeter(PutNetworkPerimeterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PutNetworkPerimeterRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PutNetworkPerimeterResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PutNetworkPerimeter API.

PutNotificationSetting(PutNotificationSettingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Replace Notification Settings

Declaration

public Task<PutNotificationSettingResponse> PutNotificationSetting(PutNotificationSettingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PutNotificationSettingRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PutNotificationSettingResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PutNotificationSetting API.

PutPasswordPolicy(PutPasswordPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Replace a password policy.

Declaration

public Task<PutPasswordPolicyResponse> PutPasswordPolicy(PutPasswordPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PutPasswordPolicyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PutPasswordPolicyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PutPasswordPolicy API.

PutPolicy(PutPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Replace a Policy

Declaration

public Task<PutPolicyResponse> PutPolicy(PutPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PutPolicyRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PutPolicyResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PutPolicy API.

PutRule(PutRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Replace a Rule

Declaration

public Task<PutRuleResponse> PutRule(PutRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PutRuleRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PutRuleResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PutRule API.

PutSchema(PutSchemaRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Replace a Schema Def

Declaration

public Task<PutSchemaResponse> PutSchema(PutSchemaRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PutSchemaRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PutSchemaResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PutSchema API.

PutSecurityQuestionSetting(PutSecurityQuestionSettingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Replace a security question setting.

Declaration

public Task<PutSecurityQuestionSettingResponse> PutSecurityQuestionSetting(PutSecurityQuestionSettingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PutSecurityQuestionSettingRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PutSecurityQuestionSettingResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PutSecurityQuestionSetting API.

PutSelfRegistrationProfile(PutSelfRegistrationProfileRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Replace a self-registration profile.

Declaration

public Task<PutSelfRegistrationProfileResponse> PutSelfRegistrationProfile(PutSelfRegistrationProfileRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PutSelfRegistrationProfileRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PutSelfRegistrationProfileResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PutSelfRegistrationProfile API.

PutSetting(PutSettingRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Replace Settings

Declaration

public Task<PutSettingResponse> PutSetting(PutSettingRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PutSettingRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PutSettingResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PutSetting API.

PutSocialIdentityProvider(PutSocialIdentityProviderRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Replace a Social Identity Provider

Declaration

public Task<PutSocialIdentityProviderResponse> PutSocialIdentityProvider(PutSocialIdentityProviderRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PutSocialIdentityProviderRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PutSocialIdentityProviderResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PutSocialIdentityProvider API.

PutUser(PutUserRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Replace a user.

Declaration

public Task<PutUserResponse> PutUser(PutUserRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PutUserRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PutUserResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PutUser API.

PutUserCapabilitiesChanger(PutUserCapabilitiesChangerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Change a user's capabilities.

Declaration

public Task<PutUserCapabilitiesChangerResponse> PutUserCapabilitiesChanger(PutUserCapabilitiesChangerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PutUserCapabilitiesChangerRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PutUserCapabilitiesChangerResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PutUserCapabilitiesChanger API.

PutUserPasswordChanger(PutUserPasswordChangerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Change a user's password to a known value.

Declaration

public Task<PutUserPasswordChangerResponse> PutUserPasswordChanger(PutUserPasswordChangerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PutUserPasswordChangerRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PutUserPasswordChangerResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PutUserPasswordChanger API.

PutUserPasswordResetter(PutUserPasswordResetterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Reset a user's password to a randomly-generated value.

Declaration

public Task<PutUserPasswordResetterResponse> PutUserPasswordResetter(PutUserPasswordResetterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PutUserPasswordResetterRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PutUserPasswordResetterResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PutUserPasswordResetter API.

PutUserStatusChanger(PutUserStatusChangerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Change a user's status.

Declaration

public Task<PutUserStatusChangerResponse> PutUserStatusChanger(PutUserStatusChangerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PutUserStatusChangerRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<PutUserStatusChangerResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use PutUserStatusChanger API.

SearchAccountMgmtInfos(SearchAccountMgmtInfosRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search Account Mgmt Info Using POST

Declaration

public Task<SearchAccountMgmtInfosResponse> SearchAccountMgmtInfos(SearchAccountMgmtInfosRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchAccountMgmtInfosRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchAccountMgmtInfosResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchAccountMgmtInfos API.

SearchApiKeys(SearchApiKeysRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for API keys using POST.

Declaration

public Task<SearchApiKeysResponse> SearchApiKeys(SearchApiKeysRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchApiKeysRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchApiKeysResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchApiKeys API.

SearchAppRoles(SearchAppRolesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search AppRoles Using POST

Declaration

public Task<SearchAppRolesResponse> SearchAppRoles(SearchAppRolesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchAppRolesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchAppRolesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchAppRoles API.

SearchApps(SearchAppsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search Apps Using POST

Declaration

public Task<SearchAppsResponse> SearchApps(SearchAppsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchAppsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchAppsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchApps API.

SearchAuthTokens(SearchAuthTokensRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for Auth tokens using POST.

Declaration

public Task<SearchAuthTokensResponse> SearchAuthTokens(SearchAuthTokensRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchAuthTokensRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchAuthTokensResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchAuthTokens API.

SearchAuthenticationFactorSettings(SearchAuthenticationFactorSettingsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search Authentication Factor Settings Using POST

Declaration

public Task<SearchAuthenticationFactorSettingsResponse> SearchAuthenticationFactorSettings(SearchAuthenticationFactorSettingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchAuthenticationFactorSettingsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchAuthenticationFactorSettingsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchAuthenticationFactorSettings API.

SearchCloudGateMappings(SearchCloudGateMappingsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search Cloud Gate mappings Using POST

Declaration

public Task<SearchCloudGateMappingsResponse> SearchCloudGateMappings(SearchCloudGateMappingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchCloudGateMappingsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchCloudGateMappingsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchCloudGateMappings API.

SearchCloudGateServers(SearchCloudGateServersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search Cloud Gate servers Using POST

Declaration

public Task<SearchCloudGateServersResponse> SearchCloudGateServers(SearchCloudGateServersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchCloudGateServersRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchCloudGateServersResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchCloudGateServers API.

SearchCloudGates(SearchCloudGatesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search Cloud Gates Using POST

Declaration

public Task<SearchCloudGatesResponse> SearchCloudGates(SearchCloudGatesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchCloudGatesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchCloudGatesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchCloudGates API.

SearchConditions(SearchConditionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search Conditions Using POST

Declaration

public Task<SearchConditionsResponse> SearchConditions(SearchConditionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchConditionsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchConditionsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchConditions API.

SearchCustomerSecretKeys(SearchCustomerSecretKeysRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for customer secret keys using POST.

Declaration

public Task<SearchCustomerSecretKeysResponse> SearchCustomerSecretKeys(SearchCustomerSecretKeysRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchCustomerSecretKeysRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchCustomerSecretKeysResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchCustomerSecretKeys API.

SearchDynamicResourceGroups(SearchDynamicResourceGroupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for Dynamic Resource Groups using POST.

Declaration

public Task<SearchDynamicResourceGroupsResponse> SearchDynamicResourceGroups(SearchDynamicResourceGroupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchDynamicResourceGroupsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchDynamicResourceGroupsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchDynamicResourceGroups API.

SearchGrants(SearchGrantsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search Grants Using POST

Declaration

public Task<SearchGrantsResponse> SearchGrants(SearchGrantsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchGrantsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchGrantsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchGrants API.

SearchGroups(SearchGroupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for groups using POST.

Declaration

public Task<SearchGroupsResponse> SearchGroups(SearchGroupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchGroupsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchGroupsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchGroups API.

SearchIdentityProviders(SearchIdentityProvidersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search Identity Providers Using POST

Declaration

public Task<SearchIdentityProvidersResponse> SearchIdentityProviders(SearchIdentityProvidersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchIdentityProvidersRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchIdentityProvidersResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchIdentityProviders API.

SearchIdentitySettings(SearchIdentitySettingsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for Identity settings using POST.

Declaration

public Task<SearchIdentitySettingsResponse> SearchIdentitySettings(SearchIdentitySettingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchIdentitySettingsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchIdentitySettingsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchIdentitySettings API.

SearchKmsiSettings(SearchKmsiSettingsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search KmsiSettings Using POST

Declaration

public Task<SearchKmsiSettingsResponse> SearchKmsiSettings(SearchKmsiSettingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchKmsiSettingsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchKmsiSettingsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchKmsiSettings API.

SearchMyApps(SearchMyAppsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search My Apps Using POST

Declaration

public Task<SearchMyAppsResponse> SearchMyApps(SearchMyAppsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchMyAppsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchMyAppsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchMyApps API.

SearchMyGroups(SearchMyGroupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for 'My Groups' using POST.

Declaration

public Task<SearchMyGroupsResponse> SearchMyGroups(SearchMyGroupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchMyGroupsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchMyGroupsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchMyGroups API.

SearchMyRequestableGroups(SearchMyRequestableGroupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search My Requestable Groups Using POST

Declaration

public Task<SearchMyRequestableGroupsResponse> SearchMyRequestableGroups(SearchMyRequestableGroupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchMyRequestableGroupsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchMyRequestableGroupsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchMyRequestableGroups API.

SearchMyRequests(SearchMyRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search My Requests Using POST

Declaration

public Task<SearchMyRequestsResponse> SearchMyRequests(SearchMyRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchMyRequestsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchMyRequestsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchMyRequests API.

SearchNetworkPerimeters(SearchNetworkPerimetersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search NetworkPerimeters Using POST

Declaration

public Task<SearchNetworkPerimetersResponse> SearchNetworkPerimeters(SearchNetworkPerimetersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchNetworkPerimetersRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchNetworkPerimetersResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchNetworkPerimeters API.

SearchNotificationSettings(SearchNotificationSettingsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search Notification Settings Using POST

Declaration

public Task<SearchNotificationSettingsResponse> SearchNotificationSettings(SearchNotificationSettingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchNotificationSettingsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchNotificationSettingsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchNotificationSettings API.

SearchOAuth2ClientCredentials(SearchOAuth2ClientCredentialsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for OAuth2 client credentials using POST.

Declaration

public Task<SearchOAuth2ClientCredentialsResponse> SearchOAuth2ClientCredentials(SearchOAuth2ClientCredentialsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchOAuth2ClientCredentialsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchOAuth2ClientCredentialsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchOAuth2ClientCredentials API.

SearchOAuthClientCertificates(SearchOAuthClientCertificatesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search OAuth Client Certificates Using POST

Declaration

public Task<SearchOAuthClientCertificatesResponse> SearchOAuthClientCertificates(SearchOAuthClientCertificatesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchOAuthClientCertificatesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchOAuthClientCertificatesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchOAuthClientCertificates API.

SearchOAuthPartnerCertificates(SearchOAuthPartnerCertificatesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search OAuth Partner Certificates Using POST

Declaration

public Task<SearchOAuthPartnerCertificatesResponse> SearchOAuthPartnerCertificates(SearchOAuthPartnerCertificatesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchOAuthPartnerCertificatesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchOAuthPartnerCertificatesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchOAuthPartnerCertificates API.

SearchPasswordPolicies(SearchPasswordPoliciesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for password policies using POST.

Declaration

public Task<SearchPasswordPoliciesResponse> SearchPasswordPolicies(SearchPasswordPoliciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchPasswordPoliciesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchPasswordPoliciesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchPasswordPolicies API.

SearchPolicies(SearchPoliciesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search Policies Using POST

Declaration

public Task<SearchPoliciesResponse> SearchPolicies(SearchPoliciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchPoliciesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchPoliciesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchPolicies API.

SearchResourceTypeSchemaAttributes(SearchResourceTypeSchemaAttributesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search Resource Type Schema Attributes Using POST

Declaration

public Task<SearchResourceTypeSchemaAttributesResponse> SearchResourceTypeSchemaAttributes(SearchResourceTypeSchemaAttributesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchResourceTypeSchemaAttributesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchResourceTypeSchemaAttributesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchResourceTypeSchemaAttributes API.

SearchRules(SearchRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search Rules Using POST

Declaration

public Task<SearchRulesResponse> SearchRules(SearchRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchRulesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchRulesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchRules API.

SearchSchemas(SearchSchemasRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search Schemas Using POST

Declaration

public Task<SearchSchemasResponse> SearchSchemas(SearchSchemasRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchSchemasRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchSchemasResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchSchemas API.

SearchSecurityQuestionSettings(SearchSecurityQuestionSettingsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for security question settings using POST.

Declaration

public Task<SearchSecurityQuestionSettingsResponse> SearchSecurityQuestionSettings(SearchSecurityQuestionSettingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchSecurityQuestionSettingsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchSecurityQuestionSettingsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchSecurityQuestionSettings API.

SearchSecurityQuestions(SearchSecurityQuestionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for security questions using POST.

Declaration

public Task<SearchSecurityQuestionsResponse> SearchSecurityQuestions(SearchSecurityQuestionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchSecurityQuestionsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchSecurityQuestionsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchSecurityQuestions API.

SearchSelfRegistrationProfiles(SearchSelfRegistrationProfilesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for self-registration profile using POST.

Declaration

public Task<SearchSelfRegistrationProfilesResponse> SearchSelfRegistrationProfiles(SearchSelfRegistrationProfilesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchSelfRegistrationProfilesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchSelfRegistrationProfilesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchSelfRegistrationProfiles API.

SearchSettings(SearchSettingsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search Settings Using POST

Declaration

public Task<SearchSettingsResponse> SearchSettings(SearchSettingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchSettingsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchSettingsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchSettings API.

SearchSmtpCredentials(SearchSmtpCredentialsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for SMTP credentials using POST.

Declaration

public Task<SearchSmtpCredentialsResponse> SearchSmtpCredentials(SearchSmtpCredentialsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchSmtpCredentialsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchSmtpCredentialsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchSmtpCredentials API.

SearchSocialIdentityProviders(SearchSocialIdentityProvidersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search Social Identity Providers Using POST

Declaration

public Task<SearchSocialIdentityProvidersResponse> SearchSocialIdentityProviders(SearchSocialIdentityProvidersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchSocialIdentityProvidersRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchSocialIdentityProvidersResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchSocialIdentityProviders API.

SearchUserAttributesSettings(SearchUserAttributesSettingsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search User Schema Attribute Settings Using POST

Declaration

public Task<SearchUserAttributesSettingsResponse> SearchUserAttributesSettings(SearchUserAttributesSettingsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchUserAttributesSettingsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchUserAttributesSettingsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchUserAttributesSettings API.

SearchUserDbCredentials(SearchUserDbCredentialsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for a user's database (DB) credentials using POST.

Declaration

public Task<SearchUserDbCredentialsResponse> SearchUserDbCredentials(SearchUserDbCredentialsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchUserDbCredentialsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchUserDbCredentialsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchUserDbCredentials API.

SearchUsers(SearchUsersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Search for users using POST.

Declaration

public Task<SearchUsersResponse> SearchUsers(SearchUsersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SearchUsersRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SearchUsersResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchUsers API.

Implements

IDisposable