Create an API Client

post

https://{tenanturl}/v1.0/apiclients

Creates an API client with a random client ID and secret and assigns the given entitlements. The client is configured with the client_credentials grant type. You must perform a GET operation on the returned location header to get the generated client ID and secret.

The entitlements array can contain any combination of entitlements.

List of API Client entitlements:

EntitlementDescriptionOfferingmanageDeploymentManage deploymentanymanageCertsManage certificatesanyreadCertsRead certificatesanymanageAPIClientsManage API clientsanyreadAPIClientsRead API clientsanyreadAPIClientsAndClientSecretRead API clients with the client secretanymanageIdentitySourcesManage identity providersanyreadIdentitySourcesRead identity providersanymanageMFAMethodsManage second-factor authentication method configurationCICreadMFAMethodsRead second-factor authentication method configurationCICmanageEnrollMFAMethodAnyUserManage second-factor authentication enrollment for all usersCIVreadEnrollMFAMethodAnyUserRead second-factor authentication enrollment for all usersCIVauthnAnyUserAuthenticate any userCIVmanageAuthenticatorsConfigManage authenticator configurationCIVreadAuthenticatorsConfigRead authenticator configurationCIVmanageAuthenticatorsAnyUserManage authenticator registrations for all usersCIVreadAuthenticatorsAnyUserRead authenticator registrations for all usersCIVmanageUserGroupsManage users and groupsanyreadUserGroupsRead users and groupsanymanageAllUserGroupsSynchronize users and groupsanymanageUsersPwdResetManage users and their pwdReset attributeanymanageUserStandardGroupsManage users and standard groupsanymanageAdminGroupManage administrator groupanyreadAdminGroupRead administrator groupanymanagePwdPolicyManage password policyanyreadPwdPolicyRead password policyanyAnalyticsDataSyncToCloudCIAAnalyticsSatelliteOnBoardCIAmanageOIDCGrantsManage OAuth tokensanyreadOIDCGrantsRead OAuth tokensanyrecoverUsernameRecover user nameanymanageFederationsManage federations anyreadFederationsRead federations anyresetPasswordReset password anymanageAppAccessAdminManage application lifecycleanymanageAppAccessOwnerManage application entitlementsanymanageSubscriptionsManage subscriptionsISCmanageAccessPoliciesManage access policiesanyreadAccessPoliciesRead access policiesanymanagePushCredsManage Push notification credentialsanyreadPushCredsRead Push notification credentialsanymanageAccessRequestManage access requestCIGmanageAccessWorkflowManage access request work flowsCIGmanageOIDCConsentsManage OAuth consentsanyreadOIDCConsentsRead OAuth consentsanymanageReportsManage reportsany. Exception: application usage reports can only be exported by CIC.readReportsRead reportsany. Exception: application usage reports can only be accessed by CIC.updateAnyUserUpdate any useranyresetPasswordAnyUserReset password of any useranyreadTenantPropertiesRead tenant propertiesanymanageTenantPropertiesManage tenant propertiesanymanageAttributesManage attribute sourcesanyreadAttributesRead attribute sourcesanygenerateOTPGenerate OTPCIVreadAppConfigRead application configurationanyreadAppConfigAndClientSecretRead application configuration with the client secretanymanageTemplatesManage templates and themesanyreadTemplatesRead templates and themesanyreviewCertRecordsReview certification recordsCIGreadEntitlementsRead configurable entitlementsanymanageNotificationProvidersManage notification providersanyreadNotificationProvidersRead notification providersanymanageCertificationsManage certificationsCIGreadExternalAgentsRead external agentsanyreadExternalAgentsAndClientSecretRead external agents with the client secretanymanageExternalAgentsManage external agentsanyrunExternalAgentEnable external agent runtime functionsanymanageOidcDynamicClientManage OIDC client registration dynamicallyanyreadPurposeRead privacy purposes and EULAanymanagePurposeManage privacy purposes and EULAanymanageAppPurposeManage application privacy purposesanyreadPrivacyConsentRead privacy consentsanymanagePrivacyConsentManage privacy consentsanyreadPrivacyPolicyRead privacy rules and policyanymanagePrivacyPolicyManage privacy rules and policyanycreatePrivacyConsentCreate privacy consent recordsanyperformDSPRetrieve privacy purposes and associated user's consentanyperformDUACheck for data usage approvalanycertCampaignSupervisorMonitor certification campaignsCIGmanagePwdVaultAnyUserManage password vault for all usersCIC, CIVmanagePwdVaultManage own password vaultCIC, CIVreadPwdVaultAnyUserRead password vault for all usersCIC, CIVreadPwdVaultRead own password vaultCIC, CIVmanagePwdVaultConfigManage password vault configurationCIC, CIVreadPwdVaultConfigRead password vault configurationCIC, CIVmfaPushSend second-factor push notificationsCIVreadPrivacyProfileRead privacy profilesanymanagePrivacyProfileManage privacy profilesanymanageEntitlementsManage entitlementsanymanageDevicesAnyUserManage devices for all usersanyreadDevicesAnyUserRead devices for all usersanymanageDevicesManage only your devicesanyreadDevicesRead only your devicesanymanageRecaptchaManage reCAPTCHA configurationanyreadRecaptchaRead reCAPTCHA configurationanymanageLoginSessionsManage login sessionsanymanageRelyingPartyManage relying party configurationanyreadRelyingPartyRead relying party configurationanymanageWebhooksManage webhooks anyreadWebhooksRead webhooks anyreadSTSClientsRead STS clients and token typesanyreadSTSClientsAndClientSecretRead STS clients with the client secret and token typesanymanageSTSClientsManage STS clients and token typesanymanageVerifiableLinksManage verifiable links configurationanyreadSelfOidcGrantsRead your OIDC and OAuth grantsanymanageSelfOidcGrantsManage your OIDC and OAuth grantsanydiManageAgencyManage Decentralized Identity Agency ConfigurationanydiReadAgencyRead Decentralized Identity Agency ConfigurationanydiManageAgentsAnyManage Decentralized Identity AgentsanydiReadAgentsAnyRead Decentralized Identity AgentsanycreateSamlAliasesCreate SAML aliasesanymanageMyOrgManage my organizationCIGreadAccessAsManagerView accesses of the reporteesCIGmanageAccessAsManagerManage accesses of the reporteesCIGdiIssueCredentialsIssue Decentralized Identity Verifiable CredentialsCIVdiVerifyCredentialsVerify Decentralized Identity Verifiable CredentialsCIVreadPrivacyConsentProviderRead consent providersCIVmanagePrivacyConsentProviderManage consent providersCIVreadEmailSuppressionListRead email suppression listCIVmanageEmailSuppressionListManage email suppression listCIVbadgeManageSelfManage your badge statusanybadgeManageAnyManage the badge configurations for the tenantanybadgeReadSelfRead your badge statusanybadgeReadAnyRead the badge configurations for the tenantanylistSessionsList all sessions for a useranyrevokeAllSessionsRevoke all sessions for a useranyrevokeSessionRevoke a session for a useranyreadTraceLogsRead trace logsanymanageIAGConfigAnyManage any external IAG configurationanyreadIAGConfigAnyRead any external IAG configurationanyreadIAGDeployBundleAnyExport any external IAG deploy bundleanyreadSMSProvidersRead SMS providersCIVmanageSMSProvidersManage SMS providersCIVupdateAnyGroupMemberManage the membership of groupsanymanageIdentityFeedManage identity feedCIGreadIdentityFeedRead identity feed informationCIG

Entitlements required: manageAPIClients (Manage API clients)

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

clientId

string

the unique identifier of the client. If unspecified, a random client ID is generated. Note that client ID of clients that have been deleted within the last 1 hour cannot be reused.

clientName

string

required

the friendly name of the client

clientSecret

string

the generated client secret for authorization. If unspecified, a random client secret is generated

entitlements

array of strings

required

the list of entitlements assigned to the client

entitlements*

enabled

boolean

required

whether or not the client can be used to generate tokens

overrideSettings

object

description

string

a description of the client

additionalProperties

object

additional properties for the client

ipFilterOp

string

enum

the operation of the ip filter. The default setting is null, which means that the ip filter is disabled

Allowed:

ipFilters

array of strings

the list of ips

ipFilters

jwkUri

string

the JSON web key URI endpoint

additionalConfig

object

idTokenSigningAlg

string

ID token signing algorithm. List of algorithms (id_token_signing_alg_values_supported) available at /oidc/endpoint/{definition_id}/.well-known/openid-configuration

accessTokenType

string

enum

Type of access token to be generated. Default is 'default'

Allowed:

Responses

201

The API client was created successfully.

403

The access token does not allow access to the requested resource.

400The JSON input was invalid.

500Internal server error.