Lire et examiner la documentation Automation Anywhere

Fermer les contenus

Contenus

Ouvrir les contenus

API de gestion du coffre d'accréditation

  • Mis à jour le : 5/10/2019
    • 11.3.x
    • Création
    • Enterprise
    • Docs API

API de gestion du coffre d'accréditation

En tant qu'utilisateur de la Enterprise Control Room disposant des autorisations du rôle Gérer mes informations d'identification et mes consignes, utilisez les API du Credential Vault pour gérer vos informations d'identification, vos attributs et vos consignes, ainsi que le mode Credential Vault dans la Enterprise Control Room.

  1. Les API de gestion des informations d'identification permettent de créer, mettre à jour et supprimer des informations d'identification.
  2. Les API de gestion des attributs des informations d'identification permettent de créer, mettre à jour et supprimer les attributs et les valeurs des informations d'identification.
  3. Les API de gestion des consignes permettent d'ajouter, modifier et supprimer des consignes contenant des consommateurs et des membres.
  4. Les API de gestion du mode Coffre d'accréditation permettent de configurer le mode de connexion qui permet de vous connecter au Credential Vault à l'aide d'une clé principale.
Remarque : Les exemples fournis dans cet article sont présentés pour référence uniquement.

Point de terminaison d'API

Utilisez le point de terminaison suivant pour accéder aux API du Credential Vault : <Enterprise Control Room URL>/v2/credentialvault

Par exemple, https://crdevenv.com:81/v2/credentialvault

API de gestion des informations d'identification

Ces API permettent de gérer vos informations d'identification dans la Enterprise Control Room.

Avant d'accéder aux API du Credential Vault, vous devez d'abord utiliser l'API d'authentification et la transmettre sous forme de jeton afin d'identifier une API donnée du Credential Vault.

  1. À l'aide de la méthode POST, générez un jeton au moyen du point de terminaison http(s)://<hostname:port>/v1/authentication. Pour cela, fournissez l'instance de la Enterprise Control Room à savoir Nom du serveur / Nom d'hôte / IP et numéro de port.

    Par exemple, https://crdevenv.com:81/v1/authentication

  2. Fournissez la charge utile de demande suivante dans les en-têtes :
    "X-Authorization" : "Authorization token" "Content-Type" : "application/json"
  3. Fournissez la charge utile de demande suivante dans le corps :
     { "username": "<Username>", "password": "<Password>" } 
    Par exemple, {

    "usename": "Ellie.Brown",

    "password": "12345678"

    }

1. Créer une information d'identification

Cette API permet de créer une information d'identification.

  1. Indiquez les paramètres « X-Authorization » et « Content Type » dans les en-têtes.
  2. Utilisez la méthode POST pour fournir la charge utile de demande suivante dans le corps :
    { "name": "<Credential Name>", "description": "<Credential Description>","attributes": [ { "name": "<Attribute Name>", "description": "<Attribute Description>", "userProvided": <true or false>, "masked": <true or false> } ] }
    Par exemple, les paramètres suivants créent une information d'identification Connexion SharePoint avec Nom d'utilisateur en tant qu'attribut :
    { "name": "SharePoint Login", "description": "Credentials to login to SharePoint", "attributes": [ { "name": "Username", "description": "Name of the user", "userProvided": true, "masked": true } ] }
  3. Cliquez sur Envoyer.
  4. L'action est réussie lorsque l'état de la réponse est 201 Information d'identification créée.
  5. Vous pouvez afficher la réponse dans les données du corps.
    { "id": "10", "name": "SharePoint Login", "description": "Credentials to login to SharePoint", "ownerId": "1", "attributes": [ { "id": "58", "name": "Username", "description": "Name of the user", "userProvided": true, "masked": true, "createdBy": "1", "createdOn": "2018-07-16T06:04:32.905Z", "updatedBy": "1", "updatedOn": "2018-07-16T06:04:32.905Z", "version": "0" } ], "createdBy": "1", "createdOn": "2018-07-16T06:04:32.905Z", "updatedBy": "1", "updatedOn": "2018-07-16T06:04:32.905Z", "version": "0" }

Description des paramètres

Paramètre Description
name Nom de l'information d'identification dans la première instance et nom de l'attribut dans la deuxième instance
description Description de l'information d'identification dans la première instance et description de la valeur de l'attribut dans la deuxième instance
userProvided Indique si le type d'attribut est fourni par l'utilisateur ou Standard. S'il est fourni par l'utilisateur, le paramètre est affecté de la valeur vrai par défaut. Pour plus d'informations sur les types de valeur d'attribut, consultez Créer une information d'identification.
masked Indique si la valeur d'attribut est masquée. L'attribut a la valeur vrai s'il est chiffré. Pour plus d'informations, voir à Créer une information d'identification.

2. Établir une liste d'informations d'identification

