Class IdentityDomainsClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

IdentityDomainsClient

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new IdentityDomainsClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): IdentityDomainsClient

- Defined in lib/identitydomains/lib/client.ts:47
Parameters
- params: common.AuthParams
- Optional clientConfiguration: common.ClientConfiguration
Returns IdentityDomainsClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

targetService

targetService: string = "IdentityDomains"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://idcs-guid.identity.oraclecloud.com"

Accessors

endpoint

get endpoint(): string
set endpoint(endpoint: string): void

- Defined in lib/identitydomains/lib/client.ts:94
Get the endpoint that is being used to call (ex, https://www.example.com).

Returns string
- Defined in lib/identitydomains/lib/client.ts:102
Sets the endpoint to call (ex, https://www.example.com).

Parameters
- endpoint: string
  
  The endpoint of the service.
Returns void

logger

get logger(): Logger

- Defined in lib/identitydomains/lib/client.ts:108
Returns Logger

useRealmSpecificEndpointTemplate

set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void

- Defined in lib/identitydomains/lib/client.ts:117
Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"

Parameters
- realmSpecificEndpointTemplateEnabled: boolean
  
  flag to enable the use of realm specific endpoint template
Returns void

Methods

close

close(): void

- Defined in lib/identitydomains/lib/client.ts:137
Close the client once it is no longer needed

Returns void

createApiKey

createApiKey(createApiKeyRequest: CreateApiKeyRequest): Promise<CreateApiKeyResponse>

- Defined in lib/identitydomains/lib/client.ts:149
Create a user's API key. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateApiKey API.

Parameters
- createApiKeyRequest: CreateApiKeyRequest
Returns Promise<CreateApiKeyResponse>

CreateApiKeyResponse

createApp

createApp(createAppRequest: CreateAppRequest): Promise<CreateAppResponse>

- Defined in lib/identitydomains/lib/client.ts:232
Create an App This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateApp API.

Parameters
- createAppRequest: CreateAppRequest
Returns Promise<CreateAppResponse>

CreateAppResponse

createAppRole

createAppRole(createAppRoleRequest: CreateAppRoleRequest): Promise<CreateAppRoleResponse>

- Defined in lib/identitydomains/lib/client.ts:315
Create an AppRole This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateAppRole API.

Parameters
- createAppRoleRequest: CreateAppRoleRequest
Returns Promise<CreateAppRoleResponse>

CreateAppRoleResponse

createApprovalWorkflow

createApprovalWorkflow(createApprovalWorkflowRequest: CreateApprovalWorkflowRequest): Promise<CreateApprovalWorkflowResponse>

- Defined in lib/identitydomains/lib/client.ts:398
Create ApprovalWorkflow This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateApprovalWorkflow API.

Parameters
- createApprovalWorkflowRequest: CreateApprovalWorkflowRequest
Returns Promise<CreateApprovalWorkflowResponse>

CreateApprovalWorkflowResponse

createApprovalWorkflowAssignment

createApprovalWorkflowAssignment(createApprovalWorkflowAssignmentRequest: CreateApprovalWorkflowAssignmentRequest): Promise<CreateApprovalWorkflowAssignmentResponse>

- Defined in lib/identitydomains/lib/client.ts:482
Create Approval Workflow Assignment This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateApprovalWorkflowAssignment API.

Parameters
- createApprovalWorkflowAssignmentRequest: CreateApprovalWorkflowAssignmentRequest
Returns Promise<CreateApprovalWorkflowAssignmentResponse>

CreateApprovalWorkflowAssignmentResponse

createApprovalWorkflowStep

createApprovalWorkflowStep(createApprovalWorkflowStepRequest: CreateApprovalWorkflowStepRequest): Promise<CreateApprovalWorkflowStepResponse>

- Defined in lib/identitydomains/lib/client.ts:569
Create ApprovalWorkflowStep This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateApprovalWorkflowStep API.

Parameters
- createApprovalWorkflowStepRequest: CreateApprovalWorkflowStepRequest
Returns Promise<CreateApprovalWorkflowStepResponse>

CreateApprovalWorkflowStepResponse

createAuthToken

createAuthToken(createAuthTokenRequest: CreateAuthTokenRequest): Promise<CreateAuthTokenResponse>

- Defined in lib/identitydomains/lib/client.ts:653
Create a user's Auth token. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateAuthToken API.

Parameters
- createAuthTokenRequest: CreateAuthTokenRequest
Returns Promise<CreateAuthTokenResponse>

CreateAuthTokenResponse

createAuthenticationFactorsRemover

createAuthenticationFactorsRemover(createAuthenticationFactorsRemoverRequest: CreateAuthenticationFactorsRemoverRequest): Promise<CreateAuthenticationFactorsRemoverResponse>

- Defined in lib/identitydomains/lib/client.ts:736
Remove All Authentication Factor Channels for a User This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateAuthenticationFactorsRemover API.

Parameters
- createAuthenticationFactorsRemoverRequest: CreateAuthenticationFactorsRemoverRequest
Returns Promise<CreateAuthenticationFactorsRemoverResponse>

CreateAuthenticationFactorsRemoverResponse

createCloudGate

createCloudGate(createCloudGateRequest: CreateCloudGateRequest): Promise<CreateCloudGateResponse>

- Defined in lib/identitydomains/lib/client.ts:820
Create a Cloud Gate This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateCloudGate API.

Parameters
- createCloudGateRequest: CreateCloudGateRequest
Returns Promise<CreateCloudGateResponse>

CreateCloudGateResponse

createCloudGateMapping

createCloudGateMapping(createCloudGateMappingRequest: CreateCloudGateMappingRequest): Promise<CreateCloudGateMappingResponse>

- Defined in lib/identitydomains/lib/client.ts:903
Create a Cloud Gate mapping This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateCloudGateMapping API.

Parameters
- createCloudGateMappingRequest: CreateCloudGateMappingRequest
Returns Promise<CreateCloudGateMappingResponse>

CreateCloudGateMappingResponse

createCloudGateServer

createCloudGateServer(createCloudGateServerRequest: CreateCloudGateServerRequest): Promise<CreateCloudGateServerResponse>

- Defined in lib/identitydomains/lib/client.ts:987
Create a Cloud Gate server This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateCloudGateServer API.

Parameters
- createCloudGateServerRequest: CreateCloudGateServerRequest
Returns Promise<CreateCloudGateServerResponse>

CreateCloudGateServerResponse

createCondition

createCondition(createConditionRequest: CreateConditionRequest): Promise<CreateConditionResponse>

- Defined in lib/identitydomains/lib/client.ts:1071
Create a Condition This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateCondition API.

Parameters
- createConditionRequest: CreateConditionRequest
Returns Promise<CreateConditionResponse>

CreateConditionResponse

createCustomerSecretKey

createCustomerSecretKey(createCustomerSecretKeyRequest: CreateCustomerSecretKeyRequest): Promise<CreateCustomerSecretKeyResponse>

- Defined in lib/identitydomains/lib/client.ts:1154
Create a user's customer secret key. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateCustomerSecretKey API.

Parameters
- createCustomerSecretKeyRequest: CreateCustomerSecretKeyRequest
Returns Promise<CreateCustomerSecretKeyResponse>

CreateCustomerSecretKeyResponse

createDynamicResourceGroup

createDynamicResourceGroup(createDynamicResourceGroupRequest: CreateDynamicResourceGroupRequest): Promise<CreateDynamicResourceGroupResponse>

- Defined in lib/identitydomains/lib/client.ts:1238
Create a Dynamic Resource Group. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateDynamicResourceGroup API.

Parameters
- createDynamicResourceGroupRequest: CreateDynamicResourceGroupRequest
Returns Promise<CreateDynamicResourceGroupResponse>

CreateDynamicResourceGroupResponse

createGrant

createGrant(createGrantRequest: CreateGrantRequest): Promise<CreateGrantResponse>

- Defined in lib/identitydomains/lib/client.ts:1322
Add a Grantee to an AppRole This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateGrant API.

Parameters
- createGrantRequest: CreateGrantRequest
Returns Promise<CreateGrantResponse>

CreateGrantResponse

createGroup

createGroup(createGroupRequest: CreateGroupRequest): Promise<CreateGroupResponse>

- Defined in lib/identitydomains/lib/client.ts:1405
Create a group. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateGroup API.

Parameters
- createGroupRequest: CreateGroupRequest
Returns Promise<CreateGroupResponse>

CreateGroupResponse

createIdentityPropagationTrust

createIdentityPropagationTrust(createIdentityPropagationTrustRequest: CreateIdentityPropagationTrustRequest): Promise<CreateIdentityPropagationTrustResponse>

- Defined in lib/identitydomains/lib/client.ts:1488
Register a new Identity Propagation Trust configuration. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateIdentityPropagationTrust API.

Parameters
- createIdentityPropagationTrustRequest: CreateIdentityPropagationTrustRequest
Returns Promise<CreateIdentityPropagationTrustResponse>

CreateIdentityPropagationTrustResponse

createIdentityProvider

createIdentityProvider(createIdentityProviderRequest: CreateIdentityProviderRequest): Promise<CreateIdentityProviderResponse>

- Defined in lib/identitydomains/lib/client.ts:1573
Create an Identity Provider This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateIdentityProvider API.

Parameters
- createIdentityProviderRequest: CreateIdentityProviderRequest
Returns Promise<CreateIdentityProviderResponse>

CreateIdentityProviderResponse

createMe

createMe(createMeRequest: CreateMeRequest): Promise<CreateMeResponse>

- Defined in lib/identitydomains/lib/client.ts:1657
Self register a user. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateMe API.

Parameters
- createMeRequest: CreateMeRequest
Returns Promise<CreateMeResponse>

CreateMeResponse

createMyApiKey

createMyApiKey(createMyApiKeyRequest: CreateMyApiKeyRequest): Promise<CreateMyApiKeyResponse>

- Defined in lib/identitydomains/lib/client.ts:1736
Add a user's own API key. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateMyApiKey API.

Parameters
- createMyApiKeyRequest: CreateMyApiKeyRequest
Returns Promise<CreateMyApiKeyResponse>

CreateMyApiKeyResponse

createMyAuthToken

createMyAuthToken(createMyAuthTokenRequest: CreateMyAuthTokenRequest): Promise<CreateMyAuthTokenResponse>

- Defined in lib/identitydomains/lib/client.ts:1816
Create a user's own Auth token. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateMyAuthToken API.

Parameters
- createMyAuthTokenRequest: CreateMyAuthTokenRequest
Returns Promise<CreateMyAuthTokenResponse>

CreateMyAuthTokenResponse

createMyAuthenticationFactorInitiator

createMyAuthenticationFactorInitiator(createMyAuthenticationFactorInitiatorRequest: CreateMyAuthenticationFactorInitiatorRequest): Promise<CreateMyAuthenticationFactorInitiatorResponse>

- Defined in lib/identitydomains/lib/client.ts:1897
Initiate Self Service Enrollment using the Requested MFA Factor This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateMyAuthenticationFactorInitiator API.

Parameters
- createMyAuthenticationFactorInitiatorRequest: CreateMyAuthenticationFactorInitiatorRequest
Returns Promise<CreateMyAuthenticationFactorInitiatorResponse>

CreateMyAuthenticationFactorInitiatorResponse

createMyAuthenticationFactorValidator

createMyAuthenticationFactorValidator(createMyAuthenticationFactorValidatorRequest: CreateMyAuthenticationFactorValidatorRequest): Promise<CreateMyAuthenticationFactorValidatorResponse>

- Defined in lib/identitydomains/lib/client.ts:1981
Validate Self Service Enrollment using the Requested MFA Factor This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateMyAuthenticationFactorValidator API.

Parameters
- createMyAuthenticationFactorValidatorRequest: CreateMyAuthenticationFactorValidatorRequest
Returns Promise<CreateMyAuthenticationFactorValidatorResponse>

CreateMyAuthenticationFactorValidatorResponse

createMyAuthenticationFactorsRemover

createMyAuthenticationFactorsRemover(createMyAuthenticationFactorsRemoverRequest: CreateMyAuthenticationFactorsRemoverRequest): Promise<CreateMyAuthenticationFactorsRemoverResponse>

- Defined in lib/identitydomains/lib/client.ts:2065
Remove All Authentication Factor Channels for a User This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateMyAuthenticationFactorsRemover API.

Parameters
- createMyAuthenticationFactorsRemoverRequest: CreateMyAuthenticationFactorsRemoverRequest
Returns Promise<CreateMyAuthenticationFactorsRemoverResponse>

CreateMyAuthenticationFactorsRemoverResponse

createMyCustomerSecretKey

createMyCustomerSecretKey(createMyCustomerSecretKeyRequest: CreateMyCustomerSecretKeyRequest): Promise<CreateMyCustomerSecretKeyResponse>

- Defined in lib/identitydomains/lib/client.ts:2149
Add a user's own customer secret key. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateMyCustomerSecretKey API.

Parameters
- createMyCustomerSecretKeyRequest: CreateMyCustomerSecretKeyRequest
Returns Promise<CreateMyCustomerSecretKeyResponse>

CreateMyCustomerSecretKeyResponse

createMyOAuth2ClientCredential

createMyOAuth2ClientCredential(createMyOAuth2ClientCredentialRequest: CreateMyOAuth2ClientCredentialRequest): Promise<CreateMyOAuth2ClientCredentialResponse>

- Defined in lib/identitydomains/lib/client.ts:2230
Create a user's own OAuth2 client credential. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateMyOAuth2ClientCredential API.

Parameters
- createMyOAuth2ClientCredentialRequest: CreateMyOAuth2ClientCredentialRequest
Returns Promise<CreateMyOAuth2ClientCredentialResponse>

CreateMyOAuth2ClientCredentialResponse

createMyRequest

createMyRequest(createMyRequestRequest: CreateMyRequestRequest): Promise<CreateMyRequestResponse>

- Defined in lib/identitydomains/lib/client.ts:2312
Create a Request This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateMyRequest API.

Parameters
- createMyRequestRequest: CreateMyRequestRequest
Returns Promise<CreateMyRequestResponse>

CreateMyRequestResponse

createMySmtpCredential

createMySmtpCredential(createMySmtpCredentialRequest: CreateMySmtpCredentialRequest): Promise<CreateMySmtpCredentialResponse>

- Defined in lib/identitydomains/lib/client.ts:2395
Create a user's own SMTP credential. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateMySmtpCredential API.

Parameters
- createMySmtpCredentialRequest: CreateMySmtpCredentialRequest
Returns Promise<CreateMySmtpCredentialResponse>

CreateMySmtpCredentialResponse

createMySupportAccount

createMySupportAccount(createMySupportAccountRequest: CreateMySupportAccountRequest): Promise<CreateMySupportAccountResponse>

- Defined in lib/identitydomains/lib/client.ts:2476
Create a user's own support account. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateMySupportAccount API.

Parameters
- createMySupportAccountRequest: CreateMySupportAccountRequest
Returns Promise<CreateMySupportAccountResponse>

CreateMySupportAccountResponse

createMyUserDbCredential

createMyUserDbCredential(createMyUserDbCredentialRequest: CreateMyUserDbCredentialRequest): Promise<CreateMyUserDbCredentialResponse>

- Defined in lib/identitydomains/lib/client.ts:2557
Create a user's own database (DB) credential. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateMyUserDbCredential API.

Parameters
- createMyUserDbCredentialRequest: CreateMyUserDbCredentialRequest
Returns Promise<CreateMyUserDbCredentialResponse>

CreateMyUserDbCredentialResponse

createNetworkPerimeter

createNetworkPerimeter(createNetworkPerimeterRequest: CreateNetworkPerimeterRequest): Promise<CreateNetworkPerimeterResponse>

- Defined in lib/identitydomains/lib/client.ts:2638
Create a NetworkPerimeter This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateNetworkPerimeter API.

Parameters
- createNetworkPerimeterRequest: CreateNetworkPerimeterRequest
Returns Promise<CreateNetworkPerimeterResponse>

CreateNetworkPerimeterResponse

createOAuth2ClientCredential

createOAuth2ClientCredential(createOAuth2ClientCredentialRequest: CreateOAuth2ClientCredentialRequest): Promise<CreateOAuth2ClientCredentialResponse>

- Defined in lib/identitydomains/lib/client.ts:2722
Add a user's OAuth2 client credentials. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateOAuth2ClientCredential API.

Parameters
- createOAuth2ClientCredentialRequest: CreateOAuth2ClientCredentialRequest
Returns Promise<CreateOAuth2ClientCredentialResponse>

CreateOAuth2ClientCredentialResponse

createOAuthClientCertificate

createOAuthClientCertificate(createOAuthClientCertificateRequest: CreateOAuthClientCertificateRequest): Promise<CreateOAuthClientCertificateResponse>

- Defined in lib/identitydomains/lib/client.ts:2806
Create an OAuth Client Certificate This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateOAuthClientCertificate API.

Parameters
- createOAuthClientCertificateRequest: CreateOAuthClientCertificateRequest
Returns Promise<CreateOAuthClientCertificateResponse>

CreateOAuthClientCertificateResponse

createOAuthPartnerCertificate

createOAuthPartnerCertificate(createOAuthPartnerCertificateRequest: CreateOAuthPartnerCertificateRequest): Promise<CreateOAuthPartnerCertificateResponse>

- Defined in lib/identitydomains/lib/client.ts:2887
Create an OAuth Partner Certificate This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateOAuthPartnerCertificate API.

Parameters
- createOAuthPartnerCertificateRequest: CreateOAuthPartnerCertificateRequest
Returns Promise<CreateOAuthPartnerCertificateResponse>

CreateOAuthPartnerCertificateResponse

createPasswordPolicy

createPasswordPolicy(createPasswordPolicyRequest: CreatePasswordPolicyRequest): Promise<CreatePasswordPolicyResponse>

- Defined in lib/identitydomains/lib/client.ts:2969
Create a password policy. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreatePasswordPolicy API.

Parameters
- createPasswordPolicyRequest: CreatePasswordPolicyRequest
Returns Promise<CreatePasswordPolicyResponse>

CreatePasswordPolicyResponse

createPolicy

createPolicy(createPolicyRequest: CreatePolicyRequest): Promise<CreatePolicyResponse>

- Defined in lib/identitydomains/lib/client.ts:3053
Create a Policy This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreatePolicy API.

Parameters
- createPolicyRequest: CreatePolicyRequest
Returns Promise<CreatePolicyResponse>

CreatePolicyResponse

createRule

createRule(createRuleRequest: CreateRuleRequest): Promise<CreateRuleResponse>

- Defined in lib/identitydomains/lib/client.ts:3136
Create a Rule This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateRule API.

Parameters
- createRuleRequest: CreateRuleRequest
Returns Promise<CreateRuleResponse>

CreateRuleResponse

createSecurityQuestion

createSecurityQuestion(createSecurityQuestionRequest: CreateSecurityQuestionRequest): Promise<CreateSecurityQuestionResponse>

- Defined in lib/identitydomains/lib/client.ts:3219
Create a security question. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateSecurityQuestion API.

Parameters
- createSecurityQuestionRequest: CreateSecurityQuestionRequest
Returns Promise<CreateSecurityQuestionResponse>

CreateSecurityQuestionResponse

createSelfRegistrationProfile

createSelfRegistrationProfile(createSelfRegistrationProfileRequest: CreateSelfRegistrationProfileRequest): Promise<CreateSelfRegistrationProfileResponse>

- Defined in lib/identitydomains/lib/client.ts:3303
Create a self-registration profile. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateSelfRegistrationProfile API.

Parameters
- createSelfRegistrationProfileRequest: CreateSelfRegistrationProfileRequest
Returns Promise<CreateSelfRegistrationProfileResponse>

CreateSelfRegistrationProfileResponse

createSmtpCredential

createSmtpCredential(createSmtpCredentialRequest: CreateSmtpCredentialRequest): Promise<CreateSmtpCredentialResponse>

- Defined in lib/identitydomains/lib/client.ts:3388
Create a user's SMTP credentials. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateSmtpCredential API.

Parameters
- createSmtpCredentialRequest: CreateSmtpCredentialRequest
Returns Promise<CreateSmtpCredentialResponse>

CreateSmtpCredentialResponse

createUser

createUser(createUserRequest: CreateUserRequest): Promise<CreateUserResponse>

- Defined in lib/identitydomains/lib/client.ts:3472
Create a user. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateUser API.

Parameters
- createUserRequest: CreateUserRequest
Returns Promise<CreateUserResponse>

CreateUserResponse

createUserDbCredential

createUserDbCredential(createUserDbCredentialRequest: CreateUserDbCredentialRequest): Promise<CreateUserDbCredentialResponse>

- Defined in lib/identitydomains/lib/client.ts:3555
Create a user's database (DB) credentials. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use CreateUserDbCredential API.

Parameters
- createUserDbCredentialRequest: CreateUserDbCredentialRequest
Returns Promise<CreateUserDbCredentialResponse>

CreateUserDbCredentialResponse

deleteApiKey

deleteApiKey(deleteApiKeyRequest: DeleteApiKeyRequest): Promise<DeleteApiKeyResponse>

- Defined in lib/identitydomains/lib/client.ts:3639
Delete a user's API key. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteApiKey API.

Parameters
- deleteApiKeyRequest: DeleteApiKeyRequest
Returns Promise<DeleteApiKeyResponse>

DeleteApiKeyResponse

deleteApp

deleteApp(deleteAppRequest: DeleteAppRequest): Promise<DeleteAppResponse>

- Defined in lib/identitydomains/lib/client.ts:3710
Delete an App This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteApp API.

Parameters
- deleteAppRequest: DeleteAppRequest
Returns Promise<DeleteAppResponse>

DeleteAppResponse

deleteAppRole

deleteAppRole(deleteAppRoleRequest: DeleteAppRoleRequest): Promise<DeleteAppRoleResponse>

- Defined in lib/identitydomains/lib/client.ts:3781
Delete an AppRole This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteAppRole API.

Parameters
- deleteAppRoleRequest: DeleteAppRoleRequest
Returns Promise<DeleteAppRoleResponse>

DeleteAppRoleResponse

deleteApprovalWorkflow

deleteApprovalWorkflow(deleteApprovalWorkflowRequest: DeleteApprovalWorkflowRequest): Promise<DeleteApprovalWorkflowResponse>

- Defined in lib/identitydomains/lib/client.ts:3852
Delete ApprovalWorkflow This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteApprovalWorkflow API.

Parameters
- deleteApprovalWorkflowRequest: DeleteApprovalWorkflowRequest
Returns Promise<DeleteApprovalWorkflowResponse>

DeleteApprovalWorkflowResponse

deleteApprovalWorkflowAssignment

deleteApprovalWorkflowAssignment(deleteApprovalWorkflowAssignmentRequest: DeleteApprovalWorkflowAssignmentRequest): Promise<DeleteApprovalWorkflowAssignmentResponse>

- Defined in lib/identitydomains/lib/client.ts:3924
Delete Approval Workflow Assignment This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteApprovalWorkflowAssignment API.

Parameters
- deleteApprovalWorkflowAssignmentRequest: DeleteApprovalWorkflowAssignmentRequest
Returns Promise<DeleteApprovalWorkflowAssignmentResponse>

DeleteApprovalWorkflowAssignmentResponse

deleteApprovalWorkflowStep

deleteApprovalWorkflowStep(deleteApprovalWorkflowStepRequest: DeleteApprovalWorkflowStepRequest): Promise<DeleteApprovalWorkflowStepResponse>

- Defined in lib/identitydomains/lib/client.ts:4000
Delete ApprovalWorkflowStep This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteApprovalWorkflowStep API.

Parameters
- deleteApprovalWorkflowStepRequest: DeleteApprovalWorkflowStepRequest
Returns Promise<DeleteApprovalWorkflowStepResponse>

DeleteApprovalWorkflowStepResponse

deleteAuthToken

deleteAuthToken(deleteAuthTokenRequest: DeleteAuthTokenRequest): Promise<DeleteAuthTokenResponse>

- Defined in lib/identitydomains/lib/client.ts:4072
Delete a user's Auth token. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteAuthToken API.

Parameters
- deleteAuthTokenRequest: DeleteAuthTokenRequest
Returns Promise<DeleteAuthTokenResponse>

DeleteAuthTokenResponse

deleteCloudGate

deleteCloudGate(deleteCloudGateRequest: DeleteCloudGateRequest): Promise<DeleteCloudGateResponse>

- Defined in lib/identitydomains/lib/client.ts:4143
Delete a Cloud Gate This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteCloudGate API.

Parameters
- deleteCloudGateRequest: DeleteCloudGateRequest
Returns Promise<DeleteCloudGateResponse>

DeleteCloudGateResponse

deleteCloudGateMapping

deleteCloudGateMapping(deleteCloudGateMappingRequest: DeleteCloudGateMappingRequest): Promise<DeleteCloudGateMappingResponse>

- Defined in lib/identitydomains/lib/client.ts:4214
Delete a Cloud Gate mapping This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteCloudGateMapping API.

Parameters
- deleteCloudGateMappingRequest: DeleteCloudGateMappingRequest
Returns Promise<DeleteCloudGateMappingResponse>

DeleteCloudGateMappingResponse

deleteCloudGateServer

deleteCloudGateServer(deleteCloudGateServerRequest: DeleteCloudGateServerRequest): Promise<DeleteCloudGateServerResponse>

- Defined in lib/identitydomains/lib/client.ts:4286
Delete a Cloud Gate server This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteCloudGateServer API.

Parameters
- deleteCloudGateServerRequest: DeleteCloudGateServerRequest
Returns Promise<DeleteCloudGateServerResponse>

DeleteCloudGateServerResponse

deleteCondition

deleteCondition(deleteConditionRequest: DeleteConditionRequest): Promise<DeleteConditionResponse>

- Defined in lib/identitydomains/lib/client.ts:4358
Delete a Condition This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteCondition API.

Parameters
- deleteConditionRequest: DeleteConditionRequest
Returns Promise<DeleteConditionResponse>

DeleteConditionResponse

deleteCustomerSecretKey

deleteCustomerSecretKey(deleteCustomerSecretKeyRequest: DeleteCustomerSecretKeyRequest): Promise<DeleteCustomerSecretKeyResponse>

- Defined in lib/identitydomains/lib/client.ts:4429
Delete a user's customer secret key. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteCustomerSecretKey API.

Parameters
- deleteCustomerSecretKeyRequest: DeleteCustomerSecretKeyRequest
Returns Promise<DeleteCustomerSecretKeyResponse>

DeleteCustomerSecretKeyResponse

deleteDynamicResourceGroup

deleteDynamicResourceGroup(deleteDynamicResourceGroupRequest: DeleteDynamicResourceGroupRequest): Promise<DeleteDynamicResourceGroupResponse>

- Defined in lib/identitydomains/lib/client.ts:4501
Delete a Dynamic Resource Group. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteDynamicResourceGroup API.

Parameters
- deleteDynamicResourceGroupRequest: DeleteDynamicResourceGroupRequest
Returns Promise<DeleteDynamicResourceGroupResponse>

DeleteDynamicResourceGroupResponse

deleteGrant

deleteGrant(deleteGrantRequest: DeleteGrantRequest): Promise<DeleteGrantResponse>

- Defined in lib/identitydomains/lib/client.ts:4573
Remove a Grantee from an AppRole This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteGrant API.

Parameters
- deleteGrantRequest: DeleteGrantRequest
Returns Promise<DeleteGrantResponse>

DeleteGrantResponse

deleteGroup

deleteGroup(deleteGroupRequest: DeleteGroupRequest): Promise<DeleteGroupResponse>

- Defined in lib/identitydomains/lib/client.ts:4644
Delete a group. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteGroup API.

Parameters
- deleteGroupRequest: DeleteGroupRequest
Returns Promise<DeleteGroupResponse>

DeleteGroupResponse

deleteIdentityPropagationTrust

deleteIdentityPropagationTrust(deleteIdentityPropagationTrustRequest: DeleteIdentityPropagationTrustRequest): Promise<DeleteIdentityPropagationTrustResponse>

- Defined in lib/identitydomains/lib/client.ts:4715
Delete an existing Identity Propagation Trust configuration. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteIdentityPropagationTrust API.

Parameters
- deleteIdentityPropagationTrustRequest: DeleteIdentityPropagationTrustRequest
Returns Promise<DeleteIdentityPropagationTrustResponse>

DeleteIdentityPropagationTrustResponse

deleteIdentityProvider

deleteIdentityProvider(deleteIdentityProviderRequest: DeleteIdentityProviderRequest): Promise<DeleteIdentityProviderResponse>

- Defined in lib/identitydomains/lib/client.ts:4789
Delete an Identity Provider This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteIdentityProvider API.

Parameters
- deleteIdentityProviderRequest: DeleteIdentityProviderRequest
Returns Promise<DeleteIdentityProviderResponse>

DeleteIdentityProviderResponse

deleteMyApiKey

deleteMyApiKey(deleteMyApiKeyRequest: DeleteMyApiKeyRequest): Promise<DeleteMyApiKeyResponse>

- Defined in lib/identitydomains/lib/client.ts:4861
Delete a user's own API key. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteMyApiKey API.

Parameters
- deleteMyApiKeyRequest: DeleteMyApiKeyRequest
Returns Promise<DeleteMyApiKeyResponse>

DeleteMyApiKeyResponse

deleteMyAuthToken

deleteMyAuthToken(deleteMyAuthTokenRequest: DeleteMyAuthTokenRequest): Promise<DeleteMyAuthTokenResponse>

- Defined in lib/identitydomains/lib/client.ts:4932
Delete a user's own Auth token. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteMyAuthToken API.

Parameters
- deleteMyAuthTokenRequest: DeleteMyAuthTokenRequest
Returns Promise<DeleteMyAuthTokenResponse>

DeleteMyAuthTokenResponse

deleteMyCustomerSecretKey

deleteMyCustomerSecretKey(deleteMyCustomerSecretKeyRequest: DeleteMyCustomerSecretKeyRequest): Promise<DeleteMyCustomerSecretKeyResponse>

- Defined in lib/identitydomains/lib/client.ts:5004
Delete a user's own customer secret key. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteMyCustomerSecretKey API.

Parameters
- deleteMyCustomerSecretKeyRequest: DeleteMyCustomerSecretKeyRequest
Returns Promise<DeleteMyCustomerSecretKeyResponse>

DeleteMyCustomerSecretKeyResponse

deleteMyDevice

deleteMyDevice(deleteMyDeviceRequest: DeleteMyDeviceRequest): Promise<DeleteMyDeviceResponse>

- Defined in lib/identitydomains/lib/client.ts:5076
Delete a Device This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteMyDevice API.

Parameters
- deleteMyDeviceRequest: DeleteMyDeviceRequest
Returns Promise<DeleteMyDeviceResponse>

DeleteMyDeviceResponse

deleteMyOAuth2ClientCredential

deleteMyOAuth2ClientCredential(deleteMyOAuth2ClientCredentialRequest: DeleteMyOAuth2ClientCredentialRequest): Promise<DeleteMyOAuth2ClientCredentialResponse>

- Defined in lib/identitydomains/lib/client.ts:5147
Delete a user's own OAuth2 client credential. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteMyOAuth2ClientCredential API.

Parameters
- deleteMyOAuth2ClientCredentialRequest: DeleteMyOAuth2ClientCredentialRequest
Returns Promise<DeleteMyOAuth2ClientCredentialResponse>

DeleteMyOAuth2ClientCredentialResponse

deleteMySmtpCredential

deleteMySmtpCredential(deleteMySmtpCredentialRequest: DeleteMySmtpCredentialRequest): Promise<DeleteMySmtpCredentialResponse>

- Defined in lib/identitydomains/lib/client.ts:5221
Delete a user's own SMTP credential. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteMySmtpCredential API.

Parameters
- deleteMySmtpCredentialRequest: DeleteMySmtpCredentialRequest
Returns Promise<DeleteMySmtpCredentialResponse>

DeleteMySmtpCredentialResponse

deleteMySupportAccount

deleteMySupportAccount(deleteMySupportAccountRequest: DeleteMySupportAccountRequest): Promise<DeleteMySupportAccountResponse>

- Defined in lib/identitydomains/lib/client.ts:5293
Delete a user's own support account. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteMySupportAccount API.

Parameters
- deleteMySupportAccountRequest: DeleteMySupportAccountRequest
Returns Promise<DeleteMySupportAccountResponse>

DeleteMySupportAccountResponse

deleteMyTrustedUserAgent

deleteMyTrustedUserAgent(deleteMyTrustedUserAgentRequest: DeleteMyTrustedUserAgentRequest): Promise<DeleteMyTrustedUserAgentResponse>

- Defined in lib/identitydomains/lib/client.ts:5365
Delete a Trusted User Agent This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteMyTrustedUserAgent API.

Parameters
- deleteMyTrustedUserAgentRequest: DeleteMyTrustedUserAgentRequest
Returns Promise<DeleteMyTrustedUserAgentResponse>

DeleteMyTrustedUserAgentResponse

deleteMyUserDbCredential

deleteMyUserDbCredential(deleteMyUserDbCredentialRequest: DeleteMyUserDbCredentialRequest): Promise<DeleteMyUserDbCredentialResponse>

- Defined in lib/identitydomains/lib/client.ts:5437
Delete a user's own database (DB) credential. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteMyUserDbCredential API.

Parameters
- deleteMyUserDbCredentialRequest: DeleteMyUserDbCredentialRequest
Returns Promise<DeleteMyUserDbCredentialResponse>

DeleteMyUserDbCredentialResponse

deleteNetworkPerimeter

deleteNetworkPerimeter(deleteNetworkPerimeterRequest: DeleteNetworkPerimeterRequest): Promise<DeleteNetworkPerimeterResponse>

- Defined in lib/identitydomains/lib/client.ts:5509
Delete a NetworkPerimeter This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteNetworkPerimeter API.

Parameters
- deleteNetworkPerimeterRequest: DeleteNetworkPerimeterRequest
Returns Promise<DeleteNetworkPerimeterResponse>

DeleteNetworkPerimeterResponse

deleteOAuth2ClientCredential

deleteOAuth2ClientCredential(deleteOAuth2ClientCredentialRequest: DeleteOAuth2ClientCredentialRequest): Promise<DeleteOAuth2ClientCredentialResponse>

- Defined in lib/identitydomains/lib/client.ts:5581
Delete a user's OAuth2 client credentials. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteOAuth2ClientCredential API.

Parameters
- deleteOAuth2ClientCredentialRequest: DeleteOAuth2ClientCredentialRequest
Returns Promise<DeleteOAuth2ClientCredentialResponse>

DeleteOAuth2ClientCredentialResponse

deleteOAuthClientCertificate

deleteOAuthClientCertificate(deleteOAuthClientCertificateRequest: DeleteOAuthClientCertificateRequest): Promise<DeleteOAuthClientCertificateResponse>

- Defined in lib/identitydomains/lib/client.ts:5653
Delete an OAuth Client Certificate This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteOAuthClientCertificate API.

Parameters
- deleteOAuthClientCertificateRequest: DeleteOAuthClientCertificateRequest
Returns Promise<DeleteOAuthClientCertificateResponse>

DeleteOAuthClientCertificateResponse

deleteOAuthPartnerCertificate

deleteOAuthPartnerCertificate(deleteOAuthPartnerCertificateRequest: DeleteOAuthPartnerCertificateRequest): Promise<DeleteOAuthPartnerCertificateResponse>

- Defined in lib/identitydomains/lib/client.ts:5725
Delete an OAuth Partner Certificate This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteOAuthPartnerCertificate API.

Parameters
- deleteOAuthPartnerCertificateRequest: DeleteOAuthPartnerCertificateRequest
Returns Promise<DeleteOAuthPartnerCertificateResponse>

DeleteOAuthPartnerCertificateResponse

deletePasswordPolicy

deletePasswordPolicy(deletePasswordPolicyRequest: DeletePasswordPolicyRequest): Promise<DeletePasswordPolicyResponse>

- Defined in lib/identitydomains/lib/client.ts:5798
Delete a password policy. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeletePasswordPolicy API.

Parameters
- deletePasswordPolicyRequest: DeletePasswordPolicyRequest
Returns Promise<DeletePasswordPolicyResponse>

DeletePasswordPolicyResponse

deletePolicy

deletePolicy(deletePolicyRequest: DeletePolicyRequest): Promise<DeletePolicyResponse>

- Defined in lib/identitydomains/lib/client.ts:5870
Delete a Policy This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeletePolicy API.

Parameters
- deletePolicyRequest: DeletePolicyRequest
Returns Promise<DeletePolicyResponse>

DeletePolicyResponse

deleteRule

deleteRule(deleteRuleRequest: DeleteRuleRequest): Promise<DeleteRuleResponse>

- Defined in lib/identitydomains/lib/client.ts:5941
Delete a Rule This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteRule API.

Parameters
- deleteRuleRequest: DeleteRuleRequest
Returns Promise<DeleteRuleResponse>

DeleteRuleResponse

deleteSecurityQuestion

deleteSecurityQuestion(deleteSecurityQuestionRequest: DeleteSecurityQuestionRequest): Promise<DeleteSecurityQuestionResponse>

- Defined in lib/identitydomains/lib/client.ts:6012
Delete a security question. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteSecurityQuestion API.

Parameters
- deleteSecurityQuestionRequest: DeleteSecurityQuestionRequest
Returns Promise<DeleteSecurityQuestionResponse>

DeleteSecurityQuestionResponse

deleteSelfRegistrationProfile

deleteSelfRegistrationProfile(deleteSelfRegistrationProfileRequest: DeleteSelfRegistrationProfileRequest): Promise<DeleteSelfRegistrationProfileResponse>

- Defined in lib/identitydomains/lib/client.ts:6084
Delete a self-registration profile. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteSelfRegistrationProfile API.

Parameters
- deleteSelfRegistrationProfileRequest: DeleteSelfRegistrationProfileRequest
Returns Promise<DeleteSelfRegistrationProfileResponse>

DeleteSelfRegistrationProfileResponse

deleteSmtpCredential

deleteSmtpCredential(deleteSmtpCredentialRequest: DeleteSmtpCredentialRequest): Promise<DeleteSmtpCredentialResponse>

- Defined in lib/identitydomains/lib/client.ts:6157
Delete a user's SMTP credentials. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteSmtpCredential API.

Parameters
- deleteSmtpCredentialRequest: DeleteSmtpCredentialRequest
Returns Promise<DeleteSmtpCredentialResponse>

DeleteSmtpCredentialResponse

deleteUser

deleteUser(deleteUserRequest: DeleteUserRequest): Promise<DeleteUserResponse>

- Defined in lib/identitydomains/lib/client.ts:6229
Delete a user. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteUser API.

Parameters
- deleteUserRequest: DeleteUserRequest
Returns Promise<DeleteUserResponse>

DeleteUserResponse

deleteUserDbCredential

deleteUserDbCredential(deleteUserDbCredentialRequest: DeleteUserDbCredentialRequest): Promise<DeleteUserDbCredentialResponse>

- Defined in lib/identitydomains/lib/client.ts:6300
Delete a user's database (DB) credentials. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteUserDbCredential API.

Parameters
- deleteUserDbCredentialRequest: DeleteUserDbCredentialRequest
Returns Promise<DeleteUserDbCredentialResponse>

DeleteUserDbCredentialResponse

getAccountMgmtInfo

getAccountMgmtInfo(getAccountMgmtInfoRequest: GetAccountMgmtInfoRequest): Promise<GetAccountMgmtInfoResponse>

- Defined in lib/identitydomains/lib/client.ts:6372
Get Account Mgmt Info This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetAccountMgmtInfo API.

Parameters
- getAccountMgmtInfoRequest: GetAccountMgmtInfoRequest
Returns Promise<GetAccountMgmtInfoResponse>

GetAccountMgmtInfoResponse

getAccountRecoverySetting

getAccountRecoverySetting(getAccountRecoverySettingRequest: GetAccountRecoverySettingRequest): Promise<GetAccountRecoverySettingResponse>

- Defined in lib/identitydomains/lib/client.ts:6448
Get an account recovery setting. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetAccountRecoverySetting API.

Parameters
- getAccountRecoverySettingRequest: GetAccountRecoverySettingRequest
Returns Promise<GetAccountRecoverySettingResponse>

GetAccountRecoverySettingResponse

getApiKey

getApiKey(getApiKeyRequest: GetApiKeyRequest): Promise<GetApiKeyResponse>

- Defined in lib/identitydomains/lib/client.ts:6524
Get a user's API key. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetApiKey API.

Parameters
- getApiKeyRequest: GetApiKeyRequest
Returns Promise<GetApiKeyResponse>

GetApiKeyResponse

getApp

getApp(getAppRequest: GetAppRequest): Promise<GetAppResponse>

- Defined in lib/identitydomains/lib/client.ts:6599
Get an App This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetApp API.

Parameters
- getAppRequest: GetAppRequest
Returns Promise<GetAppResponse>

GetAppResponse

getAppRole

getAppRole(getAppRoleRequest: GetAppRoleRequest): Promise<GetAppRoleResponse>

- Defined in lib/identitydomains/lib/client.ts:6672
Get an AppRole This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetAppRole API.

Parameters
- getAppRoleRequest: GetAppRoleRequest
Returns Promise<GetAppRoleResponse>

GetAppRoleResponse

getApprovalWorkflow

getApprovalWorkflow(getApprovalWorkflowRequest: GetApprovalWorkflowRequest): Promise<GetApprovalWorkflowResponse>

- Defined in lib/identitydomains/lib/client.ts:6747
Get ApprovalWorkflow This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetApprovalWorkflow API.

Parameters
- getApprovalWorkflowRequest: GetApprovalWorkflowRequest
Returns Promise<GetApprovalWorkflowResponse>

GetApprovalWorkflowResponse

getApprovalWorkflowAssignment

getApprovalWorkflowAssignment(getApprovalWorkflowAssignmentRequest: GetApprovalWorkflowAssignmentRequest): Promise<GetApprovalWorkflowAssignmentResponse>

- Defined in lib/identitydomains/lib/client.ts:6823
Get an Approval Workflow Assignment This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetApprovalWorkflowAssignment API.

Parameters
- getApprovalWorkflowAssignmentRequest: GetApprovalWorkflowAssignmentRequest
Returns Promise<GetApprovalWorkflowAssignmentResponse>

GetApprovalWorkflowAssignmentResponse

getApprovalWorkflowStep

getApprovalWorkflowStep(getApprovalWorkflowStepRequest: GetApprovalWorkflowStepRequest): Promise<GetApprovalWorkflowStepResponse>

- Defined in lib/identitydomains/lib/client.ts:6901
Get ApprovalWorkflowStep This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetApprovalWorkflowStep API.

Parameters
- getApprovalWorkflowStepRequest: GetApprovalWorkflowStepRequest
Returns Promise<GetApprovalWorkflowStepResponse>

GetApprovalWorkflowStepResponse

getAuthToken

getAuthToken(getAuthTokenRequest: GetAuthTokenRequest): Promise<GetAuthTokenResponse>

- Defined in lib/identitydomains/lib/client.ts:6977
Get a user's Auth token. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetAuthToken API.

Parameters
- getAuthTokenRequest: GetAuthTokenRequest
Returns Promise<GetAuthTokenResponse>

GetAuthTokenResponse

getAuthenticationFactorSetting

getAuthenticationFactorSetting(getAuthenticationFactorSettingRequest: GetAuthenticationFactorSettingRequest): Promise<GetAuthenticationFactorSettingResponse>

- Defined in lib/identitydomains/lib/client.ts:7052
Get Authentication Factor Settings This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetAuthenticationFactorSetting API.

Parameters
- getAuthenticationFactorSettingRequest: GetAuthenticationFactorSettingRequest
Returns Promise<GetAuthenticationFactorSettingResponse>

GetAuthenticationFactorSettingResponse

getBrandingSetting

getBrandingSetting(getBrandingSettingRequest: GetBrandingSettingRequest): Promise<GetBrandingSettingResponse>

- Defined in lib/identitydomains/lib/client.ts:7130
Get Branding Settings This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetBrandingSetting API.

Parameters
- getBrandingSettingRequest: GetBrandingSettingRequest
Returns Promise<GetBrandingSettingResponse>

GetBrandingSettingResponse

getCloudGate

getCloudGate(getCloudGateRequest: GetCloudGateRequest): Promise<GetCloudGateResponse>

- Defined in lib/identitydomains/lib/client.ts:7206
Get a Cloud Gate This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetCloudGate API.

Parameters
- getCloudGateRequest: GetCloudGateRequest
Returns Promise<GetCloudGateResponse>

GetCloudGateResponse

getCloudGateMapping

getCloudGateMapping(getCloudGateMappingRequest: GetCloudGateMappingRequest): Promise<GetCloudGateMappingResponse>

- Defined in lib/identitydomains/lib/client.ts:7281
Get a Cloud Gate mapping This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetCloudGateMapping API.

Parameters
- getCloudGateMappingRequest: GetCloudGateMappingRequest
Returns Promise<GetCloudGateMappingResponse>

GetCloudGateMappingResponse

getCloudGateServer

getCloudGateServer(getCloudGateServerRequest: GetCloudGateServerRequest): Promise<GetCloudGateServerResponse>

- Defined in lib/identitydomains/lib/client.ts:7357
Get a Cloud Gate server This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetCloudGateServer API.

Parameters
- getCloudGateServerRequest: GetCloudGateServerRequest
Returns Promise<GetCloudGateServerResponse>

GetCloudGateServerResponse

getCondition

getCondition(getConditionRequest: GetConditionRequest): Promise<GetConditionResponse>

- Defined in lib/identitydomains/lib/client.ts:7433
Get a Condition This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetCondition API.

Parameters
- getConditionRequest: GetConditionRequest
Returns Promise<GetConditionResponse>

GetConditionResponse

getCustomerSecretKey

getCustomerSecretKey(getCustomerSecretKeyRequest: GetCustomerSecretKeyRequest): Promise<GetCustomerSecretKeyResponse>

- Defined in lib/identitydomains/lib/client.ts:7508
Get a user's customer secret key. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetCustomerSecretKey API.

Parameters
- getCustomerSecretKeyRequest: GetCustomerSecretKeyRequest
Returns Promise<GetCustomerSecretKeyResponse>

GetCustomerSecretKeyResponse

getDynamicResourceGroup

getDynamicResourceGroup(getDynamicResourceGroupRequest: GetDynamicResourceGroupRequest): Promise<GetDynamicResourceGroupResponse>

- Defined in lib/identitydomains/lib/client.ts:7584
Get a Dynamic Resource Group. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetDynamicResourceGroup API.

Parameters
- getDynamicResourceGroupRequest: GetDynamicResourceGroupRequest
Returns Promise<GetDynamicResourceGroupResponse>

GetDynamicResourceGroupResponse

getGrant

getGrant(getGrantRequest: GetGrantRequest): Promise<GetGrantResponse>

- Defined in lib/identitydomains/lib/client.ts:7660
Get a Grant This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetGrant API.

Parameters
- getGrantRequest: GetGrantRequest
Returns Promise<GetGrantResponse>

GetGrantResponse

getGroup

getGroup(getGroupRequest: GetGroupRequest): Promise<GetGroupResponse>

- Defined in lib/identitydomains/lib/client.ts:7735
Get a group. Important: 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. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetGroup API.

Parameters
- getGroupRequest: GetGroupRequest
Returns Promise<GetGroupResponse>

GetGroupResponse

getIdentityPropagationTrust

getIdentityPropagationTrust(getIdentityPropagationTrustRequest: GetIdentityPropagationTrustRequest): Promise<GetIdentityPropagationTrustResponse>

- Defined in lib/identitydomains/lib/client.ts:7810
Get an existing Identity Propagation Trust configuration. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetIdentityPropagationTrust API.

Parameters
- getIdentityPropagationTrustRequest: GetIdentityPropagationTrustRequest
Returns Promise<GetIdentityPropagationTrustResponse>

GetIdentityPropagationTrustResponse

getIdentityProvider

getIdentityProvider(getIdentityProviderRequest: GetIdentityProviderRequest): Promise<GetIdentityProviderResponse>

- Defined in lib/identitydomains/lib/client.ts:7886
Get an Identity Provider This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetIdentityProvider API.

Parameters
- getIdentityProviderRequest: GetIdentityProviderRequest
Returns Promise<GetIdentityProviderResponse>

GetIdentityProviderResponse

getIdentitySetting

getIdentitySetting(getIdentitySettingRequest: GetIdentitySettingRequest): Promise<GetIdentitySettingResponse>

- Defined in lib/identitydomains/lib/client.ts:7962
Get an Identity setting. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetIdentitySetting API.

Parameters
- getIdentitySettingRequest: GetIdentitySettingRequest
Returns Promise<GetIdentitySettingResponse>

GetIdentitySettingResponse

getKmsiSetting

getKmsiSetting(getKmsiSettingRequest: GetKmsiSettingRequest): Promise<GetKmsiSettingResponse>

- Defined in lib/identitydomains/lib/client.ts:8038
Get KmsiSettings This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetKmsiSetting API.

Parameters
- getKmsiSettingRequest: GetKmsiSettingRequest
Returns Promise<GetKmsiSettingResponse>

GetKmsiSettingResponse

getMe

getMe(getMeRequest: GetMeRequest): Promise<GetMeResponse>

- Defined in lib/identitydomains/lib/client.ts:8113
Get a user's own information. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetMe API.

Parameters
- getMeRequest: GetMeRequest
Returns Promise<GetMeResponse>

GetMeResponse

getMyApiKey

getMyApiKey(getMyApiKeyRequest: GetMyApiKeyRequest): Promise<GetMyApiKeyResponse>

- Defined in lib/identitydomains/lib/client.ts:8184
Get a user's own API key. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetMyApiKey API.

Parameters
- getMyApiKeyRequest: GetMyApiKeyRequest
Returns Promise<GetMyApiKeyResponse>

GetMyApiKeyResponse

getMyAuthToken

getMyAuthToken(getMyAuthTokenRequest: GetMyAuthTokenRequest): Promise<GetMyAuthTokenResponse>

- Defined in lib/identitydomains/lib/client.ts:8256
Get a user's own Auth token. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetMyAuthToken API.

Parameters
- getMyAuthTokenRequest: GetMyAuthTokenRequest
Returns Promise<GetMyAuthTokenResponse>

GetMyAuthTokenResponse

getMyCompletedApproval

getMyCompletedApproval(getMyCompletedApprovalRequest: GetMyCompletedApprovalRequest): Promise<GetMyCompletedApprovalResponse>

- Defined in lib/identitydomains/lib/client.ts:8328
Get My MyCompletedApproval This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetMyCompletedApproval API.

Parameters
- getMyCompletedApprovalRequest: GetMyCompletedApprovalRequest
Returns Promise<GetMyCompletedApprovalResponse>

GetMyCompletedApprovalResponse

getMyCustomerSecretKey

getMyCustomerSecretKey(getMyCustomerSecretKeyRequest: GetMyCustomerSecretKeyRequest): Promise<GetMyCustomerSecretKeyResponse>

- Defined in lib/identitydomains/lib/client.ts:8401
Get a user's own customer secret key. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetMyCustomerSecretKey API.

Parameters
- getMyCustomerSecretKeyRequest: GetMyCustomerSecretKeyRequest
Returns Promise<GetMyCustomerSecretKeyResponse>

GetMyCustomerSecretKeyResponse

getMyDevice

getMyDevice(getMyDeviceRequest: GetMyDeviceRequest): Promise<GetMyDeviceResponse>

- Defined in lib/identitydomains/lib/client.ts:8474
Get a Device This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetMyDevice API.

Parameters
- getMyDeviceRequest: GetMyDeviceRequest
Returns Promise<GetMyDeviceResponse>

GetMyDeviceResponse

getMyOAuth2ClientCredential

getMyOAuth2ClientCredential(getMyOAuth2ClientCredentialRequest: GetMyOAuth2ClientCredentialRequest): Promise<GetMyOAuth2ClientCredentialResponse>

- Defined in lib/identitydomains/lib/client.ts:8549
Get a user's own OAuth2 client credential. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetMyOAuth2ClientCredential API.

Parameters
- getMyOAuth2ClientCredentialRequest: GetMyOAuth2ClientCredentialRequest
Returns Promise<GetMyOAuth2ClientCredentialResponse>

GetMyOAuth2ClientCredentialResponse

getMyPendingApproval

getMyPendingApproval(getMyPendingApprovalRequest: GetMyPendingApprovalRequest): Promise<GetMyPendingApprovalResponse>

- Defined in lib/identitydomains/lib/client.ts:8622
Get My MyPendingApproval This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetMyPendingApproval API.

Parameters
- getMyPendingApprovalRequest: GetMyPendingApprovalRequest
Returns Promise<GetMyPendingApprovalResponse>

GetMyPendingApprovalResponse

getMyRequest

getMyRequest(getMyRequestRequest: GetMyRequestRequest): Promise<GetMyRequestResponse>

- Defined in lib/identitydomains/lib/client.ts:8695
Get My Requests This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetMyRequest API.

Parameters
- getMyRequestRequest: GetMyRequestRequest
Returns Promise<GetMyRequestResponse>

GetMyRequestResponse

getMySmtpCredential

getMySmtpCredential(getMySmtpCredentialRequest: GetMySmtpCredentialRequest): Promise<GetMySmtpCredentialResponse>

- Defined in lib/identitydomains/lib/client.ts:8770
Get a user's own SMTP credential. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetMySmtpCredential API.

Parameters
- getMySmtpCredentialRequest: GetMySmtpCredentialRequest
Returns Promise<GetMySmtpCredentialResponse>

GetMySmtpCredentialResponse

getMySupportAccount

getMySupportAccount(getMySupportAccountRequest: GetMySupportAccountRequest): Promise<GetMySupportAccountResponse>

- Defined in lib/identitydomains/lib/client.ts:8843
Get a user's own support account. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetMySupportAccount API.

Parameters
- getMySupportAccountRequest: GetMySupportAccountRequest
Returns Promise<GetMySupportAccountResponse>

GetMySupportAccountResponse

getMyTrustedUserAgent

getMyTrustedUserAgent(getMyTrustedUserAgentRequest: GetMyTrustedUserAgentRequest): Promise<GetMyTrustedUserAgentResponse>

- Defined in lib/identitydomains/lib/client.ts:8916
Get a Trusted User Agent This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetMyTrustedUserAgent API.

Parameters
- getMyTrustedUserAgentRequest: GetMyTrustedUserAgentRequest
Returns Promise<GetMyTrustedUserAgentResponse>

GetMyTrustedUserAgentResponse

getMyUserDbCredential

getMyUserDbCredential(getMyUserDbCredentialRequest: GetMyUserDbCredentialRequest): Promise<GetMyUserDbCredentialResponse>

- Defined in lib/identitydomains/lib/client.ts:8992
Get a user's own database (DB) credential. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetMyUserDbCredential API.

Parameters
- getMyUserDbCredentialRequest: GetMyUserDbCredentialRequest
Returns Promise<GetMyUserDbCredentialResponse>

GetMyUserDbCredentialResponse

getNetworkPerimeter

getNetworkPerimeter(getNetworkPerimeterRequest: GetNetworkPerimeterRequest): Promise<GetNetworkPerimeterResponse>

- Defined in lib/identitydomains/lib/client.ts:9065
Get a NetworkPerimeter This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetNetworkPerimeter API.

Parameters
- getNetworkPerimeterRequest: GetNetworkPerimeterRequest
Returns Promise<GetNetworkPerimeterResponse>

GetNetworkPerimeterResponse

getNotificationSetting

getNotificationSetting(getNotificationSettingRequest: GetNotificationSettingRequest): Promise<GetNotificationSettingResponse>

- Defined in lib/identitydomains/lib/client.ts:9141
Get Notification Settings This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetNotificationSetting API.

Parameters
- getNotificationSettingRequest: GetNotificationSettingRequest
Returns Promise<GetNotificationSettingResponse>

GetNotificationSettingResponse

getOAuth2ClientCredential

getOAuth2ClientCredential(getOAuth2ClientCredentialRequest: GetOAuth2ClientCredentialRequest): Promise<GetOAuth2ClientCredentialResponse>

- Defined in lib/identitydomains/lib/client.ts:9217
Get a user's OAuth2 client credentials. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetOAuth2ClientCredential API.

Parameters
- getOAuth2ClientCredentialRequest: GetOAuth2ClientCredentialRequest
Returns Promise<GetOAuth2ClientCredentialResponse>

GetOAuth2ClientCredentialResponse

getOAuthClientCertificate

getOAuthClientCertificate(getOAuthClientCertificateRequest: GetOAuthClientCertificateRequest): Promise<GetOAuthClientCertificateResponse>

- Defined in lib/identitydomains/lib/client.ts:9293
Get OAuth Client Certificates This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetOAuthClientCertificate API.

Parameters
- getOAuthClientCertificateRequest: GetOAuthClientCertificateRequest
Returns Promise<GetOAuthClientCertificateResponse>

GetOAuthClientCertificateResponse

getOAuthPartnerCertificate

getOAuthPartnerCertificate(getOAuthPartnerCertificateRequest: GetOAuthPartnerCertificateRequest): Promise<GetOAuthPartnerCertificateResponse>

- Defined in lib/identitydomains/lib/client.ts:9366
Get an OAuth Partner Certificate This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetOAuthPartnerCertificate API.

Parameters
- getOAuthPartnerCertificateRequest: GetOAuthPartnerCertificateRequest
Returns Promise<GetOAuthPartnerCertificateResponse>

GetOAuthPartnerCertificateResponse

getPasswordPolicy

getPasswordPolicy(getPasswordPolicyRequest: GetPasswordPolicyRequest): Promise<GetPasswordPolicyResponse>

- Defined in lib/identitydomains/lib/client.ts:9439
Get a password policy. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetPasswordPolicy API.

Parameters
- getPasswordPolicyRequest: GetPasswordPolicyRequest
Returns Promise<GetPasswordPolicyResponse>

GetPasswordPolicyResponse

getPolicy

getPolicy(getPolicyRequest: GetPolicyRequest): Promise<GetPolicyResponse>

- Defined in lib/identitydomains/lib/client.ts:9515
Get a Policy This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetPolicy API.

Parameters
- getPolicyRequest: GetPolicyRequest
Returns Promise<GetPolicyResponse>

GetPolicyResponse

getRule

getRule(getRuleRequest: GetRuleRequest): Promise<GetRuleResponse>

- Defined in lib/identitydomains/lib/client.ts:9590
Get a Rule This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetRule API.

Parameters
- getRuleRequest: GetRuleRequest
Returns Promise<GetRuleResponse>

GetRuleResponse

getSchema

getSchema(getSchemaRequest: GetSchemaRequest): Promise<GetSchemaResponse>

- Defined in lib/identitydomains/lib/client.ts:9665
Get a Schema This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetSchema API.

Parameters
- getSchemaRequest: GetSchemaRequest
Returns Promise<GetSchemaResponse>

GetSchemaResponse

getSecurityQuestion

getSecurityQuestion(getSecurityQuestionRequest: GetSecurityQuestionRequest): Promise<GetSecurityQuestionResponse>

- Defined in lib/identitydomains/lib/client.ts:9737
Get a security question. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetSecurityQuestion API.

Parameters
- getSecurityQuestionRequest: GetSecurityQuestionRequest
Returns Promise<GetSecurityQuestionResponse>

GetSecurityQuestionResponse

getSecurityQuestionSetting

getSecurityQuestionSetting(getSecurityQuestionSettingRequest: GetSecurityQuestionSettingRequest): Promise<GetSecurityQuestionSettingResponse>

- Defined in lib/identitydomains/lib/client.ts:9813
Get a security question setting. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetSecurityQuestionSetting API.

Parameters
- getSecurityQuestionSettingRequest: GetSecurityQuestionSettingRequest
Returns Promise<GetSecurityQuestionSettingResponse>

GetSecurityQuestionSettingResponse

getSelfRegistrationProfile

getSelfRegistrationProfile(getSelfRegistrationProfileRequest: GetSelfRegistrationProfileRequest): Promise<GetSelfRegistrationProfileResponse>

- Defined in lib/identitydomains/lib/client.ts:9889
Get a self-registration profile. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetSelfRegistrationProfile API.

Parameters
- getSelfRegistrationProfileRequest: GetSelfRegistrationProfileRequest
Returns Promise<GetSelfRegistrationProfileResponse>

GetSelfRegistrationProfileResponse

getSetting

getSetting(getSettingRequest: GetSettingRequest): Promise<GetSettingResponse>

- Defined in lib/identitydomains/lib/client.ts:9965
Get Settings This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetSetting API.

Parameters
- getSettingRequest: GetSettingRequest
Returns Promise<GetSettingResponse>

GetSettingResponse

getSmtpCredential

getSmtpCredential(getSmtpCredentialRequest: GetSmtpCredentialRequest): Promise<GetSmtpCredentialResponse>

- Defined in lib/identitydomains/lib/client.ts:10040
Get a user's SMTP credentials. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetSmtpCredential API.

Parameters
- getSmtpCredentialRequest: GetSmtpCredentialRequest
Returns Promise<GetSmtpCredentialResponse>

GetSmtpCredentialResponse

getUser

getUser(getUserRequest: GetUserRequest): Promise<GetUserResponse>

- Defined in lib/identitydomains/lib/client.ts:10116
Get a user. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetUser API.

Parameters
- getUserRequest: GetUserRequest
Returns Promise<GetUserResponse>

GetUserResponse

getUserAttributesSetting

getUserAttributesSetting(getUserAttributesSettingRequest: GetUserAttributesSettingRequest): Promise<GetUserAttributesSettingResponse>

- Defined in lib/identitydomains/lib/client.ts:10191
Get User Schema Attribute Settings This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetUserAttributesSetting API.

Parameters
- getUserAttributesSettingRequest: GetUserAttributesSettingRequest
Returns Promise<GetUserAttributesSettingResponse>

GetUserAttributesSettingResponse

getUserDbCredential

getUserDbCredential(getUserDbCredentialRequest: GetUserDbCredentialRequest): Promise<GetUserDbCredentialResponse>

- Defined in lib/identitydomains/lib/client.ts:10267
Get a user's database (DB) credentials. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use GetUserDbCredential API.

Parameters
- getUserDbCredentialRequest: GetUserDbCredentialRequest
Returns Promise<GetUserDbCredentialResponse>

GetUserDbCredentialResponse

listAccountMgmtInfos

listAccountMgmtInfos(listAccountMgmtInfosRequest: ListAccountMgmtInfosRequest): Promise<ListAccountMgmtInfosResponse>

- Defined in lib/identitydomains/lib/client.ts:10343
Search Account Mgmt Info This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListAccountMgmtInfos API.

Parameters
- listAccountMgmtInfosRequest: ListAccountMgmtInfosRequest
Returns Promise<ListAccountMgmtInfosResponse>

ListAccountMgmtInfosResponse

listAccountRecoverySettings

listAccountRecoverySettings(listAccountRecoverySettingsRequest: ListAccountRecoverySettingsRequest): Promise<ListAccountRecoverySettingsResponse>

- Defined in lib/identitydomains/lib/client.ts:10429
Search for account recovery settings. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListAccountRecoverySettings API.

Parameters
- listAccountRecoverySettingsRequest: ListAccountRecoverySettingsRequest
Returns Promise<ListAccountRecoverySettingsResponse>

ListAccountRecoverySettingsResponse

listApiKeys

listApiKeys(listApiKeysRequest: ListApiKeysRequest): Promise<ListApiKeysResponse>

- Defined in lib/identitydomains/lib/client.ts:10510
Search API keys. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListApiKeys API.

Parameters
- listApiKeysRequest: ListApiKeysRequest
Returns Promise<ListApiKeysResponse>

ListApiKeysResponse

listAppRoles

listAppRoles(listAppRolesRequest: ListAppRolesRequest): Promise<ListAppRolesResponse>

- Defined in lib/identitydomains/lib/client.ts:10595
Search AppRoles This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListAppRoles API.

Parameters
- listAppRolesRequest: ListAppRolesRequest
Returns Promise<ListAppRolesResponse>

ListAppRolesResponse

listApprovalWorkflowAssignments

listApprovalWorkflowAssignments(listApprovalWorkflowAssignmentsRequest: ListApprovalWorkflowAssignmentsRequest): Promise<ListApprovalWorkflowAssignmentsResponse>

- Defined in lib/identitydomains/lib/client.ts:10680
Search Approval Workflow Assignments This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListApprovalWorkflowAssignments API.

Parameters
- listApprovalWorkflowAssignmentsRequest: ListApprovalWorkflowAssignmentsRequest
Returns Promise<ListApprovalWorkflowAssignmentsResponse>

ListApprovalWorkflowAssignmentsResponse

listApprovalWorkflowSteps

listApprovalWorkflowSteps(listApprovalWorkflowStepsRequest: ListApprovalWorkflowStepsRequest): Promise<ListApprovalWorkflowStepsResponse>

- Defined in lib/identitydomains/lib/client.ts:10767
Search ApprovalWorkflowStep This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListApprovalWorkflowSteps API.

Parameters
- listApprovalWorkflowStepsRequest: ListApprovalWorkflowStepsRequest
Returns Promise<ListApprovalWorkflowStepsResponse>

ListApprovalWorkflowStepsResponse

listApprovalWorkflows

listApprovalWorkflows(listApprovalWorkflowsRequest: ListApprovalWorkflowsRequest): Promise<ListApprovalWorkflowsResponse>

- Defined in lib/identitydomains/lib/client.ts:10853
Search ApprovalWorkflow This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListApprovalWorkflows API.

Parameters
- listApprovalWorkflowsRequest: ListApprovalWorkflowsRequest
Returns Promise<ListApprovalWorkflowsResponse>

ListApprovalWorkflowsResponse

listApps

listApps(listAppsRequest: ListAppsRequest): Promise<ListAppsResponse>

- Defined in lib/identitydomains/lib/client.ts:10939
Search Apps This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListApps API.

Parameters
- listAppsRequest: ListAppsRequest
Returns Promise<ListAppsResponse>

ListAppsResponse

listAuthTokens

listAuthTokens(listAuthTokensRequest: ListAuthTokensRequest): Promise<ListAuthTokensResponse>

- Defined in lib/identitydomains/lib/client.ts:11024
Search for Auth tokens. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListAuthTokens API.

Parameters
- listAuthTokensRequest: ListAuthTokensRequest
Returns Promise<ListAuthTokensResponse>

ListAuthTokensResponse

listAuthenticationFactorSettings

listAuthenticationFactorSettings(listAuthenticationFactorSettingsRequest: ListAuthenticationFactorSettingsRequest): Promise<ListAuthenticationFactorSettingsResponse>

- Defined in lib/identitydomains/lib/client.ts:11109
Search Authentication Factor Settings This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListAuthenticationFactorSettings API.

Parameters
- listAuthenticationFactorSettingsRequest: ListAuthenticationFactorSettingsRequest
Returns Promise<ListAuthenticationFactorSettingsResponse>

ListAuthenticationFactorSettingsResponse

listBrandingSettings

listBrandingSettings(listBrandingSettingsRequest: ListBrandingSettingsRequest): Promise<ListBrandingSettingsResponse>

- Defined in lib/identitydomains/lib/client.ts:11193
Search Branding Settings This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListBrandingSettings API.

Parameters
- listBrandingSettingsRequest: ListBrandingSettingsRequest
Returns Promise<ListBrandingSettingsResponse>

ListBrandingSettingsResponse

listCloudGateMappings

listCloudGateMappings(listCloudGateMappingsRequest: ListCloudGateMappingsRequest): Promise<ListCloudGateMappingsResponse>

- Defined in lib/identitydomains/lib/client.ts:11274
Search Cloud Gate mappings This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListCloudGateMappings API.

Parameters
- listCloudGateMappingsRequest: ListCloudGateMappingsRequest
Returns Promise<ListCloudGateMappingsResponse>

ListCloudGateMappingsResponse

listCloudGateServers

listCloudGateServers(listCloudGateServersRequest: ListCloudGateServersRequest): Promise<ListCloudGateServersResponse>

- Defined in lib/identitydomains/lib/client.ts:11360
Search Cloud Gate servers This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListCloudGateServers API.

Parameters
- listCloudGateServersRequest: ListCloudGateServersRequest
Returns Promise<ListCloudGateServersResponse>

ListCloudGateServersResponse

listCloudGates

listCloudGates(listCloudGatesRequest: ListCloudGatesRequest): Promise<ListCloudGatesResponse>

- Defined in lib/identitydomains/lib/client.ts:11446
Search Cloud Gates This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListCloudGates API.

Parameters
- listCloudGatesRequest: ListCloudGatesRequest
Returns Promise<ListCloudGatesResponse>

ListCloudGatesResponse

listConditions

listConditions(listConditionsRequest: ListConditionsRequest): Promise<ListConditionsResponse>

- Defined in lib/identitydomains/lib/client.ts:11531
Search Conditions This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListConditions API.

Parameters
- listConditionsRequest: ListConditionsRequest
Returns Promise<ListConditionsResponse>

ListConditionsResponse

listCustomerSecretKeys

listCustomerSecretKeys(listCustomerSecretKeysRequest: ListCustomerSecretKeysRequest): Promise<ListCustomerSecretKeysResponse>

- Defined in lib/identitydomains/lib/client.ts:11616
Search for a user's customer secret keys. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListCustomerSecretKeys API.

Parameters
- listCustomerSecretKeysRequest: ListCustomerSecretKeysRequest
Returns Promise<ListCustomerSecretKeysResponse>

ListCustomerSecretKeysResponse

listDynamicResourceGroups

listDynamicResourceGroups(listDynamicResourceGroupsRequest: ListDynamicResourceGroupsRequest): Promise<ListDynamicResourceGroupsResponse>

- Defined in lib/identitydomains/lib/client.ts:11702
Search for Dynamic Resource Groups. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListDynamicResourceGroups API.

Parameters
- listDynamicResourceGroupsRequest: ListDynamicResourceGroupsRequest
Returns Promise<ListDynamicResourceGroupsResponse>

ListDynamicResourceGroupsResponse

listGrants

listGrants(listGrantsRequest: ListGrantsRequest): Promise<ListGrantsResponse>

- Defined in lib/identitydomains/lib/client.ts:11788
Search Grants This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListGrants API.

Parameters
- listGrantsRequest: ListGrantsRequest
Returns Promise<ListGrantsResponse>

ListGrantsResponse

listGroups

listGroups(listGroupsRequest: ListGroupsRequest): Promise<ListGroupsResponse>

- Defined in lib/identitydomains/lib/client.ts:11873
Search for groups. Important: 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. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListGroups API.

Parameters
- listGroupsRequest: ListGroupsRequest
Returns Promise<ListGroupsResponse>

ListGroupsResponse

listIdentityPropagationTrusts

listIdentityPropagationTrusts(listIdentityPropagationTrustsRequest: ListIdentityPropagationTrustsRequest): Promise<ListIdentityPropagationTrustsResponse>

- Defined in lib/identitydomains/lib/client.ts:11958
List the Identity Propagation Trust configurations. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListIdentityPropagationTrusts API.

Parameters
- listIdentityPropagationTrustsRequest: ListIdentityPropagationTrustsRequest
Returns Promise<ListIdentityPropagationTrustsResponse>

ListIdentityPropagationTrustsResponse

listIdentityProviders

listIdentityProviders(listIdentityProvidersRequest: ListIdentityProvidersRequest): Promise<ListIdentityProvidersResponse>

- Defined in lib/identitydomains/lib/client.ts:12045
Search Identity Providers This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListIdentityProviders API.

Parameters
- listIdentityProvidersRequest: ListIdentityProvidersRequest
Returns Promise<ListIdentityProvidersResponse>

ListIdentityProvidersResponse

listIdentitySettings

listIdentitySettings(listIdentitySettingsRequest: ListIdentitySettingsRequest): Promise<ListIdentitySettingsResponse>

- Defined in lib/identitydomains/lib/client.ts:12131
Search for Identity settings. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListIdentitySettings API.

Parameters
- listIdentitySettingsRequest: ListIdentitySettingsRequest
Returns Promise<ListIdentitySettingsResponse>

ListIdentitySettingsResponse

listKmsiSettings

listKmsiSettings(listKmsiSettingsRequest: ListKmsiSettingsRequest): Promise<ListKmsiSettingsResponse>

- Defined in lib/identitydomains/lib/client.ts:12212
Search KmsiSettings This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListKmsiSettings API.

Parameters
- listKmsiSettingsRequest: ListKmsiSettingsRequest
Returns Promise<ListKmsiSettingsResponse>

ListKmsiSettingsResponse

listMyApiKeys

listMyApiKeys(listMyApiKeysRequest: ListMyApiKeysRequest): Promise<ListMyApiKeysResponse>

- Defined in lib/identitydomains/lib/client.ts:12292
Search for a user's own API key. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListMyApiKeys API.

Parameters
- listMyApiKeysRequest: ListMyApiKeysRequest
Returns Promise<ListMyApiKeysResponse>

ListMyApiKeysResponse

listMyApps

listMyApps(listMyAppsRequest: ListMyAppsRequest): Promise<ListMyAppsResponse>

- Defined in lib/identitydomains/lib/client.ts:12375
Search My Apps This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListMyApps API.

Parameters
- listMyAppsRequest: ListMyAppsRequest
Returns Promise<ListMyAppsResponse>

ListMyAppsResponse

listMyAuthTokens

listMyAuthTokens(listMyAuthTokensRequest: ListMyAuthTokensRequest): Promise<ListMyAuthTokensResponse>

- Defined in lib/identitydomains/lib/client.ts:12458
Search for a user's own Auth token. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListMyAuthTokens API.

Parameters
- listMyAuthTokensRequest: ListMyAuthTokensRequest
Returns Promise<ListMyAuthTokensResponse>

ListMyAuthTokensResponse

listMyCompletedApprovals

listMyCompletedApprovals(listMyCompletedApprovalsRequest: ListMyCompletedApprovalsRequest): Promise<ListMyCompletedApprovalsResponse>

- Defined in lib/identitydomains/lib/client.ts:12541
Search My MyCompletedApproval This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListMyCompletedApprovals API.

Parameters
- listMyCompletedApprovalsRequest: ListMyCompletedApprovalsRequest
Returns Promise<ListMyCompletedApprovalsResponse>

ListMyCompletedApprovalsResponse

listMyCustomerSecretKeys

listMyCustomerSecretKeys(listMyCustomerSecretKeysRequest: ListMyCustomerSecretKeysRequest): Promise<ListMyCustomerSecretKeysResponse>

- Defined in lib/identitydomains/lib/client.ts:12625
Search for a user's own customer secret key. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListMyCustomerSecretKeys API.

Parameters
- listMyCustomerSecretKeysRequest: ListMyCustomerSecretKeysRequest
Returns Promise<ListMyCustomerSecretKeysResponse>

ListMyCustomerSecretKeysResponse

listMyDevices

listMyDevices(listMyDevicesRequest: ListMyDevicesRequest): Promise<ListMyDevicesResponse>

- Defined in lib/identitydomains/lib/client.ts:12709
Search Devices This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListMyDevices API.

Parameters
- listMyDevicesRequest: ListMyDevicesRequest
Returns Promise<ListMyDevicesResponse>

ListMyDevicesResponse

listMyGroups

listMyGroups(listMyGroupsRequest: ListMyGroupsRequest): Promise<ListMyGroupsResponse>

- Defined in lib/identitydomains/lib/client.ts:12794
Search for 'My Groups'. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListMyGroups API.

Parameters
- listMyGroupsRequest: ListMyGroupsRequest
Returns Promise<ListMyGroupsResponse>

ListMyGroupsResponse

listMyOAuth2ClientCredentials

listMyOAuth2ClientCredentials(listMyOAuth2ClientCredentialsRequest: ListMyOAuth2ClientCredentialsRequest): Promise<ListMyOAuth2ClientCredentialsResponse>

- Defined in lib/identitydomains/lib/client.ts:12879
Search for a user's own OAuth2 client credential. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListMyOAuth2ClientCredentials API.

Parameters
- listMyOAuth2ClientCredentialsRequest: ListMyOAuth2ClientCredentialsRequest
Returns Promise<ListMyOAuth2ClientCredentialsResponse>

ListMyOAuth2ClientCredentialsResponse

listMyPendingApprovals

listMyPendingApprovals(listMyPendingApprovalsRequest: ListMyPendingApprovalsRequest): Promise<ListMyPendingApprovalsResponse>

- Defined in lib/identitydomains/lib/client.ts:12964
Search My Approvals This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListMyPendingApprovals API.

Parameters
- listMyPendingApprovalsRequest: ListMyPendingApprovalsRequest
Returns Promise<ListMyPendingApprovalsResponse>

ListMyPendingApprovalsResponse

listMyRequestableGroups

listMyRequestableGroups(listMyRequestableGroupsRequest: ListMyRequestableGroupsRequest): Promise<ListMyRequestableGroupsResponse>

- Defined in lib/identitydomains/lib/client.ts:13048
Search My Requestable Groups This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListMyRequestableGroups API.

Parameters
- listMyRequestableGroupsRequest: ListMyRequestableGroupsRequest
Returns Promise<ListMyRequestableGroupsResponse>

ListMyRequestableGroupsResponse

listMyRequests

listMyRequests(listMyRequestsRequest: ListMyRequestsRequest): Promise<ListMyRequestsResponse>

- Defined in lib/identitydomains/lib/client.ts:13132
Search My Requests This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListMyRequests API.

Parameters
- listMyRequestsRequest: ListMyRequestsRequest
Returns Promise<ListMyRequestsResponse>

ListMyRequestsResponse

listMySmtpCredentials

listMySmtpCredentials(listMySmtpCredentialsRequest: ListMySmtpCredentialsRequest): Promise<ListMySmtpCredentialsResponse>

- Defined in lib/identitydomains/lib/client.ts:13217
Search for a user's own SMTP credential. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListMySmtpCredentials API.

Parameters
- listMySmtpCredentialsRequest: ListMySmtpCredentialsRequest
Returns Promise<ListMySmtpCredentialsResponse>

ListMySmtpCredentialsResponse

listMySupportAccounts

listMySupportAccounts(listMySupportAccountsRequest: ListMySupportAccountsRequest): Promise<ListMySupportAccountsResponse>

- Defined in lib/identitydomains/lib/client.ts:13301
Search for a user's own support account. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListMySupportAccounts API.

Parameters
- listMySupportAccountsRequest: ListMySupportAccountsRequest
Returns Promise<ListMySupportAccountsResponse>

ListMySupportAccountsResponse

listMyTrustedUserAgents

listMyTrustedUserAgents(listMyTrustedUserAgentsRequest: ListMyTrustedUserAgentsRequest): Promise<ListMyTrustedUserAgentsResponse>

- Defined in lib/identitydomains/lib/client.ts:13385
Search Trusted User Agents This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListMyTrustedUserAgents API.

Parameters
- listMyTrustedUserAgentsRequest: ListMyTrustedUserAgentsRequest
Returns Promise<ListMyTrustedUserAgentsResponse>

ListMyTrustedUserAgentsResponse

listMyUserDbCredentials

listMyUserDbCredentials(listMyUserDbCredentialsRequest: ListMyUserDbCredentialsRequest): Promise<ListMyUserDbCredentialsResponse>

- Defined in lib/identitydomains/lib/client.ts:13471
Search for a user's own database (DB) credential. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListMyUserDbCredentials API.

Parameters
- listMyUserDbCredentialsRequest: ListMyUserDbCredentialsRequest
Returns Promise<ListMyUserDbCredentialsResponse>

ListMyUserDbCredentialsResponse

listNetworkPerimeters

listNetworkPerimeters(listNetworkPerimetersRequest: ListNetworkPerimetersRequest): Promise<ListNetworkPerimetersResponse>

- Defined in lib/identitydomains/lib/client.ts:13555
Search NetworkPerimeters This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListNetworkPerimeters API.

Parameters
- listNetworkPerimetersRequest: ListNetworkPerimetersRequest
Returns Promise<ListNetworkPerimetersResponse>

ListNetworkPerimetersResponse

listNotificationSettings

listNotificationSettings(listNotificationSettingsRequest: ListNotificationSettingsRequest): Promise<ListNotificationSettingsResponse>

- Defined in lib/identitydomains/lib/client.ts:13641
Search Notification Settings This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListNotificationSettings API.

Parameters
- listNotificationSettingsRequest: ListNotificationSettingsRequest
Returns Promise<ListNotificationSettingsResponse>

ListNotificationSettingsResponse

listOAuth2ClientCredentials

listOAuth2ClientCredentials(listOAuth2ClientCredentialsRequest: ListOAuth2ClientCredentialsRequest): Promise<ListOAuth2ClientCredentialsResponse>

- Defined in lib/identitydomains/lib/client.ts:13722
Search for a user's OAuth2 client credentials. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListOAuth2ClientCredentials API.

Parameters
- listOAuth2ClientCredentialsRequest: ListOAuth2ClientCredentialsRequest
Returns Promise<ListOAuth2ClientCredentialsResponse>

ListOAuth2ClientCredentialsResponse

listOAuthClientCertificates

listOAuthClientCertificates(listOAuthClientCertificatesRequest: ListOAuthClientCertificatesRequest): Promise<ListOAuthClientCertificatesResponse>

- Defined in lib/identitydomains/lib/client.ts:13808
Search OAuth Client Certificates This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListOAuthClientCertificates API.

Parameters
- listOAuthClientCertificatesRequest: ListOAuthClientCertificatesRequest
Returns Promise<ListOAuthClientCertificatesResponse>

ListOAuthClientCertificatesResponse

listOAuthPartnerCertificates

listOAuthPartnerCertificates(listOAuthPartnerCertificatesRequest: ListOAuthPartnerCertificatesRequest): Promise<ListOAuthPartnerCertificatesResponse>

- Defined in lib/identitydomains/lib/client.ts:13892
Search OAuth Partner Certificates This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListOAuthPartnerCertificates API.

Parameters
- listOAuthPartnerCertificatesRequest: ListOAuthPartnerCertificatesRequest
Returns Promise<ListOAuthPartnerCertificatesResponse>

ListOAuthPartnerCertificatesResponse

listPasswordPolicies

listPasswordPolicies(listPasswordPoliciesRequest: ListPasswordPoliciesRequest): Promise<ListPasswordPoliciesResponse>

- Defined in lib/identitydomains/lib/client.ts:13976
Search for password policies. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListPasswordPolicies API.

Parameters
- listPasswordPoliciesRequest: ListPasswordPoliciesRequest
Returns Promise<ListPasswordPoliciesResponse>

ListPasswordPoliciesResponse

listPolicies

listPolicies(listPoliciesRequest: ListPoliciesRequest): Promise<ListPoliciesResponse>

- Defined in lib/identitydomains/lib/client.ts:14062
Search Policies This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListPolicies API.

Parameters
- listPoliciesRequest: ListPoliciesRequest
Returns Promise<ListPoliciesResponse>

ListPoliciesResponse

listResourceTypeSchemaAttributes

listResourceTypeSchemaAttributes(listResourceTypeSchemaAttributesRequest: ListResourceTypeSchemaAttributesRequest): Promise<ListResourceTypeSchemaAttributesResponse>

- Defined in lib/identitydomains/lib/client.ts:14147
Search Resource Type Schema Attributes This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListResourceTypeSchemaAttributes API.

Parameters
- listResourceTypeSchemaAttributesRequest: ListResourceTypeSchemaAttributesRequest
Returns Promise<ListResourceTypeSchemaAttributesResponse>

ListResourceTypeSchemaAttributesResponse

listRules

listRules(listRulesRequest: ListRulesRequest): Promise<ListRulesResponse>

- Defined in lib/identitydomains/lib/client.ts:14236
Search Rules This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListRules API.

Parameters
- listRulesRequest: ListRulesRequest
Returns Promise<ListRulesResponse>

ListRulesResponse

listSchemas

listSchemas(listSchemasRequest: ListSchemasRequest): Promise<ListSchemasResponse>

- Defined in lib/identitydomains/lib/client.ts:14321
Search Schemas This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListSchemas API.

Parameters
- listSchemasRequest: ListSchemasRequest
Returns Promise<ListSchemasResponse>

ListSchemasResponse

listSecurityQuestionSettings

listSecurityQuestionSettings(listSecurityQuestionSettingsRequest: ListSecurityQuestionSettingsRequest): Promise<ListSecurityQuestionSettingsResponse>

- Defined in lib/identitydomains/lib/client.ts:14403
Search for security question settings. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListSecurityQuestionSettings API.

Parameters
- listSecurityQuestionSettingsRequest: ListSecurityQuestionSettingsRequest
Returns Promise<ListSecurityQuestionSettingsResponse>

ListSecurityQuestionSettingsResponse

listSecurityQuestions

listSecurityQuestions(listSecurityQuestionsRequest: ListSecurityQuestionsRequest): Promise<ListSecurityQuestionsResponse>

- Defined in lib/identitydomains/lib/client.ts:14484
Search for security questions. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListSecurityQuestions API.

Parameters
- listSecurityQuestionsRequest: ListSecurityQuestionsRequest
Returns Promise<ListSecurityQuestionsResponse>

ListSecurityQuestionsResponse

listSelfRegistrationProfiles

listSelfRegistrationProfiles(listSelfRegistrationProfilesRequest: ListSelfRegistrationProfilesRequest): Promise<ListSelfRegistrationProfilesResponse>

- Defined in lib/identitydomains/lib/client.ts:14570
Search for self-registration profiles. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListSelfRegistrationProfiles API.

Parameters
- listSelfRegistrationProfilesRequest: ListSelfRegistrationProfilesRequest
Returns Promise<ListSelfRegistrationProfilesResponse>

ListSelfRegistrationProfilesResponse

listSettings

listSettings(listSettingsRequest: ListSettingsRequest): Promise<ListSettingsResponse>

- Defined in lib/identitydomains/lib/client.ts:14656
Search Settings This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListSettings API.

Parameters
- listSettingsRequest: ListSettingsRequest
Returns Promise<ListSettingsResponse>

ListSettingsResponse

listSmtpCredentials

listSmtpCredentials(listSmtpCredentialsRequest: ListSmtpCredentialsRequest): Promise<ListSmtpCredentialsResponse>

- Defined in lib/identitydomains/lib/client.ts:14736
Search for SMTP credentials. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListSmtpCredentials API.

Parameters
- listSmtpCredentialsRequest: ListSmtpCredentialsRequest
Returns Promise<ListSmtpCredentialsResponse>

ListSmtpCredentialsResponse

listUserAttributesSettings

listUserAttributesSettings(listUserAttributesSettingsRequest: ListUserAttributesSettingsRequest): Promise<ListUserAttributesSettingsResponse>

- Defined in lib/identitydomains/lib/client.ts:14822
Search User Schema Attribute Settings This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListUserAttributesSettings API.

Parameters
- listUserAttributesSettingsRequest: ListUserAttributesSettingsRequest
Returns Promise<ListUserAttributesSettingsResponse>

ListUserAttributesSettingsResponse

listUserDbCredentials

listUserDbCredentials(listUserDbCredentialsRequest: ListUserDbCredentialsRequest): Promise<ListUserDbCredentialsResponse>

- Defined in lib/identitydomains/lib/client.ts:14903
Search for a user's database (DB) credentials. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListUserDbCredentials API.

Parameters
- listUserDbCredentialsRequest: ListUserDbCredentialsRequest
Returns Promise<ListUserDbCredentialsResponse>

ListUserDbCredentialsResponse

listUsers

listUsers(listUsersRequest: ListUsersRequest): Promise<ListUsersResponse>

- Defined in lib/identitydomains/lib/client.ts:14989
Search for users. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ListUsers API.

Parameters
- listUsersRequest: ListUsersRequest
Returns Promise<ListUsersResponse>

ListUsersResponse

patchAccountRecoverySetting

patchAccountRecoverySetting(patchAccountRecoverySettingRequest: PatchAccountRecoverySettingRequest): Promise<PatchAccountRecoverySettingResponse>

- Defined in lib/identitydomains/lib/client.ts:15074
Update an account recovery setting. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchAccountRecoverySetting API.

Parameters
- patchAccountRecoverySettingRequest: PatchAccountRecoverySettingRequest
Returns Promise<PatchAccountRecoverySettingResponse>

PatchAccountRecoverySettingResponse

patchApiKey

patchApiKey(patchApiKeyRequest: PatchApiKeyRequest): Promise<PatchApiKeyResponse>

- Defined in lib/identitydomains/lib/client.ts:15161
Update a user's API key. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchApiKey API.

Parameters
- patchApiKeyRequest: PatchApiKeyRequest
Returns Promise<PatchApiKeyResponse>

PatchApiKeyResponse

patchApp

patchApp(patchAppRequest: PatchAppRequest): Promise<PatchAppResponse>

- Defined in lib/identitydomains/lib/client.ts:15247
Update an App This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchApp API.

Parameters
- patchAppRequest: PatchAppRequest
Returns Promise<PatchAppResponse>

PatchAppResponse

patchAppRole

patchAppRole(patchAppRoleRequest: PatchAppRoleRequest): Promise<PatchAppRoleResponse>

- Defined in lib/identitydomains/lib/client.ts:15333
Update an AppRole This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchAppRole API.

Parameters
- patchAppRoleRequest: PatchAppRoleRequest
Returns Promise<PatchAppRoleResponse>

PatchAppRoleResponse

patchApprovalWorkflow

patchApprovalWorkflow(patchApprovalWorkflowRequest: PatchApprovalWorkflowRequest): Promise<PatchApprovalWorkflowResponse>

- Defined in lib/identitydomains/lib/client.ts:15419
Update ApprovalWorkflow This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchApprovalWorkflow API.

Parameters
- patchApprovalWorkflowRequest: PatchApprovalWorkflowRequest
Returns Promise<PatchApprovalWorkflowResponse>

PatchApprovalWorkflowResponse

patchApprovalWorkflowStep

patchApprovalWorkflowStep(patchApprovalWorkflowStepRequest: PatchApprovalWorkflowStepRequest): Promise<PatchApprovalWorkflowStepResponse>

- Defined in lib/identitydomains/lib/client.ts:15506
Update ApprovalWorkflowStep This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchApprovalWorkflowStep API.

Parameters
- patchApprovalWorkflowStepRequest: PatchApprovalWorkflowStepRequest
Returns Promise<PatchApprovalWorkflowStepResponse>

PatchApprovalWorkflowStepResponse

patchAuthToken

patchAuthToken(patchAuthTokenRequest: PatchAuthTokenRequest): Promise<PatchAuthTokenResponse>

- Defined in lib/identitydomains/lib/client.ts:15593
Update a user's Auth token. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchAuthToken API.

Parameters
- patchAuthTokenRequest: PatchAuthTokenRequest
Returns Promise<PatchAuthTokenResponse>

PatchAuthTokenResponse

patchCloudGate

patchCloudGate(patchCloudGateRequest: PatchCloudGateRequest): Promise<PatchCloudGateResponse>

- Defined in lib/identitydomains/lib/client.ts:15679
Update a Cloud Gate This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchCloudGate API.

Parameters
- patchCloudGateRequest: PatchCloudGateRequest
Returns Promise<PatchCloudGateResponse>

PatchCloudGateResponse

patchCloudGateMapping

patchCloudGateMapping(patchCloudGateMappingRequest: PatchCloudGateMappingRequest): Promise<PatchCloudGateMappingResponse>

- Defined in lib/identitydomains/lib/client.ts:15765
Update a Cloud Gate mapping This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchCloudGateMapping API.

Parameters
- patchCloudGateMappingRequest: PatchCloudGateMappingRequest
Returns Promise<PatchCloudGateMappingResponse>

PatchCloudGateMappingResponse

patchCloudGateServer

patchCloudGateServer(patchCloudGateServerRequest: PatchCloudGateServerRequest): Promise<PatchCloudGateServerResponse>

- Defined in lib/identitydomains/lib/client.ts:15852
Update a Cloud Gate server This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchCloudGateServer API.

Parameters
- patchCloudGateServerRequest: PatchCloudGateServerRequest
Returns Promise<PatchCloudGateServerResponse>

PatchCloudGateServerResponse

patchCondition

patchCondition(patchConditionRequest: PatchConditionRequest): Promise<PatchConditionResponse>

- Defined in lib/identitydomains/lib/client.ts:15939
Update a Condition This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchCondition API.

Parameters
- patchConditionRequest: PatchConditionRequest
Returns Promise<PatchConditionResponse>

PatchConditionResponse

patchCustomerSecretKey

patchCustomerSecretKey(patchCustomerSecretKeyRequest: PatchCustomerSecretKeyRequest): Promise<PatchCustomerSecretKeyResponse>

- Defined in lib/identitydomains/lib/client.ts:16025
Update a user's customer secret key. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchCustomerSecretKey API.

Parameters
- patchCustomerSecretKeyRequest: PatchCustomerSecretKeyRequest
Returns Promise<PatchCustomerSecretKeyResponse>

PatchCustomerSecretKeyResponse

patchDynamicResourceGroup

patchDynamicResourceGroup(patchDynamicResourceGroupRequest: PatchDynamicResourceGroupRequest): Promise<PatchDynamicResourceGroupResponse>

- Defined in lib/identitydomains/lib/client.ts:16112
Update a Dynamic Resource Group. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchDynamicResourceGroup API.

Parameters
- patchDynamicResourceGroupRequest: PatchDynamicResourceGroupRequest
Returns Promise<PatchDynamicResourceGroupResponse>

PatchDynamicResourceGroupResponse

patchGrant

patchGrant(patchGrantRequest: PatchGrantRequest): Promise<PatchGrantResponse>

- Defined in lib/identitydomains/lib/client.ts:16199
Update a Grant This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchGrant API.

Parameters
- patchGrantRequest: PatchGrantRequest
Returns Promise<PatchGrantResponse>

PatchGrantResponse

patchGroup

patchGroup(patchGroupRequest: PatchGroupRequest): Promise<PatchGroupResponse>

- Defined in lib/identitydomains/lib/client.ts:16285
Update a group. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchGroup API.

Parameters
- patchGroupRequest: PatchGroupRequest
Returns Promise<PatchGroupResponse>

PatchGroupResponse

patchIdentityPropagationTrust

patchIdentityPropagationTrust(patchIdentityPropagationTrustRequest: PatchIdentityPropagationTrustRequest): Promise<PatchIdentityPropagationTrustResponse>

- Defined in lib/identitydomains/lib/client.ts:16371
Update an existing Identity Propagation Trust configuration. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchIdentityPropagationTrust API.

Parameters
- patchIdentityPropagationTrustRequest: PatchIdentityPropagationTrustRequest
Returns Promise<PatchIdentityPropagationTrustResponse>

PatchIdentityPropagationTrustResponse

patchIdentityProvider

patchIdentityProvider(patchIdentityProviderRequest: PatchIdentityProviderRequest): Promise<PatchIdentityProviderResponse>

- Defined in lib/identitydomains/lib/client.ts:16460
Update an Identity Provider This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchIdentityProvider API.

Parameters
- patchIdentityProviderRequest: PatchIdentityProviderRequest
Returns Promise<PatchIdentityProviderResponse>

PatchIdentityProviderResponse

patchIdentitySetting

patchIdentitySetting(patchIdentitySettingRequest: PatchIdentitySettingRequest): Promise<PatchIdentitySettingResponse>

- Defined in lib/identitydomains/lib/client.ts:16547
Update an Identity setting. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchIdentitySetting API.

Parameters
- patchIdentitySettingRequest: PatchIdentitySettingRequest
Returns Promise<PatchIdentitySettingResponse>

PatchIdentitySettingResponse

patchKmsiSetting

patchKmsiSetting(patchKmsiSettingRequest: PatchKmsiSettingRequest): Promise<PatchKmsiSettingResponse>

- Defined in lib/identitydomains/lib/client.ts:16634
Update a Setting This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchKmsiSetting API.

Parameters
- patchKmsiSettingRequest: PatchKmsiSettingRequest
Returns Promise<PatchKmsiSettingResponse>

PatchKmsiSettingResponse

patchMe

patchMe(patchMeRequest: PatchMeRequest): Promise<PatchMeResponse>

- Defined in lib/identitydomains/lib/client.ts:16720
Update a user's own information. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchMe API.

Parameters
- patchMeRequest: PatchMeRequest
Returns Promise<PatchMeResponse>

PatchMeResponse

patchMyApiKey

patchMyApiKey(patchMyApiKeyRequest: PatchMyApiKeyRequest): Promise<PatchMyApiKeyResponse>

- Defined in lib/identitydomains/lib/client.ts:16804
Update a user's own API key. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchMyApiKey API.

Parameters
- patchMyApiKeyRequest: PatchMyApiKeyRequest
Returns Promise<PatchMyApiKeyResponse>

PatchMyApiKeyResponse

patchMyAuthToken

patchMyAuthToken(patchMyAuthTokenRequest: PatchMyAuthTokenRequest): Promise<PatchMyAuthTokenResponse>

- Defined in lib/identitydomains/lib/client.ts:16887
Update a user's own Auth token. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchMyAuthToken API.

Parameters
- patchMyAuthTokenRequest: PatchMyAuthTokenRequest
Returns Promise<PatchMyAuthTokenResponse>

PatchMyAuthTokenResponse

patchMyCustomerSecretKey

patchMyCustomerSecretKey(patchMyCustomerSecretKeyRequest: PatchMyCustomerSecretKeyRequest): Promise<PatchMyCustomerSecretKeyResponse>

- Defined in lib/identitydomains/lib/client.ts:16970
Update a user's own customer secret key. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchMyCustomerSecretKey API.

Parameters
- patchMyCustomerSecretKeyRequest: PatchMyCustomerSecretKeyRequest
Returns Promise<PatchMyCustomerSecretKeyResponse>

PatchMyCustomerSecretKeyResponse

patchMyDevice

patchMyDevice(patchMyDeviceRequest: PatchMyDeviceRequest): Promise<PatchMyDeviceResponse>

- Defined in lib/identitydomains/lib/client.ts:17054
Update a Device This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchMyDevice API.

Parameters
- patchMyDeviceRequest: PatchMyDeviceRequest
Returns Promise<PatchMyDeviceResponse>

PatchMyDeviceResponse

patchMyOAuth2ClientCredential

patchMyOAuth2ClientCredential(patchMyOAuth2ClientCredentialRequest: PatchMyOAuth2ClientCredentialRequest): Promise<PatchMyOAuth2ClientCredentialResponse>

- Defined in lib/identitydomains/lib/client.ts:17140
Update a user's own OAuth2 client credential. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchMyOAuth2ClientCredential API.

Parameters
- patchMyOAuth2ClientCredentialRequest: PatchMyOAuth2ClientCredentialRequest
Returns Promise<PatchMyOAuth2ClientCredentialResponse>

PatchMyOAuth2ClientCredentialResponse

patchMyPendingApproval

patchMyPendingApproval(patchMyPendingApprovalRequest: PatchMyPendingApprovalRequest): Promise<PatchMyPendingApprovalResponse>

- Defined in lib/identitydomains/lib/client.ts:17226
Update MyPendingApproval This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchMyPendingApproval API.

Parameters
- patchMyPendingApprovalRequest: PatchMyPendingApprovalRequest
Returns Promise<PatchMyPendingApprovalResponse>

PatchMyPendingApprovalResponse

patchMyRequest

patchMyRequest(patchMyRequestRequest: PatchMyRequestRequest): Promise<PatchMyRequestResponse>

- Defined in lib/identitydomains/lib/client.ts:17310
Update My Requests This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchMyRequest API.

Parameters
- patchMyRequestRequest: PatchMyRequestRequest
Returns Promise<PatchMyRequestResponse>

PatchMyRequestResponse

patchMySmtpCredential

patchMySmtpCredential(patchMySmtpCredentialRequest: PatchMySmtpCredentialRequest): Promise<PatchMySmtpCredentialResponse>

- Defined in lib/identitydomains/lib/client.ts:17396
Update a user's own SMTP credential. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchMySmtpCredential API.

Parameters
- patchMySmtpCredentialRequest: PatchMySmtpCredentialRequest
Returns Promise<PatchMySmtpCredentialResponse>

PatchMySmtpCredentialResponse

patchNetworkPerimeter

patchNetworkPerimeter(patchNetworkPerimeterRequest: PatchNetworkPerimeterRequest): Promise<PatchNetworkPerimeterResponse>

- Defined in lib/identitydomains/lib/client.ts:17480
Update a NetworkPerimeter This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchNetworkPerimeter API.

Parameters
- patchNetworkPerimeterRequest: PatchNetworkPerimeterRequest
Returns Promise<PatchNetworkPerimeterResponse>

PatchNetworkPerimeterResponse

patchOAuth2ClientCredential

patchOAuth2ClientCredential(patchOAuth2ClientCredentialRequest: PatchOAuth2ClientCredentialRequest): Promise<PatchOAuth2ClientCredentialResponse>

- Defined in lib/identitydomains/lib/client.ts:17567
Update a user's OAuth2 client credentials. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchOAuth2ClientCredential API.

Parameters
- patchOAuth2ClientCredentialRequest: PatchOAuth2ClientCredentialRequest
Returns Promise<PatchOAuth2ClientCredentialResponse>

PatchOAuth2ClientCredentialResponse

patchPasswordPolicy

patchPasswordPolicy(patchPasswordPolicyRequest: PatchPasswordPolicyRequest): Promise<PatchPasswordPolicyResponse>

- Defined in lib/identitydomains/lib/client.ts:17654
Update a password policy. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchPasswordPolicy API.

Parameters
- patchPasswordPolicyRequest: PatchPasswordPolicyRequest
Returns Promise<PatchPasswordPolicyResponse>

PatchPasswordPolicyResponse

patchPolicy

patchPolicy(patchPolicyRequest: PatchPolicyRequest): Promise<PatchPolicyResponse>

- Defined in lib/identitydomains/lib/client.ts:17741
Update a Policy This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchPolicy API.

Parameters
- patchPolicyRequest: PatchPolicyRequest
Returns Promise<PatchPolicyResponse>

PatchPolicyResponse

patchRule

patchRule(patchRuleRequest: PatchRuleRequest): Promise<PatchRuleResponse>

- Defined in lib/identitydomains/lib/client.ts:17827
Update a Rule This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchRule API.

Parameters
- patchRuleRequest: PatchRuleRequest
Returns Promise<PatchRuleResponse>

PatchRuleResponse

patchSchema

patchSchema(patchSchemaRequest: PatchSchemaRequest): Promise<PatchSchemaResponse>

- Defined in lib/identitydomains/lib/client.ts:17913
Update a Schema Def This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchSchema API.

Parameters
- patchSchemaRequest: PatchSchemaRequest
Returns Promise<PatchSchemaResponse>

PatchSchemaResponse

patchSecurityQuestion

patchSecurityQuestion(patchSecurityQuestionRequest: PatchSecurityQuestionRequest): Promise<PatchSecurityQuestionResponse>

- Defined in lib/identitydomains/lib/client.ts:17996
Update a security question. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchSecurityQuestion API.

Parameters
- patchSecurityQuestionRequest: PatchSecurityQuestionRequest
Returns Promise<PatchSecurityQuestionResponse>

PatchSecurityQuestionResponse

patchSecurityQuestionSetting

patchSecurityQuestionSetting(patchSecurityQuestionSettingRequest: PatchSecurityQuestionSettingRequest): Promise<PatchSecurityQuestionSettingResponse>

- Defined in lib/identitydomains/lib/client.ts:18083
Update a security question setting. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchSecurityQuestionSetting API.

Parameters
- patchSecurityQuestionSettingRequest: PatchSecurityQuestionSettingRequest
Returns Promise<PatchSecurityQuestionSettingResponse>

PatchSecurityQuestionSettingResponse

patchSelfRegistrationProfile

patchSelfRegistrationProfile(patchSelfRegistrationProfileRequest: PatchSelfRegistrationProfileRequest): Promise<PatchSelfRegistrationProfileResponse>

- Defined in lib/identitydomains/lib/client.ts:18170
Update a self-registration profile. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchSelfRegistrationProfile API.

Parameters
- patchSelfRegistrationProfileRequest: PatchSelfRegistrationProfileRequest
Returns Promise<PatchSelfRegistrationProfileResponse>

PatchSelfRegistrationProfileResponse

patchSetting

patchSetting(patchSettingRequest: PatchSettingRequest): Promise<PatchSettingResponse>

- Defined in lib/identitydomains/lib/client.ts:18257
Update a Setting This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchSetting API.

Parameters
- patchSettingRequest: PatchSettingRequest
Returns Promise<PatchSettingResponse>

PatchSettingResponse

patchSmtpCredential

patchSmtpCredential(patchSmtpCredentialRequest: PatchSmtpCredentialRequest): Promise<PatchSmtpCredentialResponse>

- Defined in lib/identitydomains/lib/client.ts:18343
Update a user's SMTP credentials. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchSmtpCredential API.

Parameters
- patchSmtpCredentialRequest: PatchSmtpCredentialRequest
Returns Promise<PatchSmtpCredentialResponse>

PatchSmtpCredentialResponse

patchUser

patchUser(patchUserRequest: PatchUserRequest): Promise<PatchUserResponse>

- Defined in lib/identitydomains/lib/client.ts:18430
Update a user. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchUser API.

Parameters
- patchUserRequest: PatchUserRequest
Returns Promise<PatchUserResponse>

PatchUserResponse

patchUserAttributesSetting

patchUserAttributesSetting(patchUserAttributesSettingRequest: PatchUserAttributesSettingRequest): Promise<PatchUserAttributesSettingResponse>

- Defined in lib/identitydomains/lib/client.ts:18516
Update User Schema Attribute Settings This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PatchUserAttributesSetting API.

Parameters
- patchUserAttributesSettingRequest: PatchUserAttributesSettingRequest
Returns Promise<PatchUserAttributesSettingResponse>

PatchUserAttributesSettingResponse

putAccountRecoverySetting

putAccountRecoverySetting(putAccountRecoverySettingRequest: PutAccountRecoverySettingRequest): Promise<PutAccountRecoverySettingResponse>

- Defined in lib/identitydomains/lib/client.ts:18603
Replace an account recovery setting. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PutAccountRecoverySetting API.

Parameters
- putAccountRecoverySettingRequest: PutAccountRecoverySettingRequest
Returns Promise<PutAccountRecoverySettingResponse>

PutAccountRecoverySettingResponse

putApp

putApp(putAppRequest: PutAppRequest): Promise<PutAppResponse>

- Defined in lib/identitydomains/lib/client.ts:18690
Replace an App This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PutApp API.

Parameters
- putAppRequest: PutAppRequest
Returns Promise<PutAppResponse>

PutAppResponse

putAppStatusChanger

putAppStatusChanger(putAppStatusChangerRequest: PutAppStatusChangerRequest): Promise<PutAppStatusChangerResponse>

- Defined in lib/identitydomains/lib/client.ts:18774
Activate/Deactivate an App This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PutAppStatusChanger API.

Parameters
- putAppStatusChangerRequest: PutAppStatusChangerRequest
Returns Promise<PutAppStatusChangerResponse>

PutAppStatusChangerResponse

putApprovalWorkflow

putApprovalWorkflow(putApprovalWorkflowRequest: PutApprovalWorkflowRequest): Promise<PutApprovalWorkflowResponse>

- Defined in lib/identitydomains/lib/client.ts:18861
Replace ApprovalWorkflow This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PutApprovalWorkflow API.

Parameters
- putApprovalWorkflowRequest: PutApprovalWorkflowRequest
Returns Promise<PutApprovalWorkflowResponse>

PutApprovalWorkflowResponse

putAuthenticationFactorSetting

putAuthenticationFactorSetting(putAuthenticationFactorSettingRequest: PutAuthenticationFactorSettingRequest): Promise<PutAuthenticationFactorSettingResponse>

- Defined in lib/identitydomains/lib/client.ts:18948
Replace Authentication Factor Settings This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PutAuthenticationFactorSetting API.

Parameters
- putAuthenticationFactorSettingRequest: PutAuthenticationFactorSettingRequest
Returns Promise<PutAuthenticationFactorSettingResponse>

PutAuthenticationFactorSettingResponse

putCloudGate

putCloudGate(putCloudGateRequest: PutCloudGateRequest): Promise<PutCloudGateResponse>

- Defined in lib/identitydomains/lib/client.ts:19037
Replace a Cloud Gate This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PutCloudGate API.

Parameters
- putCloudGateRequest: PutCloudGateRequest
Returns Promise<PutCloudGateResponse>

PutCloudGateResponse

putCloudGateMapping

putCloudGateMapping(putCloudGateMappingRequest: PutCloudGateMappingRequest): Promise<PutCloudGateMappingResponse>

- Defined in lib/identitydomains/lib/client.ts:19123
Replace a Cloud Gate mapping This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PutCloudGateMapping API.

Parameters
- putCloudGateMappingRequest: PutCloudGateMappingRequest
Returns Promise<PutCloudGateMappingResponse>

PutCloudGateMappingResponse

putCloudGateServer

putCloudGateServer(putCloudGateServerRequest: PutCloudGateServerRequest): Promise<PutCloudGateServerResponse>

- Defined in lib/identitydomains/lib/client.ts:19210
Replace a Cloud Gate server This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PutCloudGateServer API.

Parameters
- putCloudGateServerRequest: PutCloudGateServerRequest
Returns Promise<PutCloudGateServerResponse>

PutCloudGateServerResponse

putCondition

putCondition(putConditionRequest: PutConditionRequest): Promise<PutConditionResponse>

- Defined in lib/identitydomains/lib/client.ts:19297
Replace a Condition This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PutCondition API.

Parameters
- putConditionRequest: PutConditionRequest
Returns Promise<PutConditionResponse>

PutConditionResponse

putDynamicResourceGroup

putDynamicResourceGroup(putDynamicResourceGroupRequest: PutDynamicResourceGroupRequest): Promise<PutDynamicResourceGroupResponse>

- Defined in lib/identitydomains/lib/client.ts:19383
Replace a Dynamic Resource Group. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PutDynamicResourceGroup API.

Parameters
- putDynamicResourceGroupRequest: PutDynamicResourceGroupRequest
Returns Promise<PutDynamicResourceGroupResponse>

PutDynamicResourceGroupResponse

putGroup

putGroup(putGroupRequest: PutGroupRequest): Promise<PutGroupResponse>

- Defined in lib/identitydomains/lib/client.ts:19470
Replace a group. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PutGroup API.

Parameters
- putGroupRequest: PutGroupRequest
Returns Promise<PutGroupResponse>

PutGroupResponse

putIdentityPropagationTrust

putIdentityPropagationTrust(putIdentityPropagationTrustRequest: PutIdentityPropagationTrustRequest): Promise<PutIdentityPropagationTrustResponse>

- Defined in lib/identitydomains/lib/client.ts:19556
Replace an existing Identity Propagation Trust configuration. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PutIdentityPropagationTrust API.

Parameters
- putIdentityPropagationTrustRequest: PutIdentityPropagationTrustRequest
Returns Promise<PutIdentityPropagationTrustResponse>

PutIdentityPropagationTrustResponse

putIdentityProvider

putIdentityProvider(putIdentityProviderRequest: PutIdentityProviderRequest): Promise<PutIdentityProviderResponse>

- Defined in lib/identitydomains/lib/client.ts:19643
Replace an Identity Provider This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PutIdentityProvider API.

Parameters
- putIdentityProviderRequest: PutIdentityProviderRequest
Returns Promise<PutIdentityProviderResponse>

PutIdentityProviderResponse

putIdentitySetting

putIdentitySetting(putIdentitySettingRequest: PutIdentitySettingRequest): Promise<PutIdentitySettingResponse>

- Defined in lib/identitydomains/lib/client.ts:19730
Replace an Identity setting. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PutIdentitySetting API.

Parameters
- putIdentitySettingRequest: PutIdentitySettingRequest
Returns Promise<PutIdentitySettingResponse>

PutIdentitySettingResponse

putKmsiSetting

putKmsiSetting(putKmsiSettingRequest: PutKmsiSettingRequest): Promise<PutKmsiSettingResponse>

- Defined in lib/identitydomains/lib/client.ts:19817
Replace KmsiSettings This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PutKmsiSetting API.

Parameters
- putKmsiSettingRequest: PutKmsiSettingRequest
Returns Promise<PutKmsiSettingResponse>

PutKmsiSettingResponse

putMe

putMe(putMeRequest: PutMeRequest): Promise<PutMeResponse>

- Defined in lib/identitydomains/lib/client.ts:19903
Replace a user's own information. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PutMe API.

Parameters
- putMeRequest: PutMeRequest
Returns Promise<PutMeResponse>

PutMeResponse

putMePasswordChanger

putMePasswordChanger(putMePasswordChangerRequest: PutMePasswordChangerRequest): Promise<PutMePasswordChangerResponse>

- Defined in lib/identitydomains/lib/client.ts:19981
Update a user's own password. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PutMePasswordChanger API.

Parameters
- putMePasswordChangerRequest: PutMePasswordChangerRequest
Returns Promise<PutMePasswordChangerResponse>

PutMePasswordChangerResponse

putNetworkPerimeter

putNetworkPerimeter(putNetworkPerimeterRequest: PutNetworkPerimeterRequest): Promise<PutNetworkPerimeterResponse>

- Defined in lib/identitydomains/lib/client.ts:20063
Replace a NetworkPerimeter This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PutNetworkPerimeter API.

Parameters
- putNetworkPerimeterRequest: PutNetworkPerimeterRequest
Returns Promise<PutNetworkPerimeterResponse>

PutNetworkPerimeterResponse

putNotificationSetting

putNotificationSetting(putNotificationSettingRequest: PutNotificationSettingRequest): Promise<PutNotificationSettingResponse>

- Defined in lib/identitydomains/lib/client.ts:20150
Replace Notification Settings This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PutNotificationSetting API.

Parameters
- putNotificationSettingRequest: PutNotificationSettingRequest
Returns Promise<PutNotificationSettingResponse>

PutNotificationSettingResponse

putPasswordPolicy

putPasswordPolicy(putPasswordPolicyRequest: PutPasswordPolicyRequest): Promise<PutPasswordPolicyResponse>

- Defined in lib/identitydomains/lib/client.ts:20237
Replace a password policy. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PutPasswordPolicy API.

Parameters
- putPasswordPolicyRequest: PutPasswordPolicyRequest
Returns Promise<PutPasswordPolicyResponse>

PutPasswordPolicyResponse

putPolicy

putPolicy(putPolicyRequest: PutPolicyRequest): Promise<PutPolicyResponse>

- Defined in lib/identitydomains/lib/client.ts:20324
Replace a Policy This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PutPolicy API.

Parameters
- putPolicyRequest: PutPolicyRequest
Returns Promise<PutPolicyResponse>

PutPolicyResponse

putRule

putRule(putRuleRequest: PutRuleRequest): Promise<PutRuleResponse>

- Defined in lib/identitydomains/lib/client.ts:20410
Replace a Rule This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PutRule API.

Parameters
- putRuleRequest: PutRuleRequest
Returns Promise<PutRuleResponse>

PutRuleResponse

putSchema

putSchema(putSchemaRequest: PutSchemaRequest): Promise<PutSchemaResponse>

- Defined in lib/identitydomains/lib/client.ts:20496
Replace a Schema Def This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PutSchema API.

Parameters
- putSchemaRequest: PutSchemaRequest
Returns Promise<PutSchemaResponse>

PutSchemaResponse

putSecurityQuestionSetting

putSecurityQuestionSetting(putSecurityQuestionSettingRequest: PutSecurityQuestionSettingRequest): Promise<PutSecurityQuestionSettingResponse>

- Defined in lib/identitydomains/lib/client.ts:20579
Replace a security question setting. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PutSecurityQuestionSetting API.

Parameters
- putSecurityQuestionSettingRequest: PutSecurityQuestionSettingRequest
Returns Promise<PutSecurityQuestionSettingResponse>

PutSecurityQuestionSettingResponse

putSelfRegistrationProfile

putSelfRegistrationProfile(putSelfRegistrationProfileRequest: PutSelfRegistrationProfileRequest): Promise<PutSelfRegistrationProfileResponse>

- Defined in lib/identitydomains/lib/client.ts:20666
Replace a self-registration profile. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PutSelfRegistrationProfile API.

Parameters
- putSelfRegistrationProfileRequest: PutSelfRegistrationProfileRequest
Returns Promise<PutSelfRegistrationProfileResponse>

PutSelfRegistrationProfileResponse

putSetting

putSetting(putSettingRequest: PutSettingRequest): Promise<PutSettingResponse>

- Defined in lib/identitydomains/lib/client.ts:20753
Replace Settings This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PutSetting API.

Parameters
- putSettingRequest: PutSettingRequest
Returns Promise<PutSettingResponse>

PutSettingResponse

putUser

putUser(putUserRequest: PutUserRequest): Promise<PutUserResponse>

- Defined in lib/identitydomains/lib/client.ts:20839
Replace a user. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PutUser API.

Parameters
- putUserRequest: PutUserRequest
Returns Promise<PutUserResponse>

PutUserResponse

putUserCapabilitiesChanger

putUserCapabilitiesChanger(putUserCapabilitiesChangerRequest: PutUserCapabilitiesChangerRequest): Promise<PutUserCapabilitiesChangerResponse>

- Defined in lib/identitydomains/lib/client.ts:20925
Change a user's capabilities. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PutUserCapabilitiesChanger API.

Parameters
- putUserCapabilitiesChangerRequest: PutUserCapabilitiesChangerRequest
Returns Promise<PutUserCapabilitiesChangerResponse>

PutUserCapabilitiesChangerResponse

putUserPasswordChanger

putUserPasswordChanger(putUserPasswordChangerRequest: PutUserPasswordChangerRequest): Promise<PutUserPasswordChangerResponse>

- Defined in lib/identitydomains/lib/client.ts:21009
Change a user's password to a known value. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PutUserPasswordChanger API.

Parameters
- putUserPasswordChangerRequest: PutUserPasswordChangerRequest
Returns Promise<PutUserPasswordChangerResponse>

PutUserPasswordChangerResponse

putUserPasswordResetter

putUserPasswordResetter(putUserPasswordResetterRequest: PutUserPasswordResetterRequest): Promise<PutUserPasswordResetterResponse>

- Defined in lib/identitydomains/lib/client.ts:21093
Reset a user's password to a randomly-generated value. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PutUserPasswordResetter API.

Parameters
- putUserPasswordResetterRequest: PutUserPasswordResetterRequest
Returns Promise<PutUserPasswordResetterResponse>

PutUserPasswordResetterResponse

putUserStatusChanger

putUserStatusChanger(putUserStatusChangerRequest: PutUserStatusChangerRequest): Promise<PutUserStatusChangerResponse>

- Defined in lib/identitydomains/lib/client.ts:21177
Change a user's status. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use PutUserStatusChanger API.

Parameters
- putUserStatusChangerRequest: PutUserStatusChangerRequest
Returns Promise<PutUserStatusChangerResponse>

PutUserStatusChangerResponse

searchAccountMgmtInfos

searchAccountMgmtInfos(searchAccountMgmtInfosRequest: SearchAccountMgmtInfosRequest): Promise<SearchAccountMgmtInfosResponse>

- Defined in lib/identitydomains/lib/client.ts:21264
Search Account Mgmt Info Using POST This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchAccountMgmtInfos API.

Parameters
- searchAccountMgmtInfosRequest: SearchAccountMgmtInfosRequest
Returns Promise<SearchAccountMgmtInfosResponse>

SearchAccountMgmtInfosResponse

searchApiKeys

searchApiKeys(searchApiKeysRequest: SearchApiKeysRequest): Promise<SearchApiKeysResponse>

- Defined in lib/identitydomains/lib/client.ts:21348
Search for API keys using POST. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchApiKeys API.

Parameters
- searchApiKeysRequest: SearchApiKeysRequest
Returns Promise<SearchApiKeysResponse>

SearchApiKeysResponse

searchAppRoles

searchAppRoles(searchAppRolesRequest: SearchAppRolesRequest): Promise<SearchAppRolesResponse>

- Defined in lib/identitydomains/lib/client.ts:21431
Search AppRoles Using POST This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchAppRoles API.

Parameters
- searchAppRolesRequest: SearchAppRolesRequest
Returns Promise<SearchAppRolesResponse>

SearchAppRolesResponse

searchApps

searchApps(searchAppsRequest: SearchAppsRequest): Promise<SearchAppsResponse>

- Defined in lib/identitydomains/lib/client.ts:21514
Search Apps Using POST This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchApps API.

Parameters
- searchAppsRequest: SearchAppsRequest
Returns Promise<SearchAppsResponse>

SearchAppsResponse

searchAuthTokens

searchAuthTokens(searchAuthTokensRequest: SearchAuthTokensRequest): Promise<SearchAuthTokensResponse>

- Defined in lib/identitydomains/lib/client.ts:21597
Search for Auth tokens using POST. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchAuthTokens API.

Parameters
- searchAuthTokensRequest: SearchAuthTokensRequest
Returns Promise<SearchAuthTokensResponse>

SearchAuthTokensResponse

searchAuthenticationFactorSettings

searchAuthenticationFactorSettings(searchAuthenticationFactorSettingsRequest: SearchAuthenticationFactorSettingsRequest): Promise<SearchAuthenticationFactorSettingsResponse>

- Defined in lib/identitydomains/lib/client.ts:21680
Search Authentication Factor Settings Using POST This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchAuthenticationFactorSettings API.

Parameters
- searchAuthenticationFactorSettingsRequest: SearchAuthenticationFactorSettingsRequest
Returns Promise<SearchAuthenticationFactorSettingsResponse>

SearchAuthenticationFactorSettingsResponse

searchCloudGateMappings

searchCloudGateMappings(searchCloudGateMappingsRequest: SearchCloudGateMappingsRequest): Promise<SearchCloudGateMappingsResponse>

- Defined in lib/identitydomains/lib/client.ts:21767
Search Cloud Gate mappings Using POST This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchCloudGateMappings API.

Parameters
- searchCloudGateMappingsRequest: SearchCloudGateMappingsRequest
Returns Promise<SearchCloudGateMappingsResponse>

SearchCloudGateMappingsResponse

searchCloudGateServers

searchCloudGateServers(searchCloudGateServersRequest: SearchCloudGateServersRequest): Promise<SearchCloudGateServersResponse>

- Defined in lib/identitydomains/lib/client.ts:21851
Search Cloud Gate servers Using POST This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchCloudGateServers API.

Parameters
- searchCloudGateServersRequest: SearchCloudGateServersRequest
Returns Promise<SearchCloudGateServersResponse>

SearchCloudGateServersResponse

searchCloudGates

searchCloudGates(searchCloudGatesRequest: SearchCloudGatesRequest): Promise<SearchCloudGatesResponse>

- Defined in lib/identitydomains/lib/client.ts:21935
Search Cloud Gates Using POST This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchCloudGates API.

Parameters
- searchCloudGatesRequest: SearchCloudGatesRequest
Returns Promise<SearchCloudGatesResponse>

SearchCloudGatesResponse

searchConditions

searchConditions(searchConditionsRequest: SearchConditionsRequest): Promise<SearchConditionsResponse>

- Defined in lib/identitydomains/lib/client.ts:22018
Search Conditions Using POST This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchConditions API.

Parameters
- searchConditionsRequest: SearchConditionsRequest
Returns Promise<SearchConditionsResponse>

SearchConditionsResponse

searchCustomerSecretKeys

searchCustomerSecretKeys(searchCustomerSecretKeysRequest: SearchCustomerSecretKeysRequest): Promise<SearchCustomerSecretKeysResponse>

- Defined in lib/identitydomains/lib/client.ts:22101
Search for customer secret keys using POST. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchCustomerSecretKeys API.

Parameters
- searchCustomerSecretKeysRequest: SearchCustomerSecretKeysRequest
Returns Promise<SearchCustomerSecretKeysResponse>

SearchCustomerSecretKeysResponse

searchDynamicResourceGroups

searchDynamicResourceGroups(searchDynamicResourceGroupsRequest: SearchDynamicResourceGroupsRequest): Promise<SearchDynamicResourceGroupsResponse>

- Defined in lib/identitydomains/lib/client.ts:22185
Search for Dynamic Resource Groups using POST. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchDynamicResourceGroups API.

Parameters
- searchDynamicResourceGroupsRequest: SearchDynamicResourceGroupsRequest
Returns Promise<SearchDynamicResourceGroupsResponse>

SearchDynamicResourceGroupsResponse

searchGrants

searchGrants(searchGrantsRequest: SearchGrantsRequest): Promise<SearchGrantsResponse>

- Defined in lib/identitydomains/lib/client.ts:22269
Search Grants Using POST This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchGrants API.

Parameters
- searchGrantsRequest: SearchGrantsRequest
Returns Promise<SearchGrantsResponse>

SearchGrantsResponse

searchGroups

searchGroups(searchGroupsRequest: SearchGroupsRequest): Promise<SearchGroupsResponse>

- Defined in lib/identitydomains/lib/client.ts:22352
Search for groups using POST. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchGroups API.

Parameters
- searchGroupsRequest: SearchGroupsRequest
Returns Promise<SearchGroupsResponse>

SearchGroupsResponse

searchIdentityProviders

searchIdentityProviders(searchIdentityProvidersRequest: SearchIdentityProvidersRequest): Promise<SearchIdentityProvidersResponse>

- Defined in lib/identitydomains/lib/client.ts:22435
Search Identity Providers Using POST This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchIdentityProviders API.

Parameters
- searchIdentityProvidersRequest: SearchIdentityProvidersRequest
Returns Promise<SearchIdentityProvidersResponse>

SearchIdentityProvidersResponse

searchIdentitySettings

searchIdentitySettings(searchIdentitySettingsRequest: SearchIdentitySettingsRequest): Promise<SearchIdentitySettingsResponse>

- Defined in lib/identitydomains/lib/client.ts:22519
Search for Identity settings using POST. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchIdentitySettings API.

Parameters
- searchIdentitySettingsRequest: SearchIdentitySettingsRequest
Returns Promise<SearchIdentitySettingsResponse>

SearchIdentitySettingsResponse

searchKmsiSettings

searchKmsiSettings(searchKmsiSettingsRequest: SearchKmsiSettingsRequest): Promise<SearchKmsiSettingsResponse>

- Defined in lib/identitydomains/lib/client.ts:22603
Search KmsiSettings Using POST This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchKmsiSettings API.

Parameters
- searchKmsiSettingsRequest: SearchKmsiSettingsRequest
Returns Promise<SearchKmsiSettingsResponse>

SearchKmsiSettingsResponse

searchMyApps

searchMyApps(searchMyAppsRequest: SearchMyAppsRequest): Promise<SearchMyAppsResponse>

- Defined in lib/identitydomains/lib/client.ts:22687
Search My Apps Using POST This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchMyApps API.

Parameters
- searchMyAppsRequest: SearchMyAppsRequest
Returns Promise<SearchMyAppsResponse>

SearchMyAppsResponse

searchMyGroups

searchMyGroups(searchMyGroupsRequest: SearchMyGroupsRequest): Promise<SearchMyGroupsResponse>

- Defined in lib/identitydomains/lib/client.ts:22770
Search for 'My Groups' using POST. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchMyGroups API.

Parameters
- searchMyGroupsRequest: SearchMyGroupsRequest
Returns Promise<SearchMyGroupsResponse>

SearchMyGroupsResponse

searchMyRequestableGroups

searchMyRequestableGroups(searchMyRequestableGroupsRequest: SearchMyRequestableGroupsRequest): Promise<SearchMyRequestableGroupsResponse>

- Defined in lib/identitydomains/lib/client.ts:22853
Search My Requestable Groups Using POST This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchMyRequestableGroups API.

Parameters
- searchMyRequestableGroupsRequest: SearchMyRequestableGroupsRequest
Returns Promise<SearchMyRequestableGroupsResponse>

SearchMyRequestableGroupsResponse

searchMyRequests

searchMyRequests(searchMyRequestsRequest: SearchMyRequestsRequest): Promise<SearchMyRequestsResponse>

- Defined in lib/identitydomains/lib/client.ts:22937
Search My Requests Using POST This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchMyRequests API.

Parameters
- searchMyRequestsRequest: SearchMyRequestsRequest
Returns Promise<SearchMyRequestsResponse>

SearchMyRequestsResponse

searchNetworkPerimeters

searchNetworkPerimeters(searchNetworkPerimetersRequest: SearchNetworkPerimetersRequest): Promise<SearchNetworkPerimetersResponse>

- Defined in lib/identitydomains/lib/client.ts:23020
Search NetworkPerimeters Using POST This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchNetworkPerimeters API.

Parameters
- searchNetworkPerimetersRequest: SearchNetworkPerimetersRequest
Returns Promise<SearchNetworkPerimetersResponse>

SearchNetworkPerimetersResponse

searchNotificationSettings

searchNotificationSettings(searchNotificationSettingsRequest: SearchNotificationSettingsRequest): Promise<SearchNotificationSettingsResponse>

- Defined in lib/identitydomains/lib/client.ts:23104
Search Notification Settings Using POST This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchNotificationSettings API.

Parameters
- searchNotificationSettingsRequest: SearchNotificationSettingsRequest
Returns Promise<SearchNotificationSettingsResponse>

SearchNotificationSettingsResponse

searchOAuth2ClientCredentials

searchOAuth2ClientCredentials(searchOAuth2ClientCredentialsRequest: SearchOAuth2ClientCredentialsRequest): Promise<SearchOAuth2ClientCredentialsResponse>

- Defined in lib/identitydomains/lib/client.ts:23188
Search for OAuth2 client credentials using POST. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchOAuth2ClientCredentials API.

Parameters
- searchOAuth2ClientCredentialsRequest: SearchOAuth2ClientCredentialsRequest
Returns Promise<SearchOAuth2ClientCredentialsResponse>

SearchOAuth2ClientCredentialsResponse

searchOAuthClientCertificates

searchOAuthClientCertificates(searchOAuthClientCertificatesRequest: SearchOAuthClientCertificatesRequest): Promise<SearchOAuthClientCertificatesResponse>

- Defined in lib/identitydomains/lib/client.ts:23273
Search OAuth Client Certificates Using POST This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchOAuthClientCertificates API.

Parameters
- searchOAuthClientCertificatesRequest: SearchOAuthClientCertificatesRequest
Returns Promise<SearchOAuthClientCertificatesResponse>

SearchOAuthClientCertificatesResponse

searchOAuthPartnerCertificates

searchOAuthPartnerCertificates(searchOAuthPartnerCertificatesRequest: SearchOAuthPartnerCertificatesRequest): Promise<SearchOAuthPartnerCertificatesResponse>

- Defined in lib/identitydomains/lib/client.ts:23358
Search OAuth Partner Certificates Using POST This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchOAuthPartnerCertificates API.

Parameters
- searchOAuthPartnerCertificatesRequest: SearchOAuthPartnerCertificatesRequest
Returns Promise<SearchOAuthPartnerCertificatesResponse>

SearchOAuthPartnerCertificatesResponse

searchPasswordPolicies

searchPasswordPolicies(searchPasswordPoliciesRequest: SearchPasswordPoliciesRequest): Promise<SearchPasswordPoliciesResponse>

- Defined in lib/identitydomains/lib/client.ts:23443
Search for password policies using POST. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchPasswordPolicies API.

Parameters
- searchPasswordPoliciesRequest: SearchPasswordPoliciesRequest
Returns Promise<SearchPasswordPoliciesResponse>

SearchPasswordPoliciesResponse

searchPolicies

searchPolicies(searchPoliciesRequest: SearchPoliciesRequest): Promise<SearchPoliciesResponse>

- Defined in lib/identitydomains/lib/client.ts:23527
Search Policies Using POST This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchPolicies API.

Parameters
- searchPoliciesRequest: SearchPoliciesRequest
Returns Promise<SearchPoliciesResponse>

SearchPoliciesResponse

searchResourceTypeSchemaAttributes

searchResourceTypeSchemaAttributes(searchResourceTypeSchemaAttributesRequest: SearchResourceTypeSchemaAttributesRequest): Promise<SearchResourceTypeSchemaAttributesResponse>

- Defined in lib/identitydomains/lib/client.ts:23610
Search Resource Type Schema Attributes Using POST This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchResourceTypeSchemaAttributes API.

Parameters
- searchResourceTypeSchemaAttributesRequest: SearchResourceTypeSchemaAttributesRequest
Returns Promise<SearchResourceTypeSchemaAttributesResponse>

SearchResourceTypeSchemaAttributesResponse

searchRules

searchRules(searchRulesRequest: SearchRulesRequest): Promise<SearchRulesResponse>

- Defined in lib/identitydomains/lib/client.ts:23697
Search Rules Using POST This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchRules API.

Parameters
- searchRulesRequest: SearchRulesRequest
Returns Promise<SearchRulesResponse>

SearchRulesResponse

searchSchemas

searchSchemas(searchSchemasRequest: SearchSchemasRequest): Promise<SearchSchemasResponse>

- Defined in lib/identitydomains/lib/client.ts:23780
Search Schemas Using POST This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchSchemas API.

Parameters
- searchSchemasRequest: SearchSchemasRequest
Returns Promise<SearchSchemasResponse>

SearchSchemasResponse

searchSecurityQuestionSettings

searchSecurityQuestionSettings(searchSecurityQuestionSettingsRequest: SearchSecurityQuestionSettingsRequest): Promise<SearchSecurityQuestionSettingsResponse>

- Defined in lib/identitydomains/lib/client.ts:23863
Search for security question settings using POST. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchSecurityQuestionSettings API.

Parameters
- searchSecurityQuestionSettingsRequest: SearchSecurityQuestionSettingsRequest
Returns Promise<SearchSecurityQuestionSettingsResponse>

SearchSecurityQuestionSettingsResponse

searchSecurityQuestions

searchSecurityQuestions(searchSecurityQuestionsRequest: SearchSecurityQuestionsRequest): Promise<SearchSecurityQuestionsResponse>

- Defined in lib/identitydomains/lib/client.ts:23948
Search for security questions using POST. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchSecurityQuestions API.

Parameters
- searchSecurityQuestionsRequest: SearchSecurityQuestionsRequest
Returns Promise<SearchSecurityQuestionsResponse>

SearchSecurityQuestionsResponse

searchSelfRegistrationProfiles

searchSelfRegistrationProfiles(searchSelfRegistrationProfilesRequest: SearchSelfRegistrationProfilesRequest): Promise<SearchSelfRegistrationProfilesResponse>

- Defined in lib/identitydomains/lib/client.ts:24032
Search for self-registration profile using POST. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchSelfRegistrationProfiles API.

Parameters
- searchSelfRegistrationProfilesRequest: SearchSelfRegistrationProfilesRequest
Returns Promise<SearchSelfRegistrationProfilesResponse>

SearchSelfRegistrationProfilesResponse

searchSettings

searchSettings(searchSettingsRequest: SearchSettingsRequest): Promise<SearchSettingsResponse>

- Defined in lib/identitydomains/lib/client.ts:24117
Search Settings Using POST This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchSettings API.

Parameters
- searchSettingsRequest: SearchSettingsRequest
Returns Promise<SearchSettingsResponse>

SearchSettingsResponse

searchSmtpCredentials

searchSmtpCredentials(searchSmtpCredentialsRequest: SearchSmtpCredentialsRequest): Promise<SearchSmtpCredentialsResponse>

- Defined in lib/identitydomains/lib/client.ts:24200
Search for SMTP credentials using POST. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchSmtpCredentials API.

Parameters
- searchSmtpCredentialsRequest: SearchSmtpCredentialsRequest
Returns Promise<SearchSmtpCredentialsResponse>

SearchSmtpCredentialsResponse

searchUserAttributesSettings

searchUserAttributesSettings(searchUserAttributesSettingsRequest: SearchUserAttributesSettingsRequest): Promise<SearchUserAttributesSettingsResponse>

- Defined in lib/identitydomains/lib/client.ts:24284
Search User Schema Attribute Settings Using POST This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchUserAttributesSettings API.

Parameters
- searchUserAttributesSettingsRequest: SearchUserAttributesSettingsRequest
Returns Promise<SearchUserAttributesSettingsResponse>

SearchUserAttributesSettingsResponse

searchUserDbCredentials

searchUserDbCredentials(searchUserDbCredentialsRequest: SearchUserDbCredentialsRequest): Promise<SearchUserDbCredentialsResponse>

- Defined in lib/identitydomains/lib/client.ts:24368
Search for a user's database (DB) credentials using POST. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchUserDbCredentials API.

Parameters
- searchUserDbCredentialsRequest: SearchUserDbCredentialsRequest
Returns Promise<SearchUserDbCredentialsResponse>

SearchUserDbCredentialsResponse

searchUsers

searchUsers(searchUsersRequest: SearchUsersRequest): Promise<SearchUsersResponse>

- Defined in lib/identitydomains/lib/client.ts:24452
Search for users using POST. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use SearchUsers API.

Parameters
- searchUsersRequest: SearchUsersRequest
Returns Promise<SearchUsersResponse>

SearchUsersResponse

shutdownCircuitBreaker

shutdownCircuitBreaker(): void

- Defined in lib/identitydomains/lib/client.ts:128
Shutdown the circuit breaker used by the client when it is no longer needed

Returns void

Class IdentityDomainsClient

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

params: common.AuthParams

Optional clientConfiguration: common.ClientConfiguration

Returns IdentityDomainsClient

Properties

Protected _bodyDuplexMode

Protected _circuitBreaker

Protected _clientConfiguration

Protected _defaultHeaders

Protected _endpoint

Protected _httpClient

Protected _httpOptions

Protected _realmSpecificEndpointTemplateEnabled

targetService

Static Protected endpointServiceName

Static Protected serviceEndpointTemplate

Accessors

endpoint

Returns string

Parameters

endpoint: string

Returns void

logger

Returns Logger

useRealmSpecificEndpointTemplate

Parameters

realmSpecificEndpointTemplateEnabled: boolean

Returns void

Methods

close

Returns void

createApiKey

Parameters

createApiKeyRequest: CreateApiKeyRequest

Returns Promise<CreateApiKeyResponse>

createApp

Parameters

createAppRequest: CreateAppRequest

Returns Promise<CreateAppResponse>

createAppRole

Parameters

createAppRoleRequest: CreateAppRoleRequest

Returns Promise<CreateAppRoleResponse>

createApprovalWorkflow

Parameters

createApprovalWorkflowRequest: CreateApprovalWorkflowRequest

Returns Promise<CreateApprovalWorkflowResponse>

createApprovalWorkflowAssignment

Parameters

createApprovalWorkflowAssignmentRequest: CreateApprovalWorkflowAssignmentRequest

Returns Promise<CreateApprovalWorkflowAssignmentResponse>

createApprovalWorkflowStep

Parameters

createApprovalWorkflowStepRequest: CreateApprovalWorkflowStepRequest

Returns Promise<CreateApprovalWorkflowStepResponse>

createAuthToken

Parameters

createAuthTokenRequest: CreateAuthTokenRequest

Returns Promise<CreateAuthTokenResponse>

createAuthenticationFactorsRemover

Parameters

createAuthenticationFactorsRemoverRequest: CreateAuthenticationFactorsRemoverRequest

Returns Promise<CreateAuthenticationFactorsRemoverResponse>

createCloudGate

Parameters

createCloudGateRequest: CreateCloudGateRequest

Returns Promise<CreateCloudGateResponse>

createCloudGateMapping

Parameters

createCloudGateMappingRequest: CreateCloudGateMappingRequest

Returns Promise<CreateCloudGateMappingResponse>

createCloudGateServer