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:

EntitlementDescriptionOfferingmanageDeploymentManage deploymentanymanageCertsManage certificatesanyreadCertsRead certificatesanymanageAPIClientsManage API clientsanyreadAPIClientsRead API clientsanymanageIdentitySourcesManage identité providersanyreadIdentitySourcesRead identité providersanymanageMFAMethodsManage méthode d'authentification à deuxième facteur configurationCICreadMFAMethodsRead méthode d'authentification à deuxième facteur configurationCICmanageEnrollMFAMethodAnyUserManage inscription à l'authentification à deuxième facteur pour tous usersCIVreadEnrollMFAMethodAnyUserRead 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 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 administrateur groupanymanagePwdPolicyManage mot de passe policyanyreadPwdPolicyRead mot de passe policyanyAnalyticsDataSyncToCloudCIAAnalyticsSatelliteOnBoardCIAmanageOIDCGrantsManage OAuth tokensanyreadOIDCGrantsRead OAuth tokensanyrecoverUsernameRecover utilisateur nameanymanageFederationsManage fédérations anyreadFederationsRead fédérations anyresetPasswordReset mot de passe anymanageAppAccessAdminManage application lifecycleanymanageAppAccessOwnerManage application entitlementsanymanageSubscriptionsManage subscriptionsISCmanageAccessPoliciesManage accès policiesanyreadAccessPoliciesRead accès policiesanymanagePushCredsManage notification push credentialsanyreadPushCredsRead notification push credentialsanymanageAccessRequestManage accès requestCIGmanageAccessWorkflowManage demande d'accès travail flowsCIGmanageOIDCConsentsManage OAuth consentsanyreadOIDCConsentsRead OAuth consentsanymanageReportsManage rapportsany. Exception : les rapports d'utilisation des applications ne peuvent être exportés que par CIC.readReportsRead reportsany. Exception : les rapports d'utilisation des applications ne peuvent être consultés que par CIC.updateAnyUserUpdate tout useranyresetPasswordAnyUserReset mot de passe de tout useranyreadTenantPropertiesRead locataire propertiesanymanageTenantPropertiesManage locataire propertiesanymanageAttributesManage attribut sourcesanyreadAttributesRead attribut sourcesanygenerateOTPGenerate OTPCIVreadAppConfigRead application configurationanymanageTemplatesManage modèles et themesanyreadTemplatesRead modèles et themesanyreviewCertRecordsReview certification recordsCIGreadEntitlementsRead configurable entitlementsanymanageNotificationProvidersManage notification providersanyreadNotificationProvidersRead notification providersanymanageCertificationsManage certificationsCIGreadExternalAgentsRead externe agentsanymanageExternalAgentsManage externe agentsanyrunExternalAgentEnable agent externe runtime functionsanymanageOidcDynamicClientManage OIDC enregistrement du client dynamicallyanyreadPurposeRead objectifs de confidentialité et EULAanymanagePurposeManage objectifs de confidentialité et EULAanymanageAppPurposeManage confidentialité de l'application purposesanyreadPrivacyConsentRead confidentialité consentsanymanagePrivacyConsentManage confidentialité consentsanyreadPrivacyPolicyRead règles de confidentialité et policyanymanagePrivacyPolicyManage règles de confidentialité et policyanycreatePrivacyConsentCreate consentement à la confidentialité recordsanyperformDSPRetrieve objectifs de confidentialité et consentanyperformDUACheck de l'utilisateur associé pour l'utilisation des données approvalanycertCampaignSupervisorMonitor certification campaignsCIGmanagePwdVaultAnyUserManage coffre-fort des mots de passe pour tous les utilisateurs<./td>CIC, CIVmanagePwdVaultManage propre coffre-fort à mot de passeCIC, CIVreadPwdVaultAnyUserRead coffre-fort à mot de passe pour tous les utilisateursCIC, CIVreadPwdVaultRead propre coffre-fort à mot de passeCIC, CIVmanagePwdVaultConfigManage configuration du coffre-fort à mot de passeCIC, CIVreadPwdVaultConfigRead configuration du coffre-fort à mot de passe<.td>CIC, 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 typesanymanageSTSClientsManage STS clients and token typesanymanageVerifiableLinksManage verifiable links configurationanyreadSelfOidcGrantsRead 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 grantsanymanageSelfOidcGrantsManage votre OIDC et OAuth grantsanydiManageAgencyManage Agence d'identité décentralisée ConfigurationanydiReadAgencyRead Agence d'identité décentralisée ConfigurationanydiManageAgentsAnyManage Identité décentralisée AgentsanydiReadAgentsAnyRead Identité décentralisée AgentsanymanageMyOrgManage mon organizationCIGdiIssueCredentialsIssue Identité décentralisée vérifiable CredentialsCIVdiVerifyCredentialsVerify Identité décentralisée vérifiable CredentialsCIV

Entitlements requis : 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

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.