Lea y revise la documentación de Automation Anywhere

Cerrar contenidos

Contenidos

Abrir contenidos

API para administrar la bóveda de credenciales

  • Actualizado: 5/10/2019
    • 11.3.x
    • Crear
    • Enterprise
    • Documentos de API

API para administrar la bóveda de credenciales

Al ser un usuario de Enterprise Control Room con permisos de rol de Administrar mis credenciales y bloqueos, puede utilizar las API de la Bóveda de Credenciales para administrar sus credenciales, atributos, bloqueos y el modo de Bóveda de Credenciales en Enterprise Control Room.

  1. Las API para administrar credenciales se pueden utilizar para crear, actualizar y eliminar credenciales.
  2. Las API para administrar los atributos de credenciales se pueden utilizar para crear, actualizar y eliminar los atributos y valores de credenciales.
  3. Los API para administrar bloqueos se pueden usar para agregar, editar y eliminar bloqueos, incluyendo consumidores y miembros
  4. La API para administrar el modo de la bóveda de credenciales se puede usar para configurar el Modo de conexión, que le permite conectarse a la Bóveda de Credenciales con una clave maestra.
Nota: Los ejemplos que se incluyen en este artículo se presentan únicamente como referencia.

Extremo de API

Puede utilizar el siguiente extremo para acceder a las API de la Bóveda de Credenciales: <Enterprise Control Room URL>/v2/credentialvault

Por ejemplo, https://crdevenv.com:81/v2/credentialvault

API para administrar credenciales

Puede utilizar estas API para administrar sus credenciales en Enterprise Control Room.

Antes de acceder a la API de la Bóveda de Credenciales, debe usar la API de autenticación y pasarla como un token para utilizar una API de la Bóveda de Credenciales en particular.

  1. Utilice el método POST para generar un token con el extremo http(s)://<hostname:port>/v1/authentication. Para esto, ingrese la instancia de Enterprise Control Room como Nombre del servidor/Nombre del host/Dirección IP y el número de Puerto.

    Por ejemplo, https://crdevenv.com:81/v1/authentication

  2. Ingrese la siguiente solicitud de carga útil en los encabezados:
    “X-Authorization” : “Authorization token” “Content-Type” : “application/json”
  3. Ingrese la siguiente solicitud de carga útil en el cuerpo:
     { "username": "<Username>", "password": "<Password>" } 
    Por ejemplo, {

    "usename": "Ellie.Brown",

    "password": "12345678"

    }

1. Crear credencial

Esta API le permite crear una credencial.

  1. Incluya los parámetros "X-Authorization" y "Tipo de contenido" en los encabezados.
  2. Utilice el método POST para ingresar la siguiente carga útil de solicitud en el cuerpo:
    { "name": "<Credential Name>", "description": "<Credential Description>","attributes": [ { "name": "<Attribute Name>", "description": "<Attribute Description>", "userProvided": <true or false>, "masked": <true or false> } ] }
    Por ejemplo, lo siguiente crea una credencial "Inicio de sesión de SharePoint" con "Nombre de usuario" como atributo:
    { "name": "SharePoint Login", "description": "Credentials to login to SharePoint", "attributes": [ { "name": "Username", "description": "Name of the user", "userProvided": true, "masked": true } ] }
  3. Haga clic en Enviar.
  4. La acción se considera correctamente realizada cuando el estado de respuesta es 201 Credencial creada.
  5. Puede ver la respuesta en los datos del cuerpo.
    { "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" }

Descripción de los parámetros

Parámetro Descripción
nombre Nombre de credencial en la primera instancia y Nombre de atributo en la segunda instancia
descripción Descripción de credencial en la primera instancia y Descripción de valor de atributo en la segunda instancia
userProvided Muestra si el tipo de atributo es Proporcionado por el usuario o Estándar. Si es Proporcionado por el usuario, esto se configura como verdadero, que es el parámetro predeterminado. Para conocer los detalles sobre los tipos de valores de atributos, consulte Crear una credencial.
enmascarado Muestra si el valor de atributo está enmascarado. Si está cifrado, esto se establece como verdadero. Para obtener más detalles, consulte Crear una credencial.

2. Lista de credenciales