Cette API permet d'afficher toutes les informations d'identification dont l'utilisateur est propriétaire ou pour lesquelles il dispose d'un accès via une consigne. Si l'utilisateur est un administrateur de consigne, toutes les informations d'identification du système sont répertoriées.

  1. Indiquez le paramètre X-Authorization dans les en-têtes.
  2. À l'aide de la méthode GET, accédez aux API des informations d'identification en utilisant les paramètres suivants : http(s)://<hostname:port>/v2/credentialvault/credentials?consumed="<true or false>"&name or names="<filter credentials name(s) separated by comma>"

    Par exemple, la liste suivante répertorie toutes les informations d'identification non consommées :

    https://crdevenv.com:81/v2/credentialvault/credentials?consumed=false

  3. Cliquez sur Envoyer
  4. L'action est réussie lorsque l'état de la réponse est 200 Informations d'identification trouvées.
  5. Vous pouvez afficher la réponse dans les données du corps :
    { "list": [ { "id": 12, "createdBy": 1, "createdOn": "2018-06-25T14:13:58+05:30", "updatedBy": 1, "updatedOn": "2018-06-25T14:13:58+05:30", "tenantId": 1, "version": 0, "name": "SharePoint Login", "description": "-", "lockerId": null, "ownerId": 1, "attributes": [ { "id": 61, "createdBy": 1, "createdOn": "2018-06-25T14:13:58+05:30", "updatedBy": 1, "updatedOn": "2018-06-25T14:13:58+05:30", "tenantId": 1, "version": 0, "name": "Username", "description": "-", "userProvided": true, "masked": true } ], "completed": false }, { "id": 11, "createdBy": 1, "createdOn": "2018-06-21T12:56:07+05:30", "updatedBy": 1, "updatedOn": "2018-06-21T13:00:22+05:30", "tenantId": 1, "version": 1, "name": "SharePoint-User1", "description": "name of the SharePoint user", "lockerId": null, "ownerId": 1, "attributes": [ { "id": 59, "createdBy": 1, "createdOn": "2018-06-21T12:56:07+05:30", "updatedBy": 1, "updatedOn": "2018-06-21T13:00:22+05:30", "tenantId": 1, "version": 1, "name": "SP-User1", "description": "name of the user", "userProvided": true, "masked": false }, { "id": 60, "createdBy": 1, "createdOn": "2018-06-21T13:00:22+05:30", "updatedBy": 1, "updatedOn": "2018-06-21T13:00:22+05:30", "tenantId": 1, "version": 0, "name": "Victor.Hugo", "description": null, "userProvided": true, "masked": false } ], "completed": false ] }

Description des paramètres

Paramètre Description
consumed Filtre les informations d'identification par fait si elles sont fournies par l'utilisateur et consommées par l'utilisateur actuel.
name Filtre les informations d'identification sur un seul nom.
names Filtre les informations d'identification sur une liste de noms séparés par des virgules.

3. Répertorier les informations d'identification par ID

Cette API permet d'afficher les informations d'identification détaillées en fonction du paramètre ID.

Conseil : Vous pouvez déterminer l'ID d'une information d'identification dans la liste des informations d'identification extraites à l'aide de l'API Répertorier les informations d'identification.
  1. Indiquez les paramètres « X-Authorization » et « Content Type » dans les en-têtes.
  2. À l'aide de la méthode GET, accédez aux API des informations d'identification en utilisant les paramètres suivants : http(s)://<hostname:port>/v2/credentialvault/credentials/<id>

    Par exemple, , les paramètres suivants extraient une information d'identification utilisateur dont l'ID est 12 : https://crdevenv.com:81/v2/credentialvault/credentials/12

  3. Cliquez sur Envoyer.

    L'action est réussie lorsque l'état de la réponse est 200. Vous pouvez afficher la réponse dans les données du corps :

    { "id": 12, "createdBy": 1, "createdOn": "2018-06-25T14:13:58+05:30", "updatedBy": 1, "updatedOn": "2018-06-25T14:13:58+05:30", "tenantId": 1, "version": 0, "name": "SharePoint Login", "description": "-", "lockerId": null, "ownerId": 1, "attributes": [ { "id": 61, "createdBy": 1, "createdOn": "2018-06-25T14:13:58+05:30", "updatedBy": 1, "updatedOn": "2018-06-25T14:13:58+05:30", "tenantId": 1, "version": 0, "name": "Username", "description": "-", "userProvided": true, "masked": true } ] }

4. Mettre à jour des informations d'identification

Cette API permet de mettre à jour les informations d'identification existantes.

  1. Indiquez les paramètres « X-Authorization » et « Content Type » dans les en-têtes.
  2. À l'aide de la méthode PUT, accédez aux API des informations d'identification http(s)://<hostname:port>/v2/credentialvault/credentials/<id>

    Par exemple, les paramètres suivants mettent à jour l'information d'identification portant l'ID 12 :https://crdevenv.com:81/v2/credentialvault/credentials/12

  3. Fournissez la charge utile de demande suivante dans le corps :
    { "id": "<Credential id>", "version": <Version id>, "name": "<Credential Name>", "description": "<Credential Description>", "lockerId": null, "ownerId": <the user ID of the owner>, "attributes": [ { "id": <Attribute id>, "version": 0, "name": "<Updated attribute name >", "description": "<Updated attribute description>", "userProvided": <False or true>, - Attribute type "masked": <false or true> masking is true or false } ] } 
    Par exemple, si vous souhaitez mettre à jour la description des informations d'identification, fournissez les paramètres de demande suivants :
    { "id": "12", "version": 0, "name": "SharePoint Login", "description": "Login details for SharePoint", "lockerId": null, "ownerId": <the user ID of the owner>, "attributes": [ { "id": 61, "version": 0, "name": "<Updated attribute name >", "description": "SharePoint Username", "userProvided": <False or true>, - Attribute type "masked": true } ] }
    Conseil : Entrez uniquement les paramètres à mettre à jour sans modifier la valeur des autres.
  4. Cliquez sur Envoyer.
  5. L'action est réussie lorsque l'état de la réponse est 200 Informations d'identification mises à jour.
  6. Vous pouvez afficher la réponse dans les données du corps :
    { "id": 12, "createdBy": 1, "createdOn": "2018-06-25T14:13:58+05:30", "updatedBy": 1, "updatedOn": "2018-06-25T14:13:58+05:30", "tenantId": 1, "version": 0, "name": "SharePoint Login", "description": "Login details for SharePoint", "lockerId": null, "ownerId": 1, "attributes": [ { "id": 61, "createdBy": 1, "createdOn": "2018-06-25T14:13:58+05:30", "updatedBy": 1, "updatedOn": "2018-06-25T14:13:58+05:30", "tenantId": 1, "version": 0, "name": "Username", "description": "SharePoint Username", "userProvided": true, "masked": true } ] }

Description des paramètres

Paramètre Description
id ID d'information identification dans la première instance et ID d'attribut dans la deuxième instance. Il est possible de l'identifier à l'aide de l'API Obtenir les informations d'identification par ID.
version ID de la version mise à jour de l'information d'identification dans la première instance et ID d'attribut dans la deuxième instance. En cas de différence entre la version antérieure et la version actuelle, un message d'erreur s'affiche pour signaler un conflit.
name Information d'identification mise à jour dans la première instance et valeur d'attribut dans la deuxième instance
description Description de l'information d'identification mise à jour la première instance et description de la valeur d'attribut dans la deuxième instance.
lockerId ID de consigne s'il est disponible. S'il n'existe pas d'ID de consigne, la valeur nulle est attribuée par défaut. Il est possible de l'identifier à l'aide de l'API Obtenir les informations d'identification par ID.
ownerId ID d'utilisateur du propriétaire des informations d'identification. Il est possible de l'identifier à l'aide de l'API Obtenir les informations d'identification par ID.
userProvided Indique si le type d'attribut est fourni par l'utilisateur ou Standard. S'il est fourni par l'utilisateur, le paramètre est affecté de la valeur vrai par défaut. Pour plus d'informations sur les types de valeur d'attribut, consultez Créer une information d'identification.
masked Indique si la valeur d'attribut est masquée. L'attribut a la valeur vrai s'il est chiffré. Pour plus d'informations, reportez-vous à Créer une information d'identification.

5. Mettre à jour la propriété des informations d'identification

Cette API permet de mettre à jour la propriété des informations d'identification.

  1. Indiquez le paramètre X-Authorization dans les en-têtes.
  2. À l'aide de la méthode PUT, accédez aux API des informations d'identification

    http(s)://<hostname:port>/v2/credentialvault/credentials/<id>/owner/<credentialOwnerId>

    Par exemple, les paramètres suivants modifient la propriété de l'information d'identification portant l'ID 12 en remplaçant le propriétaire 1 par 2

    https://crdevenv.com:81/v2/credentialvault/credentials/12/owner/2
  3. Cliquez sur Envoyer
  4. L'action est réussie lorsque l'état de la réponse est 200 Propriété des informations d'identification mise à jour .
  5. Vous pouvez afficher la réponse dans les données du corps :

    {

    "id": 12, "createdBy": 1, "createdOn": "2018-06-25T14:13:58+05:30", "updatedBy": 1, "updatedOn": "2018-06-25T14:13:58+05:30", "tenantId": 1, "version": 0, "name": "SharePoint Login", "description": "Login details for SharePoint", "lockerId": null, "ownerId": 1,

    "attributes":

    [

    { "id": 61, "createdBy": 1, "createdOn": "2018-06-25T14:13:58+05:30", "updatedBy": 1, "updatedOn": "2018-06-25T14:13:58+05:30", "tenantId": 1, "version": 0, "name": "Username", "description": "SharePoint Username", "userProvided": true, "masked": true }

    ]

    }

Description des paramètres

Paramètre Description
id ID des informations d'identification. Il est possible de l'identifier à l'aide de l'API Obtenir les informations d'identification par ID.
credentialOwnerId Identifiant du nouveau propriétaire des informations d'identification. Il est possible de l'identifier à l'aide de l'API Obtenir les informations d'identification par ID.

6. Supprimer l'information d'identification

Cette API permet de supprimer l'information d'identification en fonction du paramètre ID fourni.

  1. Indiquez le paramètre X-Authorization dans les en-têtes.
  2. À l'aide de la méthode DELETE, accédez aux API des informations d'identification en utilisant les paramètres suivants :

    http(s)://<hostname:port>/v2/credentialvault/credentials/<id>

    Par exemple, les paramètres suivants suppriment l'information d'identification portant l'ID 11 :

    https://crdevenv.com:81/v2/credentialvault/credentials/11

  3. Cliquez sur Envoyer.

    L'action est réussie lorsque l'état de la réponse est 204 Suppression réussie.

API de gestion des attributs des informations d'identification

En tant qu'utilisateur de la Enterprise Control Room disposant de l'autorisation Afficher et modifier les valeurs d'attribut de toutes les informations d'identification, gérez les attributs des informations d'identification et leurs valeurs à l'aide des API associées dans la Enterprise Control Room. Ces API permettent donc de créer, modifier et supprimer les valeurs d'attribut des informations d'identification créées par l'utilisateur.

Avant d'accéder aux API du Credential Vault, vous devez d'abord utiliser l'API d'authentification et la transmettre sous forme de jeton afin d'identifier une API donnée du Credential Vault.

  1. À l'aide de la méthode POST, générez un jeton au moyen du point de terminaison http(s)://<hostname:port>/v1/authentication. Pour cela, fournissez l'instance de la Enterprise Control Room à savoir Nom du serveur / Nom d'hôte / IP et numéro de port.

    Par exemple,https://crdevenv.com:81/v1/authentication

  2. À l'aide de la méthode POST, accédez aux API des informations d'identification.

    Par exemple, GET https://crdevenv.com:81/v2/credentialvault/credentials

  3. Fournissez la charge utile de demande suivante dans les en-têtes :

    "X-Authorization" : "Authorization token"

    "Content-Type" : "application/json"

1. Créer une valeur d'attribut

Cette API permet de créer la valeur d'attribut d'une information d'identification dont vous indiquez l'ID en tant que paramètre.

  1. Indiquez les paramètres « X-Authorization » et « Content Type » dans les en-têtes.
  2. À l'aide de la méthode POST, accédez aux API des informations d'identification :

    http(s)://<hostname:port>/v2/credentialvault/credentials/<id>/attributevalue

    Par exemple, les paramètres suivants créent un attribut username pour l'ID d'informations d'identification 12

    https://crdevenv.com:81/v2/credentialvault/credentials/12/username

  3. Fournissez la charge utile de demande suivante dans le corps :
    [ { "credentialAttributeId": "<Attribute Id>", "value": "<attribute value>" } ] 

    Par exemple, pour l'information d'identification Connexion SharePoint qui a été créée dans l'exemple précédent et qui porte l'ID 12, et pour l'attribut username portant l'ID 30, vous pouvez ajouter la valeur indiquée :

    [

    {

    "credentialAttributeId": "30",

    "value": "Jane Smith"

    }

    ]

  4. Cliquez sur Envoyer
  5. L'action est réussie lorsque l'état de la réponse est 201 Les valeurs d'attribut des informations d'identification ont été créées.
  6. Vous pouvez afficher la réponse dans les données du corps :

    [

    {

    "id":30,"createdBy":1,"createdOn":"2018-06-27T14:18:13+05:30","updatedBy":1,"updatedOn":"2018-06-27T14:18:13+05:30","tenantId":1,"version":0,"userId":null,"value":"Jane.Smith","credentialAttributeId":62

    }

    ]

Description des paramètres

Paramètre Description
credentialAttributeId Identifiant de l'attribut. Il est possible de l'identifier à l'aide de l'API Obtenir les informations d'identification par ID.
value Valeur d'attribut à saisir.

2. Dresser la liste des valeurs d'attribut des informations d'identification

Cette API permet de répertorier toutes les valeurs standard et celles spécifiées par l'utilisateur pour une information d'identification spécifique.

  1. Indiquez le paramètre X-Authorization dans les en-têtes.
  2. À l'aide de la méthode GET, accédez aux API des informations d'identification en utilisant les paramètres suivants :

    http(s)://<hostname:port>/v2/credentialvault/credentials/<id>/attributevalues

    Par exemple, pour l'information d'identification Connexion SharePoint portant l'ID 12 pour l'attribut username portant l'ID 30, vous pouvez ajouter la valeur indiquée :

    https://crdevenv.com:81/v2/credentialvault/credentials/12/attributevalues

  3. Cliquez sur Envoyer.

    L'action est réussie lorsque l'état de la réponse est 200 Les valeurs d'attribut des informations d'identification ont été trouvées.

  4. Vous pouvez afficher la réponse dans les données du corps :

    { "list":[

    {

    "id": 30, "createdBy": 1, "createdOn": "2018-06-27T14:16:20+05:30", "updatedBy": 1, "updatedOn": "2018-06-27T14:16:20+05:30", "tenantId": 1, "version": 0, "userId": null, "value": "Jane.Smith", "credentialAttributeId" : 62

    }

    ]}

Description des paramètres

Paramètre Description
id ID des informations d'identification. Il est possible de l'identifier à l'aide de l'API Obtenir les informations d'identification par ID.
credentialAttributeId Identifiant de l'attribut. Il est possible de l'identifier à l'aide de l'API Obtenir les informations d'identification par ID.
userId Identifiant de l'utilisateur de la Enterprise Control Room.

3. Mettre à jour la valeur d'attribut d'une information d'identification

Cette API permet de mettre à jour la valeur d'un attribut d'une information d'identification spécifiée.

  1. Indiquez les paramètres « X-Authorization » et « Content Type » dans les en-têtes.
  2. À l'aide de la méthode PUT, accédez aux API des informations d'identification en utilisant les paramètres suivants :

    http(s)://<hostname:port>/v2/credentialvault//credentials/<id>/attributevalues/<attributeValueId>

    Par exemple, pour l'information d'identification Connexion SharePoint portant l'ID 12 et pour l'attribut username portant l'ID 30 vous pouvez mettre à jour la valeur comme indiqué :

    https://crdevenv.com:81/v2/credentialvault/credentials/12/attributevalues/30

  3. Fournissez la charge utile de demande suivante dans le corps :

    [

    {

    "id": "<Attribute value id>", "version": 0, "value" : "<Attribute value>", "credentialAttributeId": "<Attribute ID>"

    }

    ]

  4. Cliquez sur Envoyer.

    L'action est réussie lorsque l'état de la réponse est 200 La valeur d'attribut de l'information d'identification a été mise à jour.

  5. Vous pouvez afficher la réponse dans les données du corps :

    [

    {

    "id":30,"createdBy":1,"createdOn":"2018-06-27T14:47:55+05:30","updatedBy":1,"updatedOn":"2018-06-27T14:47:55+05:30","tenantId":1,"version":0,"userId":null,"value":"","credentialAttributeId":62

    }

    ]

Description des paramètres

Paramètre Description
id Identifiant de la valeur d'attribut. Il est possible de l'identifier à l'aide de l'API Obtenir les informations d'identification par ID.
version Numéro de version de la valeur d'attribut mise à jour.
credentialAttributeId Identifiant de l'attribut. Il est possible de l'identifier à l'aide de l'API Obtenir les informations d'identification par ID.

Supprimer la valeur d'attribut d'une information d'identification

Cette API permet de supprimer la valeur d'attribut d'une information d'identification spécifique.

  1. Indiquez le paramètre X-Authorization dans les en-têtes.
  2. À l'aide de la méthode DELETE, supprimez la valeur d'attribut d'une information d'identification à l'aide des API associées en utilisant les paramètres suivants :

    http(s)://<hostname:port>/v2/credentialvault/credentials/<id>/values/<attributeValueId>

    Par exemple, https://crdevenv.com:81/v2/credentialvault/credentials/12/values/30
  3. Cliquez sur Envoyer
  4. L'action est réussie lorsque l'état de la réponse est 204 Suppression réussie

API de gestion des consignes

En tant qu'administrateur de la Enterprise Control Room disposant de l'autorisation Administrer toutes les consignes ou en tant qu'utilisateur de la Enterprise Control Room disposant de l'autorisation Gérer mes consignes, utilisez les API de gestion des consignes pour créer, mettre à jour et supprimer des consignes, des consommateurs et des membres dans la Enterprise Control Room.

Avant d'accéder à ces API, vous devez d'abord utiliser l'API d'authentification et la transmettre sous forme de jeton afin d'identifier une API particulière du Credential Vault.

  1. À l'aide de la méthode POST, générez un jeton au moyen du point de terminaison http(s)://<hostname:port>/v1/authentication. Pour cela, fournissez l'instance de la Enterprise Control Room à savoir Nom du serveur / Nom d'hôte / IP et numéro de port.

    Par exemple, https://crdevenv.com:81/v1/authentication

  2. À l'aide de la méthode POST, accédez aux API des informations d'identification.

    Par exemple, GET https://crdevenv.com:81/v2/credentialvault/lockers

  3. Fournissez la charge utile de demande suivante dans les en-têtes :

    "X-Authorization" : "Authorization token"

    "Content-Type" : "application/json"

1. Répertorier les consignes

Cette API extrait la liste des consignes dont l'utilisateur connecté est membre (propriétaire, gestionnaire ou participant) ou pour lesquelles il dispose d'une autorisation d'utilisation. Si l'utilisateur est administrateur de consigne, l'API extrait la liste de toutes les consignes du système.

  1. Indiquez le paramètre X-Authorization dans les en-têtes.
  2. À l'aide de la méthode GET, accédez aux API des consignes en utilisant les paramètres suivants :

    http(s)://<hostname:port>/v2/credentialvault/lockers?consumed="<true or false>"

    Par exemple, la liste suivante répertorie les noms de toutes les consignes non consommées:

    https://crdevenv.com:81/v2/credentialvault/lockers?consumed=false

  3. Cliquez sur Envoyer.
  4. L'action est réussie lorsque l'état de la réponse est 200 Consignes trouvées.
  5. Vous pouvez afficher la réponse dans les données du corps :

    { "list":

    [

    {

    "id": 2, "name": "SharePoint Locker", "description": "", "createdBy": 2, "createdOn": "2018-07-04T09:40:49.187Z", "updatedBy": 2, "updatedOn": "2018-07-04T09:41:04.682Z", "tenantId": 1, "version": 1

    },

    {

    "id": 3, "name": "Outlook Locker", "description": "", "createdBy": 2, "createdOn": "2018-07-04T09:47:33.532Z", "updatedBy": 2, "updatedOn": "2018-07-04T09:47:33.532Z", "tenantId": 1, "version": 0

    }

    ]}

Description des paramètres

Paramètre Description
id Identifiant de la consigne.
name Nom de la consigne.
description Description associée à la consigne.
consumed Indique si la consigne est consommée par l'utilisateur connecté. Ce paramètre peut avoir la valeur Vrai ou Faux.

2. Créer une consigne

Cette API permet de créer une consigne.

  1. Indiquez les paramètres « X-Authorization » et « Content Type » dans les en-têtes.
  2. À l'aide de la méthode POST, accédez aux API de consigne : http(s)://<hostname:port>/v2/credentialvault/credentials/<id>/attributevalue
    • Par exemple, les paramètres suivants créent un attribut username pour l'ID d'informations d'identification 12https://crdevenv.com:81/v2/credentialvault/credentials/12/username

  3. Fournissez la charge utile de demande suivante dans le corps :
    { "name":"<Locker name>" , "description":"<Locker description>" }
    • Par exemple, les paramètres suivants créent une consigne "SalesForce" :
      { "name": "SalesForce Locker", "description": "Use this to store all credentials for the SalesForce application" }
  4. Cliquez sur Envoyer.
  5. L'action est réussie lorsque l'état de la réponse est 201 La consigne a été créée.
  6. Vous pouvez afficher la réponse dans les données du corps :
    { "id": 4, "name": "SalesForce Locker", "description": "Use this to store all credentials for the SalesForce application", "createdBy": 2, "createdOn": "2018-07-04T09:55:04.045Z", "updatedBy": 2, "updatedOn": "2018-07-04T09:55:04.045Z", "tenantId": 1, "version": 0 }

Description des paramètres

Paramètre Description
name Nom de la consigne fourni par l'administrateur de consigne
description Description de la consigne

3. Répertorier toutes les consignes comprenant des champs supplémentaires

Cette API extrait la liste des consignes dont l'utilisateur connecté est membre (propriétaire, gestionnaire ou participant) ou pour lesquelles il dispose d'une autorisation d'utilisation. Si l'utilisateur est administrateur de consigne, l'API extrait la liste de toutes les consignes du système. La réponse comprend les membres de la consigne et le nombre d'informations d'identification à l'intérieur de chaque consigne.

  1. Indiquez le paramètre X-Authorization dans les en-têtes.
  2. À l'aide de la méthode GET, accédez aux API des consignes en utilisant les paramètres suivants :

    http(s)://<hostname:port>/v2/credentialvault/lockers/advanced

    • Par exemple, les paramètres suivants répertorient les noms des consignes contenant des champs supplémentaires

      https://crdevenv.com:81/v2/credentialvault/lockers/advanced

  3. Cliquez sur Envoyer
  4. L'action est réussie lorsque l'état de la réponse est 200 Consignes trouvées.
  5. Vous pouvez afficher la réponse dans les données du corps :

    { "list":[

    { "id": 2, "name": "SharePoint Locker", "description": "", "createdBy": 2, "createdOn": "2018-07-04T09:40:49.187Z", "updatedBy": 2, "updatedOn": "2018-07-04T10:10:04.163Z", "tenantId": 1, "version": 2, "members": [ { "id": 1, "permissions": [ "participate", "manage" ] }, { "id": 2, "permissions": [ "participate", "own", "manage" ] } ], "countOfCredentials": 1 },

    { "id": 3, "name": "Outlook Locker", "description": "", "createdBy": 2, "createdOn": "2018-07-04T09:47:33.532Z", "updatedBy": 2, "updatedOn": "2018-07-04T09:47:33.532Z", "tenantId": 1, "version": 0, "members": [ { "id": 2, "permissions": [ "participate", "own", "manage" ] } ], "countOfCredentials": 0 },

    { "id": 4, "name": "SalesForce Locker", "description": "-", "createdBy": 2, "createdOn": "2018-07-04T09:55:04.045Z", "updatedBy": 2, "updatedOn": "2018-07-04T09:55:04.045Z", "tenantId": 1, "version": 0, "members": [ { "id": 2, "permissions": [ "participate", "own", "manage" ] } ], "countOfCredentials": 0 }

    ]}

4. Répertorier les consignes par ID

Cette API vous permet de récupérer les détails des consignes en fonction de leur identifiant.
Conseil : Vous pouvez identifier l'ID d'une consigne dans la liste des consignes extraite à l'aide de l'API Répertorier les consignes.
  1. Indiquez les paramètres « X-Authorization » et « Content Type » dans les en-têtes.
  2. À l'aide de la méthode GET, accédez aux API des informations d'identification en utilisant les paramètres suivants :

    http(s)://<hostname:port>/v2/credentialvault/lockers/<id>

    • Par exemple, les paramètres suivants extraient un consigne portant l'ID 2 :

      https://crdevenv.com:81/v2/credentialvault/lockers/2

  3. Cliquez sur Envoyer.
  4. L'action est réussie lorsque l'état de la réponse est 200 Consigne .
  5. Vous pouvez afficher la réponse dans les données du corps :

    {

    "id": 2, "name": "SharePoint Locker", "description": "", "createdBy": 2, "createdOn": "2018-07-04T09:40:49.187Z", "updatedBy": 2, "updatedOn": "2018-07-04T10:10:04.163Z", "tenantId": 1, "version": 2

    }

5. Mettre à jour la consigne

Cette API permet de mettre à jour les valeurs d'une consigne spécifique.

  1. Indiquez les paramètres « X-Authorization » et « Content Type » dans les en-têtes.
  2. À l'aide de la méthode PUT, accédez aux API des informations d'identification en utilisant les paramètres suivants :

    http(s)://<hostname:port>/v2/credentialvault//lockers/<id>

    • Par exemple, pour la consigne SharePoint Locker portant l'ID 2, vous pouvez mettre à jour la valeur comme indiqué :

      https://crdevenv.com:81/v2/credentialvault/lockers/2

  3. Fournissez la charge utile de demande suivante dans le corps :

    {

    "id": "<locker id>", "name": "<updated lockername>", "description": "<updated description>", "version": 0

    }

  4. Cliquez sur Envoyer
  5. L'action est réussie lorsque l'état de la réponse est 200 La consigne a été mise à jour.
  6. Vous pouvez afficher la réponse dans les données du corps :

    {

    "id": 2, "createdBy": 8, "createdOn": "2018-06-16T10:59:33Z", "updatedBy": 8, "updatedOn": "2018-06-16T10:59:37Z", "version": 1, "name": "SharePoint-Locker", "description": "Locker to manage SharePoint credentials"

    }

Description des paramètres

Paramètre Description
id Identifiant de la consigne. Il est possible de l'identifier à l'aide de l'API Obtenir la consigne par ID.
version Numéro de version de la valeur de consigne mise à jour.
name Nom mis à jour de la consigne.
description Description mise à jour de la consigne.

6. Supprimer la consigne

Cette API permet de supprimer la consigne en fonction du paramètre ID fourni.

  1. Indiquez le paramètre X-Authorization dans les en-têtes.
  2. À l'aide de la méthode DELETE, supprimez les informations d'identification d'une consigne en utilisant les paramètres suivants des API de consigne :

    http(s)://<hostname:port>/v2/credentialvault/lockers/<id>

    • Par exemple, les paramètres suivants suppriment l'information d'identification portant l'ID 4

      https://crdevenv.com:81/v2/credentialvault/lockers/4

  3. Cliquez sur Envoyer
  4. L'action est réussie lorsque l'état de la réponse est 204 Suppression réussie

7. Répertorier tous les consommateurs de consigne

Cette API permet d'extraire la liste des rôles pouvant utiliser les informations d'identification dans la consigne.

  1. Indiquez le paramètre X-Authorization dans les en-têtes.
  2. À l'aide de la méthode GET, accédez aux API des consignes en utilisant les paramètres suivants :

    http(s)://<hostname:port>/v2/credentialvault/lockers/<id>/consumers

    • Par exemple, les paramètres suivants extraient les rôles qui peuvent utiliser les informations d'identification de la consigne portant l'ID 2

      https://crdevenv.com:81/v2/credentialvault/lockers/2/consumers

  3. Cliquez sur Envoyer
  4. L'action est réussie lorsque l'état de la réponse est 204 Réussi
  5. Vous pouvez afficher la réponse dans les données du corps :

    {

    "list":

    [

    { "id": "14" }

    ]

    }

8. Ajouter des consommateurs de consigne

Cette API permet d'ajouter un consommateur à la consigne spécifiée.

  1. Indiquez les paramètres « X-Authorization » et « Content Type » dans les en-têtes.
  2. À l'aide de la méthode PUT, accédez aux API des consignes en utilisant les paramètres suivants :

    http(s)://<hostname:port>/v2/credentialvault/lockers/<id>/consumers

    • Par exemple, les paramètres suivants permettent de vous connecter à la consigne portant l'ID 2 dans laquelle vous voulez ajouter le rôle portant l'ID de consommateur 14

      https://crdevenv.com:81/v2/credentialvault/lockers/2

  3. Fournissez la charge utile de demande suivante dans le corps :

    {

    "id": "<consumer id>"

    }
    • Par exemple :

      {

      "id": 14

      }

  4. Cliquez sur Envoyer
  5. L'action est réussie lorsque l'état de la réponse est 204 Le consommateur de consigne a été créé.

Description des paramètres

Paramètre Description
id Identifiant du consommateur de la consigne. Il est possible de l'identifier à l'aide de l'API Obtenir la consigne par ID.

9. Supprimer des consommateurs de consigne

Cette API permet de supprimer les consommateurs d'une consigne spécifiée.

  1. Indiquez le paramètre X-Authorization dans les en-têtes.
  2. À l'aide de la méthode DELETE, supprimez un consommateur de consigne en utilisant les paramètres suivants des API de consigne :

    http(s)://<hostname:port>/v2/credentialvault/lockers/<lockerId>/consumers/<roleId>

    • Par exemple, les paramètres suivants suppriment l'information d'identification portant l'ID 2

      https://crdevenv.com:81/v2/credentialvault/lockers/2/consumers/14

  3. Cliquez sur Envoyer.
  4. L'action est réussie lorsque l'état de la réponse est 204 Suppression réussie.

10. Répertorier tous les membres d'une consigne

Cette API permet d'extraire la liste de tous les utilisateurs qui peuvent ajouter/supprimer des informations d'identification dans la consigne spécifiée, ou modifier les paramètres de la consigne.

  1. Indiquez le paramètre X-Authorization dans les en-têtes.
  2. À l'aide de la méthode GET, accédez aux API des consignes en utilisant les paramètres suivants :

    http(s)://<hostname:port>/v2/credentialvault/lockers/<lockerId>/members

    • Par exemple, les paramètres suivants extraient les utilisateurs qui peuvent ajouter/supprimer un membre de la consigne portant l'ID 2

      https://crdevenv.com:81/v2/credentialvault/lockers/2/members

  3. Cliquez sur Envoyer
  4. L'action est réussie lorsque l'état de la réponse est 200 Membres de la consigne.
  5. Vous pouvez afficher la réponse dans les données du corps :

    {

    "list":

    [

    {

    "id": 1, "permissions": [ "participate", "manage" ]

    },

    {

    "id": 2, "permissions": [ "participate", "own", "manage" ]

    }

    ]

    }

11. Ajouter ou mettre à jour un membre de consigne

Cette API permet d'ajouter un utilisateur pouvant ajouter/supprimer des informations d'identification dans la consigne, ou modifier les paramètres de la consigne.

  1. Indiquez les paramètres « X-Authorization » et « Content Type » dans les en-têtes.
  2. À l'aide de la méthode PUT, ajoutez/mettez à jour un utilisateur en recourant aux paramètres suivants des API de consigne :

    http(s)://<hostname:port>/v2/credentialvault/lockers/<lockerId>/members/<userId>

    • Par exemple, les paramètres suivants permettent de vous connecter à la consigne portant l'ID 2 dans laquelle vous voulez ajouter l'utilisateur portant l'ID 3

      https://crdevenv.com:81/v2/credentialvault/lockers/2/members/3

  3. Fournissez la charge utile de demande suivante dans le corps :

    {

    "permissions":

    ["permission type"]

    }

    • Par exemple :

      {

      "permissions":

      ["participate", "manage"]

      }

  4. Cliquez sur Envoyer
  5. L'action est réussie lorsque l'état de la réponse est 204 Le membre de la consigne a été créé/mis à jour.

Description des paramètres

Paramètre Description
permissions Autorisation accordée à l'utilisateur. Il peut s'agir des autorisations own (posséder), participe (participer) et/ou manage (gérer).

12. Supprimer un membre d'une consigne

Cette API permet de supprimer des utilisateurs ou des membres d'une consigne spécifiée.

  1. Indiquez le paramètre X-Authorization dans les en-têtes.
  2. À l'aide de la méthode DELETE, supprimez un consommateur de consigne en utilisant les paramètres suivants des API de consigne :

    http(s)://<hostname:port>/v2/credentialvault/lockers/<lockerId>/members/<userId>

    • Par exemple, les paramètres suivants suppriment de la consigne l'utilisateur portant l'ID 3

      https://crdevenv.com:81/v2/credentialvault/lockers/2/members/3

  3. Cliquez sur Envoyer
  4. L'action est réussie lorsque l'état de la réponse est 204 Le membre a été supprimé de la consigne.

13. Ajouter des informations d'identification à une consigne

Cette API permet d'ajouter vos propres informations d'identification à une consigne pour laquelle vous disposez des autorisations de propriétaire, de gestionnaire ou de participant.

  1. Indiquez le paramètre X-Authorization dans les en-têtes.
  2. À l'aide de la méthode PUT, ajoutez des informations d'identification à une consigne en utilisant les paramètres suivants de l'API des informations d'identification :

    http(s)://<hostname:port>/v2/credentialvault/lockers/<lockerId>/credentials/<credentialId>

    • Par exemple, les paramètres suivants ajoutent une information d'identification à la consigne portant l'ID 2https://crdevenv.com:81/v2/credentialvault/lockers/2/credentials/58
  3. Cliquez sur Envoyer
  4. L'action est réussie lorsque l'état de la réponse est 200 L'information d'identification a été ajoutée à la consigne.

14. Répertorier toutes les informations d'identification d'une consigne

Cette API permet d'extraire la liste des informations d'identification d'une consigne pour laquelle vous disposez des autorisations de propriétaire, de gestionnaire ou de participant.

  1. Indiquez le paramètre X-Authorization dans les en-têtes.
  2. À l'aide de la méthode GET, extrayez la liste des informations d'identification en utilisant les paramètres suivants de l'API des informations d'identification :
    http(s)://<hostname:port>/v2/credentialvault/lockers/<lockerId>/credentials/
    • Par exemple, la liste suivante répertorie toutes les informations d'identification ajoutées à la consigne portant l'ID 2

      https://crdevenv.com:81/v2/credentialvault/lockers/2/credentials/

  3. Cliquez sur Envoyer
  4. L'action est réussie lorsque l'état de la réponse est 200 Informations d'identification de la consigne.
  5. Vous pouvez afficher la réponse dans les données du corps :

    { "list": [

    {

    "id": 10, "name": "SharePoint Credentials", "description": "", "completed": false, "lockerId": 2, "ownerId": 2, "attributes":

    [

    {

    "id": 58, "name": "username", "description": "", "userProvided": true, "masked": false, "createdBy": 2, "createdOn": "2018-07-04T10:09:32.854Z", "updatedBy": 2, "updatedOn": "2018-07-04T10:09:32.854Z", "tenantId": 1, "version": 0

    },

    {

    "id": 59, "name": "password", "description": "", "userProvided": true, "masked": true, "createdBy": 2, "createdOn": "2018-07-04T10:09:32.854Z", "updatedBy": 2, "updatedOn": "2018-07-04T10:09:32.854Z", "tenantId": 1, "version": 0

    }

    ],

    "createdBy": 2, "createdOn": "2018-07-04T10:09:32.854Z", "updatedBy": 2, "updatedOn": "2018-07-04T10:10:04.316Z", "tenantId": 1, "version": 1

    }

    ]}

15. Supprimer des informations d'identification d'une consigne

Cette API permet de supprimer des utilisateurs ou des membres d'une consigne spécifiée.

  1. Indiquez le paramètre X-Authorization dans les en-têtes.
  2. À l'aide de la méthode DELETE, supprimez un consommateur de consigne en utilisant les paramètres suivants des API de consigne :

    http(s)://<hostname:port>/v2/credentialvault/lockers/<lockerId>/credentials/<credentialId>

    • Par exemple, les paramètres suivants suppriment l'information d'identification portant l'ID 59 de la consigne portant l'ID 2

      https://crdevenv.com:81/v2/credentialvault/lockers/2/credentials/59

  3. Cliquez sur Envoyer
  4. L'action est réussie lorsque l'état de la réponse est 204 L'information d'identification a été supprimée de la consigne

API de gestion du mode Coffre d'accréditation

En tant qu'administrateur de la Enterprise Control Room disposant de l'autorisation Afficher et gérer les paramètres, utilisez les API de gestion du mode Credential Vault pour gérer le mode Credential Vault de la Enterprise Control Room.

Avant d'accéder à ces API, vous devez d'abord utiliser l'API d'authentification et la transmettre sous forme de jeton afin d'identifier une API particulière du Credential Vault.

  1. À l'aide de la méthode POST, générez un jeton au moyen du point de terminaison http(s)://<hostname:port>/v1/authentication. Pour cela, fournissez l'instance de la Enterprise Control Room à savoir Nom du serveur / Nom d'hôte / IP et numéro de port.

    Par exemple,https://crdevenv.com:81/v1/authentication

  2. À l'aide de la méthode POST, accédez aux API des informations d'identification.

    Par exemple, GET https://crdevenv.com:81/v2/credentialvault/lockers

  3. Fournissez la charge utile de demande suivante dans les en-têtes :

    "X-Authorization" : "Authorization token"

    "Content-Type" : "application/json"

Afficher le mode Coffre d'accréditation actuel

Cette API permet d'afficher le mode en cours d'utilisation pour la connexion au Credential Vault. Il peut s'agir du mode express ou manuel.

  1. Indiquez le paramètre X-Authorization dans les en-têtes.
  2. À l'aide de la méthode GET, accédez aux API du Credential Vault en utilisant les paramètres suivants :
    http(s)://<hostname:port>/v2/credentialvault/mode
    • Par exemple, les paramètres suivants affichent le mode utilisé pour la connexion au Credential Vault :

      https://crdevenv.com:81/v2/credentialvault/mode

  3. Cliquez sur Envoyer/Exécuter
  4. L'action est réussie lorsque l'état de la réponse est 200 Le mode CV a bien été reçu
  5. Vous pouvez afficher la réponse dans les données du corps :

    {

    "name": "Express"

    }

Mettre à jour le mode Coffre d'accréditation

Cette API permet de modifier le mode utilisé pour la connexion au Credential Vault. Il peut s'agir du mode express ou manuel.

  1. Indiquez le paramètre X-Authorization dans les en-têtes.
  2. À l'aide de la méthode PUT, accédez aux API du Credential Vault en utilisant les paramètres suivants :
    http(s)://<hostname:port>/v2/credentialvault/mode
    • Par exemple, les paramètres suivants affichent le mode utilisé pour la connexion au Credential Vault :

      https://crdevenv.com:81/v2/credentialvault/mode

  3. Fournissez la charge utile de demande suivante dans le corps :

    {

    "name": "<mode>",

    "privatekey": "<CV Key>"

    }
    • Par exemple :

      {

      "name": "Manual",

      "privatekey": "ABC123"

      }

  4. Cliquez sur Envoyer/Exécuter.
  5. L'action est réussie lorsque l'état de la réponse est 204 Le mode a été correctement défini

Description des paramètres

Paramètre Description
name Type de connexion - Manuel ou Express. Ce paramètre est spécifié lors de la configuration initiale de la Enterprise Control Room. Reportez-vous aux Enterprise Control RoomParamètres pour mettre à jour ce paramètre depuis l'interface utilisateur de la Enterprise Control Room.
key Clé principale permettant de se connecter au Credential Vault.

Vérifier si la clé principale a été appliquée ou non

Cette API permet de vérifier si la clé principale de la Enterprise Control Room qui permet la connexion au Credential Vault a été appliquée ou non. Utilisez-la pour vérifier l'état du Credential Vault.

  1. Indiquez le paramètre X-Authorization dans les en-têtes.
  2. À l'aide de la méthode GET, accédez aux API du Credential Vault en utilisant les paramètres suivants :
    http(s)://<hostname:port>/v2/credentialvault/keys/private
    • Par exemple :

      https://crdevenv.com:81/v2/credentialvault/keys/private

  3. Cliquez sur Envoyer/Exécuter.
  4. L'action est réussie lorsque l'état de la réponse est 200 État de la clé privée
  5. Vous pouvez afficher la réponse dans les données du corps :

    {

    "applied": true

    }
    Remarque : La valeur false est affichée si la clé privée n'a pas été appliquée.

Appliquer la clé principale pour déverrouiller le coffre d'accréditation après le redémarrage de la Enterprise Control Room en mode manuel

Cette API permet de déverrouiller le Credential Vault après le redémarrage de la Enterprise Control Room en utilisant le mode de connexion manuel. Utilisez-la pour vérifier si le Credential Vault est connecté.

  1. Indiquez le paramètre X-Authorization dans les en-têtes.
  2. À l'aide de la méthode PUT, accédez aux API du Credential Vault en utilisant les paramètres suivants :
    http(s)://<hostname:port>/v2/credentialvault/keys/private
    • Par exemple :

      https://crdevenv.com:81/v2/credentialvault/keys/private

  3. Fournissez la charge utile de demande suivante dans le corps :

    {

    "privateKey": "<CV Key>"

    }

  4. Cliquez sur Envoyer/Exécuter.
  5. L'action est réussie lorsque l'état de la réponse est 200 La clé principale a été correctement appliquée.

Description des paramètres

Paramètre Description
privateKey Clé principale permettant de se connecter au Credential Vault. Ce paramètre est spécifié lors de la configuration initiale de la Enterprise Control Room. Il est également possible de modifier le mode dans les Enterprise Control Room Paramètres en fournissant cette clé.

Codes de réponse de l'API

Code d'état Http(s) Réponse - Description Action corrective
200/204 Action terminée s/o
304 Aucune modification appliquée Mettre à jour si nécessaire.
400 Paramètre de demande non valide Réessayer avec des paramètres valides
401 Authentification requise Fournir des paramètres d'authentification. Par exemple, la clé X-Authorization.
403 Accès non autorisé Vérifier si vous êtes autorisé à accéder à la Enterprise Control Room.
404 Introuvable S'assurer que la charge utile de la demande est disponible dans la Enterprise Control Room.
409 Conflit S'assurer que les paramètres fournis sont corrects.
500 Erreur de serveur interne Vérifiez que le serveur est opérationnel.
501 Erreur d'autorisation Assurez-vous de disposer de l'autorisation requise

Journaux d'audit

Toutes les activités de l'API sont consignées dans la page du journal d'audit de la Enterprise Control Room. En tant qu'administrateur de la Enterprise Control Room ou en tant qu'utilisateur disposant de l'autorisation Afficher les actions du journal d'audit de tout le monde, vous pouvez afficher les entrées d'audit indiquées :

Page du journal d'audit présentant l'activité de l'API capturée

L'illustration suivante présente un exemple de page d'informations d'un journal d'audit permettant de créer une consigne avec l'API associée :

Page d'informations du journal d'audit contenant des données relatives à l'ajout d'une activité de consigne

Envoyer le commentaire