Créer un client API

post

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

Crée un client API avec un ID client et un secret aléatoires et attribue les droits donnés. Le client est configuré avec le type de subvention client_credentials. Vous devez effectuer une opération GET sur l'en-tête d'emplacement renvoyé pour obtenir l'identifiant et le secret du client générés.

Le tableau des droits peut contenir n'importe quelle combinaison de droits.

<détails>Liste des clients de l'APIrésumé>Liste des clients API entitlements:

<.td>CIC, CIV

Entitlement	Description	Offering
manageDeployment	Manage deployment	any
manageCerts	Manage certificates	any
readCerts	Read certificates	any
manageAPIClients	Manage API clients	any
readAPIClients	Read API clients	any
manageIdentitySources	Manage identité providers	any
readIdentitySources	Read identité providers	any
manageMFAMethods	Manage méthode d'authentification à deuxième facteur configuration	CIC
readMFAMethods	Read méthode d'authentification à deuxième facteur configuration	CIC
manageEnrollMFAMethodAnyUser	Manage inscription à l'authentification à deuxième facteur pour tous users	CIV
readEnrollMFAMethodAnyUser	Read inscription à l'authentification à deuxième facteur pour tous inscription à l'authentification à deuxième facteur pour tous inscription à l'authentification à deuxième facteur pour tous factor authentication enrollment for all users	CIV
authnAnyUser	Authenticate any user	CIV
manageAuthenticatorsConfig	Manage authenticator configuration	CIV
readAuthenticatorsConfig	Read authenticator configuration	CIV
manageAuthenticatorsAnyUser	Manage authenticator registrations for all users	CIV
readAuthenticatorsAnyUser	Read authenticator registrations for all users	CIV
manageUserGroups	Manage users and groups	any
readUserGroups	Read users and groups	any
manageAllUserGroups	Synchronize users and groups	any
manageUsersPwdReset	Manage users and their pwdReset attribute	any
manageUserStandardGroups	Manage users and standard groups	any
manageAdminGroup	Manage administrator group	any
readAdminGroup	Read administrateur group	any
managePwdPolicy	Manage mot de passe policy	any
readPwdPolicy	Read mot de passe policy	any
AnalyticsDataSyncToCloud		CIA
AnalyticsSatelliteOnBoard		CIA
manageOIDCGrants	Manage OAuth tokens	any
readOIDCGrants	Read OAuth tokens	any
recoverUsername	Recover utilisateur name	any
manageFederations	Manage fédérations	any
readFederations	Read fédérations	any
resetPassword	Reset mot de passe	any
manageAppAccessAdmin	Manage application lifecycle	any
manageAppAccessOwner	Manage application entitlements	any
manageSubscriptions	Manage subscriptions	ISC
manageAccessPolicies	Manage accès policies	any
readAccessPolicies	Read accès policies	any
managePushCreds	Manage notification push credentials	any
readPushCreds	Read notification push credentials	any
manageAccessRequest	Manage accès request	CIG
manageAccessWorkflow	Manage demande d'accès travail flows	CIG
manageOIDCConsents	Manage OAuth consents	any
readOIDCConsents	Read OAuth consents	any
manageReports	Manage rapports	any. Exception : les rapports d'utilisation des applications ne peuvent être exportés que par CIC.
readReports	Read reports	any. Exception : les rapports d'utilisation des applications ne peuvent être consultés que par CIC.
updateAnyUser	Update tout user	any
resetPasswordAnyUser	Reset mot de passe de tout user	any
readTenantProperties	Read locataire properties	any
manageTenantProperties	Manage locataire properties	any
manageAttributes	Manage attribut sources	any
readAttributes	Read attribut sources	any
generateOTP	Generate OTP	CIV
readAppConfig	Read application configuration	any
manageTemplates	Manage modèles et themes	any
readTemplates	Read modèles et themes	any
reviewCertRecords	Review certification records	CIG
readEntitlements	Read configurable entitlements	any
manageNotificationProviders	Manage notification providers	any
readNotificationProviders	Read notification providers	any
manageCertifications	Manage certifications	CIG
readExternalAgents	Read externe agents	any
manageExternalAgents	Manage externe agents	any
runExternalAgent	Enable agent externe runtime functions	any
manageOidcDynamicClient	Manage OIDC enregistrement du client dynamically	any
readPurpose	Read objectifs de confidentialité et EULA	any
managePurpose	Manage objectifs de confidentialité et EULA	any
manageAppPurpose	Manage confidentialité de l'application purposes	any
readPrivacyConsent	Read confidentialité consents	any
managePrivacyConsent	Manage confidentialité consents	any
readPrivacyPolicy	Read règles de confidentialité et policy	any
managePrivacyPolicy	Manage règles de confidentialité et policy	any
createPrivacyConsent	Create consentement à la confidentialité records	any
performDSP	Retrieve objectifs de confidentialité et consent	any
performDUA	Check de l'utilisateur associé pour l'utilisation des données approval	any
certCampaignSupervisor	Monitor certification campaigns	CIG
managePwdVaultAnyUser	Manage coffre-fort des mots de passe pour tous les utilisateurs<./td>	CIC, CIV
managePwdVault	Manage propre coffre-fort à mot de passe	CIC, CIV
readPwdVaultAnyUser	Read coffre-fort à mot de passe pour tous les utilisateurs	CIC, CIV
readPwdVault	Read propre coffre-fort à mot de passe	CIC, CIV
managePwdVaultConfig	Manage configuration du coffre-fort à mot de passe	CIC, CIV
readPwdVaultConfig	Read configuration du coffre-fort à mot de passe
mfaPush	Send second-factor push notifications	CIV
readPrivacyProfile	Read privacy profiles	any
managePrivacyProfile	Manage privacy profiles	any
manageEntitlements	Manage entitlements	any
manageDevicesAnyUser	Manage devices for all users	any
readDevicesAnyUser	Read devices for all users	any
manageDevices	Manage only your devices	any
readDevices	Read only your devices	any
manageRecaptcha	Manage reCAPTCHA configuration	any
readRecaptcha	Read reCAPTCHA configuration	any
manageLoginSessions	Manage login sessions	any
manageRelyingParty	Manage relying party configuration	any
readRelyingParty	Read relying party configuration	any
manageWebhooks	Manage webhooks	any
readWebhooks	Read webhooks	any
readSTSClients	Read STS clients and token types	any
manageSTSClients	Manage STS clients and token types	any
manageVerifiableLinks	Manage verifiable links configuration	any
readSelfOidcGrants	Read votre OIDC et l'OAuth votre OIDC et l'OAuth votre OIDC et l'OAuth votre OIDC et l'OAuth votre OIDC et l'OAuth OAuth grants	any
manageSelfOidcGrants	Manage votre OIDC et OAuth grants	any
diManageAgency	Manage Agence d'identité décentralisée Configuration	any
diReadAgency	Read Agence d'identité décentralisée Configuration	any
diManageAgentsAny	Manage Identité décentralisée Agents	any
diReadAgentsAny	Read Identité décentralisée Agents	any
manageMyOrg	Manage mon organization	CIG
diIssueCredentials	Issue Identité décentralisée vérifiable Credentials	CIV
diVerifyCredentials	Verify Identité décentralisée vérifiable Credentials	CIV

Entitlements requis : manageAPIClients (Gérer les clients API)

Body Params

clientId

string

l'identifiant unique du client

clientName

string

required

le nom amical du client

clientSecret

string

le secret du client généré pour l'autorisation. S'il n'est pas spécifié, un secret client aléatoire est généré

entitlements

array of strings

required

la liste des droits attribués au client

entitlements*

enabled

boolean

required

si le client peut ou non être utilisé pour générer des jetons

overrideSettings

object

description

string

une description du client

additionalProperties

object

propriétés supplémentaires pour le client

ipFilterOp

string

enum

le fonctionnement du filtre IP. Le paramètre par défaut est null, ce qui signifie que le filtre IP est désactivé

Allowed:

ipFilters

array of strings

la liste des ips

ipFilters

jwkUri

string

le point de terminaison de l'URI de la clé web JSON

additionalConfig

object

Responses

201

Le client API a été créé avec succès.

403

Le jeton d'accès n'autorise pas l'accès à la ressource demandée.

400L'entrée JSON n'était pas valide.

500Erreur de serveur interne.