Esta API le permite ver todas las credenciales en las que un usuario es propietario o tiene acceso a través de un bloqueo. Si el usuario es un administrador de un bloqueo, enumera todas las credenciales presentes en el sistema.

  1. Ingrese el parámetro "X-Authorization" en los encabezados.
  2. Utilice el método GET para acceder a las API de credenciales con los siguientes parámetros: http(s)://<hostname:port>/v2/credentialvault/credentials?consumed="<true or false>"&name or names="<filter credentials name(s) separated by comma>"

    Por ejemplo, este parámetro muestra todas las credenciales no consumidas:

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

  3. Haga clic en Enviar
  4. La acción se considera correctamente realizada cuando el estado de respuesta es 200 Credencial encontrada
  5. Puede ver la respuesta en los datos del cuerpo:
    { "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 ] }

Descripción de los parámetros

Parámetro Descripción
consumido Filtra las credenciales por hecho si la credencial es userProvided y está consumida por el usuario actual.
name Filtra las credenciales por un solo nombre.
nombres Filtra las credenciales por lista de nombres separados por comas.

3. Lista las credenciales por ID

Esta API le permite ver los detalles de las credenciales cuya ID proporcionó como parámetro.

Consejo: Puede identificar los ID de una credencial de la lista de credenciales obtenidas con la API de lista de credenciales.
  1. Incluya los parámetros "X-Authorization" y "Tipo de contenido" en los encabezados.
  2. Utilice el método GET para acceder a las API de credenciales con los siguientes parámetros: http(s)://<hostname:port>/v2/credentialvault/credentials/<id>

    Por ejemplo, el siguiente parámetro obtiene una credencial de usuario que tiene el ID 12: https://crdevenv.com:81/v2/credentialvault/credentials/12

  3. Haga clic en Enviar.

    La acción se considera correctamente realizada cuando el estado de respuesta es 200. Puede ver la respuesta en los datos del cuerpo:

    { "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. Actualizar credenciales

Esta API le permite actualizar las credenciales existentes.

  1. Incluya los parámetros "X-Authorization" y "Tipo de contenido" en los encabezados.
  2. Utilice el método PUT para acceder a las API de credenciales http(s)://<hostname:port>/v2/credentialvault/credentials/<id>

    Por ejemplo, el siguiente parámetro actualiza la credencial con ID 12: https://crdevenv.com:81/v2/credentialvault/credentials/12

  3. Ingrese la siguiente solicitud de carga útil en el cuerpo:
    { "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 } ] } 
    Por ejemplo, si desea actualizar la descripción de credencial, puede ingresar los siguientes parámetros de solicitud:
    { "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 } ] }
    Consejo: Puede ingresar solo los parámetros que desea actualizar y mantener los otros valores de los parámetros intactos; es decir, no realizar ningún cambio.
  4. Haga clic en Enviar.
  5. La acción se considera correctamente realizada cuando el estado de respuesta es 200 Credencial actualizada.
  6. Puede ver la respuesta en los datos del cuerpo:
    { "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 } ] }

Descripción de los parámetros

Parámetro Descripción
ID ID de la credencial en la primera instancia e ID del atributo en la segunda instancia. Esto se puede identificar por medio de la API de obtención de credenciales por ID
versión Versión actualizada del ID de la credencial en la primera instancia y del atributo en la segunda instancia. Si hay alguna discrepancia entre la versión anterior y la actual, se muestra el error de conflicto
nombre Credencial actualizada en la primera instancia y Valor del atributo en la segunda instancia
descripción Descripción de la credencial actualizada en la primera instancia y Descripción del valor de atributo en la segunda instancia
lockerId ID del bloqueo, si está disponible. Si no se proporciona ningún ID de bloqueo, se establece como nulo, que es un valor predeterminado. Esto se puede identificar por medio de la API de obtención de credenciales por ID
ownerId El ID de usuario del propietario de la credencial. Esto se puede identificar por medio de la API de obtención de credenciales por ID
userProvided Muestra si el tipo de atributo es Proporcionado por el usuario o Estándar. Si es Proporcionado por el usuario, esto se configura como verdadero, que es el parámetro predeterminado. Para conocer los detalles sobre los tipos de valor de atributo, consulte Crear una credencial.
enmascarado Muestra si el valor de atributo está enmascarado. Si está cifrado, esto se establece como verdadero. Para obtener más detalles, consulte Crear una credencial.

5. Actualizar propiedad de credenciales

Esta API le permite actualizar la propiedad de la credencial.

  1. Ingrese los parámetros "X-Authorization" en los encabezados.
  2. Utilice el método PUT para acceder a las API de credenciales

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

    Por ejemplo, este parámetro cambia la propiedad de una credencial con el ID 12 del propietario 1 al 2

    https://crdevenv.com:81/v2/credentialvault/credentials/12/owner/2
  3. Haga clic Enviar
  4. La acción se considera correctamente realizada cuando el estado de respuesta es 200 Actualización exitosa de la propiedad de credenciales.
  5. Puede ver la respuesta en los datos del cuerpo:

    {

    "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 }

    ]

    }

Descripción de los parámetros

Parámetro Descripción
ID ID de la credencial. Esto se puede identificar por medio de la API de obtención de credenciales por ID
credentialOwnerId ID del propietario de la nueva credencial. Esto se puede identificar por medio de la API de obtención de credenciales por ID

6. Eliminar credenciales

Esta API le permite eliminar las credenciales cuyo ID ingresó como parámetro

  1. Ingrese los parámetros "X-Authorization" en los encabezados.
  2. Utilice el método DELETE para acceder a las API de credenciales con los siguientes parámetros:

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

    Por ejemplo, el siguiente parámetro elimina la credencial con el ID 11

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

  3. Haga clic Enviar.

    La acción se considera correctamente realizada cuando el estado de respuesta es 204 Eliminación exitosa.

API para administrar los atributos de credenciales

Al ser un usuario de Enterprise Control Room con permiso para Ver y editar el valor de TODOS los atributos de credenciales, puede utilizar las API de atributos de credenciales para administrar los atributos de sus credenciales y sus valores en Enterprise Control Room. Por lo tanto, con esta API, puede crear, editar y eliminar los valores de los atributos de las credenciales creadas por el usuario.

Antes de acceder a la API de la Bóveda de Credenciales, debe usar la API de autenticación y pasarla como un token para utilizar una API de la Bóveda de Credenciales en particular.

  1. Utilice el método POST para generar un token con el extremo http(s)://<hostname:port>/v1/authentication. Para esto, ingrese la instancia de Enterprise Control Room como Nombre del servidor/Nombre del host/Dirección IP y el número de Puerto.

    Por ejemplo,https://crdevenv.com:81/v1/authentication

  2. Utilice el método POST para acceder a las API de credenciales

    Por ejemplo, GET https://crdevenv.com:81/v2/credentialvault/credentials

  3. Ingrese la siguiente solicitud de carga útil en los encabezados

    "X-Authorization": "Authorization token"

    "Content-Type": "application/json"

1. Crear valor de atributo

Esta API le permite crear el valor de atributo de una credencial cuyo ID se proporciona como parámetro

  1. Incluya los parámetros "X-Authorization" y "Tipo de contenido" en los encabezados.
  2. Utilice el método POST para acceder a las API de credenciales:

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

    Por ejemplo, el siguiente parámetro crea un atributo nombre de usuario para el ID de credencial 12

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

  3. Ingrese la solicitud de carga útil en el cuerpo:
    [ { "credentialAttributeId": "<Attribute Id>", "value": "<attribute value>" } ] 

    Por ejemplo, para la credencial "Inicio de sesión de SharePoint" que se creó en el ejemplo anterior con ID "12", para el atributo "nombre de usuario" con ID "30", puede agregar el valor como se muestra:

    [

    {

    "credentialAttributeId": "30",

    "value": "Jane.Smith"

    }

    ]

  4. Haga clic Enviar
  5. La acción se considera correctamente realizada cuando el estado de respuesta es 201 Valores de atributos de credencial creados
  6. Puede ver la respuesta en los datos del cuerpo:

    [

    {

    "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

    }

    ]

Descripción de los parámetros

Parámetro Descripción
credentialAttributeId ID del atributo. Esto se puede identificar por medio de la API de obtención de credenciales por ID
valor Valor de atributo que desea proporcionar

2. Lista de valores de atributos de credenciales

Esta API le permite enumerar todos los valores estándar y especificados por el usuario para una credencial específica.

  1. Ingrese los parámetros "X-Authorization" en los encabezados.
  2. Utilice el método GET para acceder a las API de credenciales con los siguientes parámetros:

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

    Por ejemplo, para la credencial "Inicio de sesión de SharePoint" con ID "12", para el atributo "nombre de usuario" con el ID "30", puede agregar el valor como se muestra:

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

  3. Haga clic Enviar.

    La acción se considera correctamente realizada cuando el estado de respuesta es 200 Valores de atributos de credencial encontrados

  4. Puede ver la respuesta en los datos del cuerpo:

    { "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

    }

    ]}

Descripción de los parámetros

Parámetro Descripción
ID ID de la credencial. Esto se puede identificar por medio de la API de obtención de credenciales por ID
credentialAttributeId ID del atributo. Esto se puede identificar por medio de la API de obtención de credenciales por ID
userId ID del usuario de Enterprise Control Room

3. Actualizar el valor del atributo de credencial

Esta API le permite actualizar el valor de un atributo de la credencial especificada.

  1. Incluya los parámetros "X-Authorization" y "Tipo de contenido" en los encabezados.
  2. Utilice el método PUT para acceder a las API de credenciales con los siguientes parámetros:

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

    Por ejemplo, para la credencial "Inicio de sesión de SharePoint" con ID "12", para el atributo "nombre de usuario" con el ID "30", puede actualizar el valor como se muestra:

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

  3. Ingrese la solicitud de carga útil en el cuerpo:

    [

    {

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

    }

    ]

  4. Haga clic Enviar.

    La acción se considera correctamente realizada cuando el estado de respuesta es 200 Valores de atributos de credencial actualizados.

  5. Puede ver la respuesta en los datos del cuerpo:

    [

    {

    "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

    }

    ]

Descripción de los parámetros

Parámetro Descripción
ID ID del valor de atributo. Esto se puede identificar por medio de la API de obtención de credenciales por ID
versión Número de versión del valor de atributo actualizado
credentialAttributeId ID del atributo. Esto se puede identificar por medio de la API de obtención de credenciales por ID

Eliminar el valor del atributo de credencial

Esta API le permite eliminar el valor del atributo de una credencial específica.

  1. Ingrese los parámetros "X-Authorization" en los encabezados.
  2. Utilice el método DELETE para eliminar el valor del atributo de credencial mediante las API de credencial con los siguientes parámetros:

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

    Por ejemplo, https://crdevenv.com:81/v2/credentialvault/credentials/12/values/30
  3. Haga clic Enviar
  4. La acción se considera correctamente realizada cuando el estado de respuesta es 204 Eliminación exitosa

API para administrar bloqueos

Al ser un administrador de Enterprise Control Room con permiso para Administrar todos los bloqueos o un usuario de Enterprise Control Room con permiso para Administrar el permiso de mis bloqueos, puede utilizar las API de administración de bloqueos para crear, actualizar y eliminar bloqueos, consumidores y miembros en Enterprise Control Room.

Antes de acceder a estas API, debe usar la API de autenticación y pasarla como un token para utilizar una API de la Bóveda de Credenciales en particular.

  1. Utilice el método POST para generar un token con el extremo http(s)://<hostname:port>/v1/authentication. Para esto, ingrese la instancia de Enterprise Control Room como Nombre del servidor/Nombre del host/Dirección IP y el número de Puerto.

    Por ejemplo, https://crdevenv.com:81/v1/authentication

  2. Utilice el método POST para acceder a las API de credenciales

    Por ejemplo, GET https://crdevenv.com:81/v2/credentialvault/lockers

  3. Ingrese la siguiente solicitud de carga útil en los encabezados

    "X-Authorization": "Authorization token"

    “Content-Type” : "application/json"

1. Lista de bloqueos

Esta API recupera la lista de los bloqueos de los cuales el usuario conectado es un miembro (propietario, administrador o participante) o tiene permiso de uso. Si el usuario es administrador del bloqueo, obtiene la lista de todos los bloqueos del sistema.

  1. Ingrese el parámetro "X-Authorization" en los encabezados.
  2. Utilice el método GET para acceder a las API de bloqueos con los siguientes parámetros:

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

    Por ejemplo, este parámetro muestra todos los nombres de bloqueos no consumidos:

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

  3. Haga clic Enviar.
  4. La acción se considera correctamente realizada cuando el estado de respuesta es 200 Bloqueos encontrados
  5. Puede ver la respuesta en los datos del cuerpo:

    { "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

    }

    ]}

