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 location renvoyé pour obtenir l’ID client et la clé secrète générés.

Le tableau des autorisations peut contenir n’importe quelle combinaison d’autorisations.

Liste des clients API entitlements:

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
readAPIClientsAndClientSecret	Read Clients API avec l’identifiant client secret	any
manageIdentitySources	Manage l’identifiant providers	any
readIdentitySources	Read la méthode d’authentification à deux facteurs providers	any
manageMFAMethods	Manage la méthode d’authentification à deux facteurs configuration	CIC
readMFAMethods	Read l’inscription à l’authentification à deux facteurs configuration	CIC
manageEnrollMFAMethodAnyUser	Manage pour tous users	CIV
readEnrollMFAMethodAnyUser	Read la deuxième-inscription à l’authentification à deux facteurs pour tous users	CIV
authnAnyUser	Authenticate tout user	CIV
manageAuthenticatorsConfig	Manage authentificateur configuration	CIV
readAuthenticatorsConfig	Read authentificateur configuration	CIV
manageAuthenticatorsAnyUser	Manage inscriptions d’authentificateurs pour tous users	CIV
readAuthenticatorsAnyUser	Read inscriptions d’authentificateurs pour tous users	CIV
manageUserGroups	Manage utilisateurs et groups	any
readUserGroups	Read utilisateurs et groups	any
manageAllUserGroups	Synchronize utilisateurs et groups	any
manageUsersPwdReset	Manage utilisateurs et leurs pwdReset attribute	any
manageUserStandardGroups	Manage utilisateurs et standard groups	any
manageAdminGroup	Manage administrateur 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 traitement des demandes d’accès flows	CIG
manageOIDCConsents	Manage OAuth consents	any
readOIDCConsents	Read OAuth consents	any
manageReports	Manage rapports	tout. Exception : les rapports d'utilisation des applications ne peuvent être exportés qu'à partir de la section Rapports d' CIC.
readReports	Read	any. Exception : les rapports d'utilisation de l'application ne sont accessibles qu'à l'adresse CIC.
updateAnyUser	Update; tout mot de passe user	any
resetPasswordAnyUser	Reset de tout locataire user	any
readTenantProperties	Read; locataire properties	any
manageTenantProperties	Manage; attribut properties	any
manageAttributes	Manage; attribut sources	any
readAttributes	Read; sources	any
generateOTP	Generate; OTP	CIV
readAppConfig	Read; application configuration	any
readAppConfigAndClientSecret	Read; configuration de l'application avec le client secret	any
manageTemplates	Manage; modèles themes	any
readTemplates	Read; modèles 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
readExternalAgentsAndClientSecret	Read; agents externes avec le client secret	any
manageExternalAgents	Manage; externe agents	any
runExternalAgent	Enable; exécution de l'agent externe functions	any
manageOidcDynamicClient	Manage; enregistrement du client OIDC dynamically	any
readPurpose	Read; à des fins de confidentialité EULA	any
managePurpose	Manage; à des fins de confidentialité 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é policy	any
managePrivacyPolicy	Manage; règles de confidentialité policy	any
createPrivacyConsent	Create; consentement en matière de confidentialité records	any
performDSP	Retrieve; à des fins 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 de mots de passe pour tous les utilisateurs	CIC, CIV
managePwdVault	Manage coffre-fort de mots de passe personnel	CIC, CIV
readPwdVaultAnyUser	Read coffre-fort de mots de passe pour tous les utilisateurs	CIC, CIV
readPwdVault	Read coffre-fort de mots de passe personnel	CIC, CIV
managePwdVaultConfig	Manage configuration du coffre-fort de mots de passe	CIC, CIV
readPwdVaultConfig	Read configuration du coffre-fort de mots de passe	CIC, CIV
mfaPush	Send -authentification à deux facteurs notifications	CIV
readPrivacyProfile	Read confidentialité profiles	any
managePrivacyProfile	Manage confidentialité profiles	any
manageEntitlements	Manage entitlements	any
manageDevicesAnyUser	Manage appareils pour tous users	any
readDevicesAnyUser	Read appareils pour tous users	any
manageDevices	Manage uniquement votre devices	any
readDevices	Read uniquement votre devices	any
manageRecaptcha	Manage reCAPTCHA configuration	any
readRecaptcha	Read reCAPTCHA configuration	any
manageLoginSessions	Manage connexion sessions	any
manageRelyingParty	Manage partie de confiance configuration	any
readRelyingParty	Read partie de confiance configuration	any
manageWebhooks	Manage webhooks	any
readWebhooks	Read webhooks	any
readSTSClients	Read clients STS et jeton types	any
readSTSClientsAndClientSecret	Read clients STS avec le secret client et le jeton types	any
manageSTSClients	Manage clients STS et jeton types	any
manageVerifiableLinks	Manage liens vérifiables configuration	any
readSelfOidcGrants	Read votre OIDC et 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
createSamlAliases	Create SAML aliases	any
manageMyOrg	Manage mes organization	CIG
readAccessAsManager	View accès de l’ reportees	CIG
manageAccessAsManager	Manage accès de l’ reportees	CIG
diIssueCredentials	Issue Identité décentralisée vérifiable Credentials	CIV
diVerifyCredentials	Verify Identité décentralisée vérifiable Credentials	CIV
readPrivacyConsentProvider	Read consentement providers	CIV
managePrivacyConsentProvider	Manage consentement providers	CIV
readEmailSuppressionList	Read suppression d’e-mails list	CIV
manageEmailSuppressionList	Manage suppression d’e-mails list	CIV
badgeManageSelf	Manage votre badge status	any
badgeManageAny	Manage les configurations du badge pour tenant	any
badgeReadSelf	Read votre badge status	any
badgeReadAny	Read les configurations du badge pour tenant	any
listSessions	List toutes les sessions pour un user	any
revokeAllSessions	Revoke toutes les sessions pour un user	any
revokeSession	Revoke une session pour un user	any
readTraceLogs	Read trace logs	any
manageIAGConfigAny	Manage tout IAG externe configuration	any
readIAGConfigAny	Read tout IAG externe configuration	any
readIAGDeployBundleAny	Export tout IAG externe déployer bundle	any
readSMSProviders	Read SMS providers	CIV
manageSMSProviders	Manage SMS providers	CIV
updateAnyGroupMember	Manage l’adhésion à groups	any
manageIdentityFeed	Manage identité feed	CIG
readIdentityFeed	Read informations sur le flux d’identité	CIG

Autorisations requises : manageAPIClients (Gérer les clients API)

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

clientId

string

l'identifiant unique du client. S'il n'est pas spécifié, un identifiant de client aléatoire est généré. Notez que les identifiants des clients qui ont été supprimés au cours de la dernière heure ne peuvent pas être réutilisés.

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

idTokenSigningAlg

string

Algorithme de signature des jetons d'identification. Liste des algorithmes (id_token_signing_alg_values_supported) disponibles sur /oidc/endpoint/ {definition_id}/.well-known/openid-configuration

accessTokenType

string

enum

Type de jeton d'accès à générer. La valeur par défaut est "default

Allowed:

Responses

201

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

403

Le jeton d'accès ne permet pas d'accéder à la ressource demandée.

Language

URL

Loading…

Response

Choose an example:

*/*

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

500Erreur de serveur interne.