Descripción de los parámetros

Parámetro Descripción
ID ID del bloqueo
name Nombre del bloqueo
descripción Descripción proporcionada para el bloqueo
consumido Indica si está consumido por el usuario que inició sesión. Esto puede ser Verdadero o Falso

2. Crear un bloqueo

Esta API le permite crear un bloqueo.

  1. Incluya los parámetros "X-Authorization" y "Tipo de contenido" en los encabezados.
  2. Utilice el método POST para acceder a las API de bloqueos: http(s)://<hostname:port>/v2/credentialvault/credentials/<id>/attributevalue
    • Por ejemplo, el siguiente parámetro crea un atributo nombre de usuario para el ID de credencial 12https://crdevenv.com:81/v2/credentialvault/credentials/12/username

  3. Ingrese la solicitud de carga útil en el cuerpo:
    { "name":"<Locker name>" , "description":"<Locker description>" }
    • Por ejemplo, el siguiente parámetro crea un bloqueo de "SalesForce":
      { "name": "SalesForce Locker", "description": "Use this to store all credentials for the SalesForce application" }
  4. Haga clic en Enviar.
  5. La acción se considera correctamente realizada cuando el estado de respuesta es 201 Bloqueo creado
  6. Puede ver la respuesta en los datos del cuerpo:
    { "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 }

Descripción de los parámetros

Parámetro Descripción
name Nombre del bloqueo proporcionado por el administrador del bloqueo
descripción Descripción del bloqueo

3. Lista de todos los bloqueos con campos adicionales incluidos

Esta API recupera la lista de los bloqueos de los cuales el usuario conectado es un miembro (propietario, administrador o participante) o tiene permiso de uso. Si el usuario es administrador del bloqueo, obtiene la lista de todos los bloqueos del sistema. La respuesta incluye a los miembros del bloqueo y la cantidad de credenciales presentes en cada bloqueo.

  1. Ingrese el parámetro "X-Authorization" en los encabezados.
  2. Utilice el método GET para acceder a las API de bloqueos con los siguientes parámetros:

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

    • Por ejemplo, el siguiente parámetro enumera todos los nombres de bloqueos con campos adicionales

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

  3. Haga clic Enviar
  4. La acción se considera correctamente realizada cuando el estado de respuesta es 200 Bloqueos encontrados
  5. Puede ver la respuesta en los datos del cuerpo:

    { "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, "miembros": [ { "id": 2, "permissions": [ "participate", "own", "manage" ] } ], "countOfCredentials": 0 }

    ]}

4. Enumerar bloqueos por ID

Esta API le permite obtener los detalles del bloqueo en función de su ID.
Consejo: Puede identificar el ID de un bloqueo de la lista de bloqueos obtenidos con la API Enumerar bloqueos.
  1. Incluya los parámetros "X-Authorization" y "Tipo de contenido" en los encabezados.
  2. Utilice el método GET para acceder a las API de credenciales con los siguientes parámetros:

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

    • Por ejemplo, el siguiente parámetro obtiene un bloqueo con el ID 2:

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

  3. Haga clic en Enviar
  4. La acción se considera correctamente realizada cuando el estado de respuesta es 200 Bloqueo.
  5. Puede ver la respuesta en los datos del cuerpo:

    {

    "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. Actualizar bloqueo

Esta API le permite actualizar los valores de un bloqueo específico

  1. Incluya los parámetros "X-Authorization" y "Tipo de contenido" en los encabezados.
  2. Utilice el método PUT para acceder a las API de credenciales con los siguientes parámetros:

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

    • Por ejemplo, para el bloqueo "Bloqueo de SharePoint" con el ID "2", puede actualizar el valor como se muestra:

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

  3. Ingrese la solicitud de carga útil en el cuerpo:

    {

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

    }

  4. Haga clic en Enviar
  5. La acción se considera correctamente realizada cuando el estado de respuesta es 200 Bloqueo actualizado
  6. Puede ver la respuesta en los datos del cuerpo:

    {

    "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"

    }

Descripción de los parámetros

Parámetro Descripción
ID ID del bloqueo. Esto se puede identificar por medio de la API de obtención de bloqueos por ID
versión Número de versión del valor del bloqueo actualizado
nombre Nombre actualizado del bloqueo
descripción Descripción actualizada del bloqueo

6. Eliminar bloqueo

Esta API le permite eliminar los bloqueo cuyo ID proporcionó como parámetro

  1. Ingrese los parámetros "X-Authorization" en los encabezados.
  2. Utilice el método DELETE para eliminar las credenciales de un bloqueo mediante las API del bloqueo con los siguientes parámetros:

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

    • Por ejemplo, el siguiente parámetro elimina la credencial con el ID 4

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

  3. Haga clic Enviar
  4. La acción se considera correctamente realizada cuando el estado de respuesta es 204 Eliminación exitosa

7. Listar todos los consumidores de bloqueos

Esta API le permite obtener la lista de roles que pueden usar credenciales en el bloqueo

  1. Ingrese los parámetros "X-Authorization" en los encabezados.
  2. Utilice el método GET para acceder a las API de bloqueos con los siguientes parámetros:

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

    • Por ejemplo, el siguiente parámetro obtiene los roles que pueden usar credenciales del bloqueo con ID 2

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

  3. Haga clic Enviar
  4. La acción se considera correctamente realizada cuando el estado de respuesta es 204 Exitoso
  5. Puede ver la respuesta en los datos del cuerpo:

    {

    "list":

    [

    { "id": "14" }

    ]

    }

8. Agregar consumidores de bloqueos

Esta API le permite agregar un consumidor al bloqueo especificado

  1. Incluya los parámetros "X-Authorization" y "Tipo de contenido" en los encabezados.
  2. Utilice el método PUT para acceder a las API de bloqueos con los siguientes parámetros:

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

    • Por ejemplo, el siguiente parámetro le permite conectarse al bloqueo con ID 2 en el que desea agregar el rol con ID de consumidor 14

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

  3. Ingrese la solicitud de carga útil en el cuerpo:

    {

    "id": "<consumer id>"

    }
    • Por ejemplo:

      {

      "id": 14

      }

  4. Haga clic en Enviar
  5. La acción se considera correctamente realizada cuando el estado de respuesta es 204 Creación exitosa del consumidor del bloqueo

Descripción de los parámetros

Parámetro Descripción
ID ID del consumidor del bloqueo. Esto se puede identificar por medio de la API de obtención de bloqueos por ID

9. Eliminar los consumidores de bloqueos

Esta API le permite eliminar consumidores del bloqueo especificado

  1. Ingrese los parámetros "X-Authorization" en los encabezados.
  2. Utilice el método DELETE para eliminar el consumidor de un bloqueo mediante las API de bloqueos con los siguientes parámetros:

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

    • Por ejemplo, el siguiente parámetro elimina la credencial con el ID 2

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

  3. Haga clic enviar
  4. La acción se considera correctamente realizada cuando el estado de respuesta es 204 Eliminación exitosa.

10. Listar todos los miembros de bloqueos

Esta API le permite obtener la lista de todos los usuarios que pueden agregar o eliminar credenciales del bloqueo especificado o editar la configuración del bloqueo.

  1. Ingrese los parámetros "X-Authorization" en los encabezados.
  2. Utilice el método GET para acceder a las API de bloqueos con los siguientes parámetros:

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

    • Por ejemplo, el siguiente parámetro obtiene los usuarios que pueden agregar o quitar usuarios del bloqueo con ID 2

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

  3. Haga clic Enviar
  4. La acción se considera correctamente realizada cuando el estado de respuesta es 200 Miembros del bloqueo
  5. Puede ver la respuesta en los datos del cuerpo:

    {

    "list":

    [

    {

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

    },

    {

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

    }

    ]

    }

11. Agregar o actualizar miembros del bloqueo

Esta API le permite agregar un usuario que puede agregar o quitar credenciales del bloqueo o editar la configuración del mismo.

  1. Incluya los parámetros "X-Authorization" y "Tipo de contenido" en los encabezados.
  2. Utilice el método PUT para agregar o actualizar los usuarios mediante las API de bloqueos con los siguientes parámetros:

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

    • Por ejemplo, el siguiente parámetro le permite conectarse al bloqueo con ID 2 en el que desea agregar el usuario con ID de miembro 3

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

  3. Ingrese la solicitud de carga útil en el cuerpo:

    {

    "permissions":

    ["permission type"]

    }

    • Por ejemplo:

      {

      "permissions":

      ["participate", "manage"]

      }

  4. Haga clic en Enviar
  5. La acción se considera correctamente realizada cuando el estado de la respuesta es 204 Creación/Actualización exitosa del miembro del bloqueo

Descripción de los parámetros

Parámetro Descripción
permisos Permiso que se concede al usuario. El permiso puede ser de propietario, participante y/o administrador.

12. Eliminar miembro de un bloqueo

Esta API le permite eliminar usuarios o miembros de los bloqueos especificados

  1. Ingrese los parámetros "X-Authorization" en los encabezados.
  2. Utilice el método DELETE para eliminar el consumidor de un bloqueo mediante las API de bloqueos con los siguientes parámetros:

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

    • Por ejemplo, el siguiente parámetro elimina el usuario del bloqueo con el ID 3

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

  3. Haga clic Enviar
  4. La acción se considera correctamente realizada cuando el estado de respuesta es 204 Eliminación exitosa del miembro del bloqueo

13. Agregar credencial a un bloqueo

Esta API le permite agregar su propia credencial a un bloqueo donde tiene permisos de propietario, administrador o participante.

  1. Ingrese los parámetros "X-Authorization" en los encabezados.
  2. Utilice el método PUT para agregar credenciales a un bloqueo mediante la API de credenciales con los siguientes parámetros:

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

    • Por ejemplo, el siguiente parámetro agrega una credencial al bloqueo con ID 2https://crdevenv.com:81/v2/credentialvault/lockers/2/credentials/58
  3. Haga clic Enviar
  4. La acción se considera correctamente realizada cuando el estado de respuesta es 200 Se agregó la credencial al bloqueo.

14. Listar todas las credenciales de bloqueos

Esta API le permite obtener la lista de credenciales ubicadas en un bloqueo para el que tiene permisos de propietario, administrador o participante.

  1. Ingrese los parámetros "X-Authorization" en los encabezados.
  2. Utilice el método GET para obtener la lista de credenciales mediante la API de credenciales con los siguientes parámetros:
    http(s)://<hostname:port>/v2/credentialvault/lockers/<lockerId>/credentials/
    • Por ejemplo, el siguiente parámetro enumera todas las credenciales que se agregan al bloqueo con ID 2

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

  3. Haga clic Enviar
  4. La acción se considera correctamente realizada cuando el estado de respuesta es 200 Credenciales de bloqueos
  5. Puede ver la respuesta en los datos del cuerpo:

    { "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. Quitar credencial de un bloqueo

Esta API le permite eliminar usuarios o miembros de los bloqueos especificados

  1. Ingrese los parámetros "X-Authorization" en los encabezados.
  2. Utilice el método DELETE para eliminar el consumidor de un bloqueo mediante las API de bloqueos con los siguientes parámetros:

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

    • Por ejemplo, el siguiente parámetro elimina la credencial con ID 59 del bloqueo con ID 2

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

  3. Haga clic Enviar
  4. La acción se considera correctamente realizada cuando el estado de respuesta es 204 Se quitó la credencial del bloqueo

API para administrar el modo de la bóveda de credenciales

Al ser un administrador de Enterprise Control Room con permisos de Ver y administrar configuración, puede utilizar las API del modo Administrar Bóveda de Credenciales para administrar el modo Bóveda de Credenciales de Enterprise Control Room.

Antes de acceder a estas API, debe usar la API de autenticación y pasarla como un token para utilizar una API de la Bóveda de Credenciales en particular.

  1. Utilice el método POST para generar un token con el extremo http(s)://<hostname:port>/v1/authentication. Para esto, ingrese la instancia de Enterprise Control Room como Nombre del servidor/Nombre del host/Dirección IP y el número de Puerto.

    Por ejemplo,https://crdevenv.com:81/v1/authentication

  2. Utilice el método POST para acceder a las API de credenciales

    Por ejemplo, GET https://crdevenv.com:81/v2/credentialvault/lockers

  3. Ingrese la siguiente solicitud de carga útil en los encabezados

    "X-Authorization": "Authorization token"

    “Content-Type” : "application/json"

Ver el modo actual de la bóveda de credenciales

Esta API le permite ver el modo actual utilizado para conectarse a la Bóveda de Credenciales. Este puede ser "Express" o "Manual"

  1. Ingrese los parámetros "X-Authorization" en los encabezados.
  2. Utilice el método GET para acceder a las API de la Bóveda de Credenciales mediante los siguientes parámetros:
    http(s)://<hostname:port>/v2/credentialvault/mode
    • Por ejemplo, el siguiente parámetro muestra el modo actual utilizado para conectarse a la Bóveda de Credenciales:

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

  3. Haga clic en Enviar/Ejecutar
  4. La acción se considera correctamente realizada cuando el estado de respuesta es 200 El modo CV se recibió exitosamente
  5. Puede ver la respuesta en los datos del cuerpo:

    {

    "name": "Express"

    }

Actualizar el modo de la Bóveda de Credenciales

Esta API le permite cambiar el modo actual utilizado para conectarse a la Bóveda de Credenciales. Este puede ser "Express" o "Manual"

  1. Ingrese los parámetros "X-Authorization" en los encabezados.
  2. Utilice el método PUT para acceder a las API de la Bóveda de Credenciales mediante los siguientes parámetros:
    http(s)://<hostname:port>/v2/credentialvault/mode
    • Por ejemplo, el siguiente parámetro muestra el modo actual utilizado para conectarse a la Bóveda de Credenciales:

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

  3. Ingrese la solicitud de carga útil en el cuerpo:

    {

    "name": "<mode>",

    "privatekey": "<CV Key>"

    }
    • Por ejemplo:

      {

      "name": "Manual",

      "privatekey": "ABC123"

      }

  4. Haga clic en Enviar/Ejecutar
  5. La acción se considera correctamente realizada cuando el estado de respuesta es 204 El modo se definió exitosamente

Descripción de los parámetros

Parámetro Descripción
name Tipo de conexión - Manual o Express. Esto se especifica durante la configuración inicial de Enterprise Control Room. Consulte Configuración de Enterprise Control Room para actualizar esto desde la interfaz de usuario de Enterprise Control Room.
clave La clave maestra que se utiliza para conectarse a la Bóveda de Credenciales.

Revise si la clave maestra se aplicó o no

Esta API le permite verificar si la clave maestra de Enterprise Control Room que se conecta con la Bóveda de Credenciales se aplicó o no. Puede utilizarla para revisar el estado de la Bóveda de Credenciales.

  1. Ingrese los parámetros "X-Authorization" en los encabezados.
  2. Utilice el método GET para acceder a las API de la Bóveda de Credenciales mediante los siguientes parámetros:
    http(s)://<hostname:port>/v2/credentialvault/keys/private
    • Por ejemplo:

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

  3. Haga clic en Enviar/Ejecutar
  4. La acción se considera correctamente realizada cuando el estado de respuesta es 200 Estado de clave privada
  5. Puede ver la respuesta en los datos del cuerpo:

    {

    "applied": true

    }
    Nota: Se muestra el valor false si no se aplicó la clave privada.

Aplique la clave maestra para desbloquear la bóveda de credenciales después de reiniciar Enterprise Control Room en modo Manual

Esta API le permite desbloquear la Bóveda de Credenciales después de reiniciar Enterprise Control Room mediante el modo Manual de conexión. Puede utilizarla para verificar si la Bóveda de Credenciales está conectada.

  1. Ingrese los parámetros "X-Authorization" en los encabezados.
  2. Utilice el método PUT para acceder a las API de la Bóveda de Credenciales mediante los siguientes parámetros:
    http(s)://<hostname:port>/v2/credentialvault/keys/private
    • Por ejemplo:

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

  3. Ingrese la solicitud de carga útil en el cuerpo:

    {

    "privateKey": "<CV Key>"

    }

  4. Haga clic en Enviar/Ejecutar
  5. La acción se considera correctamente realizada cuando el estado de respuesta es 200 La clave privada se aplicó exitosamente

Descripción de los parámetros

Parámetro Descripción
privateKey La clave maestra que se utiliza para conectarse a la Bóveda de Credenciales. Esto se especifica durante la configuración inicial de Enterprise Control Room. También puede cambiar el modo de Configuración de Enterprise Control Room al proporcionar esta clave.

Códigos de respuesta de API

Código de estado HTTP(s) Respuesta - Descripción Acción correctiva
200/204 Acción completada correctamente No aplica
304 No se aplicaron cambios Actualizar según sea necesario
400 Parámetro de solicitud incorrecto Vuelva a intentarlo con parámetros válidos
401 Autenticación requerida Proporcionar parámetros de autenticación. Por ejemplo, clave X-Authorization
403 Acceso no autorizado Asegúrese de estar autorizado para acceder a Enterprise Control Room
404 No se encontró Asegúrese de que la solicitud de carga útil esté disponible en Enterprise Control Room
409 Conflicto Asegúrese de que los parámetros proporcionados sean correctos
500 Error de servidor interno Asegúrese de que el servidor esté en funcionamiento
501 Error de permisos Asegúrese de tener los permisos necesarios

Registros de auditoría

Todas las actividades de la API se registran en la página de Registro de auditoría de Enterprise Control Room. Al ser un administrador de Enterprise Control Room o un usuario con permisos para Ver las acciones del registro de auditoría de todos, puede ver las entradas de auditoría como se muestra:

Página de registro de auditoría con actividad de API capturada

La siguiente ilustración muestra una página de detalles del registro de auditoría para crear un bloqueo con la API de Bloqueo:

Página de detalles del registro de auditoría con información sobre cómo agregar una actividad de bloqueo

Enviar comentarios