provision/user

Utilice este recurso para realizar consultas simples y consultas de suministro de usuarios y de anulación de suministro de usuarios. El usuario debe ser un administrador de cuentas.

Resumen del método

Método HTTP Vía de acceso Descripción
GET /scr/api/provision/user/ Recupera detalles de una cuenta de usuario concreta y lista todos los usuarios de la cuenta como una matriz JSON.
PUT /scr/api/provision/user/ Añade un usuario o actualiza la pertenencia del usuario en grupos.
SUPRIMIR /scr/api/provision/user/ Archiva cada usuario individualmente, elimina un usuario de todos los grupos o elimina un usuario de uno o más grupos especificados.

GET/scr/api/provision/user/

Descripción

Utilice este método para recuperar detalles de una cuenta de usuario concreta y listar todos los usuarios de la cuenta en una matriz JSON.

El servicio de suministro de usuarios proporciona las siguientes formas de un método de consulta:
  • El URI base se comporta como un URI de recopilación y recupera una lista de usuarios de la cuenta como una matriz JSON.
  • El URI base con la dirección de correo electrónico del usuario se comporta como un URI de elemento y recupera detalles específicos sobre la cuenta especificada por la dirección de correo electrónico.
Información de recursos
Requisitos Descripción
Formato de la respuesta JSON
Requiere autenticación Sí. El usuario debe ser un administrador de cuentas.
Permite credenciales de cliente de OAuth 2 Sí utilizando un ID de servicio de usuario que contiene la categoría de gestión de usuarios
Velocidad limitada Aún no
Parámetros
Nombre Ubicación Descripción Obligatorio Tipo
version Cabecera La versión de la API solicitada es 1.0. Sí Serie
Respuesta
Entrada de ejemplo
Liste (LIST) todos los usuarios de la cuenta: /scr/api/provision/user/
  • Utilizando las credenciales de cliente OAuth 2:
    curl -i -H "Authorization: Bearer access_token" 
    -H "Version:1.0" "https://your_server_url/scr/api/provision/user"
Obtenga (GET) los detalles de un usuario específico: /scr/api/provision/user/email_address
Importante: El parámetro email_address debe estar correctamente codificado.
  • Utilizando las credenciales de cliente OAuth 2:
    curl -i -H "Authorization: Bearer access_token" 
    -H "Version:1.0" "https://your_server_url/scr/api/provision/user/user_id%40us.ibm.com"
Resultado de ejemplo
Liste (LIST) todos los usuarios de la cuenta:
HTTP/1.1 200 OK
{
  "users":["admin@us.ibm.com",
  "user_id@us.ibm.com","test@us.ibm.com"]
}
Obtenga (GET) los detalles de un usuario específico:
HTTP/1.1 200 OK 
Content-Length: 108 
{
  "fullname": "John Smith",
  "username": "john.smith4@acme.com",
  "license": "VIEWER",
  "businessunit": { 
      "name": "Shipping",
      "id": "150007"
  },
  "admin": false,
  "active": true,
}
Propiedades de respuesta
username
Dirección de correo electrónico del usuario suministrado.
fullname
Nombre completo del usuario suministrado. El valor por omisión es una serie de caracteres vacía.
license
Nivel de licencia del usuario suministrado. El valor predeterminado es: EDITOR
admin
El valor es true si el usuario es un administrador. De lo contrario, el valor es false.
active
El valor es true si el usuario está activo. De lo contrario, el valor es false.
businessunit
Departamento, división, grupo de trabajo o área funcional en los que trabaja el usuario.
usergroups
Lista de grupos de los que forma parte el usuario. Esta propiedad se devuelve sólo si el usuario forma parte de al menos un grupo.
usergroups.groupname
Nombre de un grupo del que forma parte el usuario.
Mensajes de respuesta
Código HTTP Razón
200 con carga útil JSON

La solicitud se ha completado correctamente.
400 con carga útil JSON

Se ha producido un error al procesar la solicitud. Faltaban algunos parámetros obligatorios o contenían valores no válidos.
401

El usuario no está autorizado a realizar la petición.
403
El acceso está prohibido. Este mensaje puede aparecer por una de las razones siguientes:
  • Las credenciales especificadas no son válidas.
  • Este usuario no es un editor para este proceso.
  • El administrador no ha habilitado las API. Las API se deben habilitar en la pestaña Información de la cuenta.
  • El administrador no ha aceptado los Términos y condiciones del servicio.
404 No se ha encontrado el usuario GET especificado.

PUT /scr/api/provision/user/

Descripción
Utilice este método para añadir un usuario y actualizar la pertenencia del usuario en grupos.
  • El URI base se comporta como un método add. Con el método add, cuando se añade un usuario archivado anteriormente, la cuenta de ese usuario se reactiva.
  • El URI base con el nombre de usuario se comporta como un método de actualización. El método update se utiliza para actualizar la pertenencia del usuario a uno o varios grupos. Si el nombre de usuario no existe, se crea un usuario con los atributos predeterminados que se muestran a continuación.
Información de recursos
Requisitos Descripción
Formato de la respuesta JSON
Requiere autenticación Sí. El usuario debe ser un administrador de cuentas.
Permite credenciales de cliente de OAuth 2 Sí utilizando un ID de servicio de usuario que contiene la categoría de gestión de usuarios
Velocidad limitada Aún no
Parámetros
Nombre Ubicación Descripción Obligatorio Tipo
content-type Cabecera El valor debe ser application/json. Sí Serie
version Cabecera La versión de la API solicitada es 1.0. Sí Serie
JSON Request admin Cuerpo JSON El valor del parámetro, true o false, indica si el usuario suministrado debe ser un administrador. El valor predeterminado es false. Sí Booleano
JSON Request fullname Cuerpo JSON Nombre completo del usuario que se va a suministrar. Si no se proporciona ninguno se utiliza un nombre completo vacío. Sí Serie
JSON Request license Cuerpo JSON Nivel de licencia del usuario. Los valores posibles son VIEWER, COMMUNITY, CONTRIBUTORo EDITOR. La licencia se ha establecido en el nivel EDITOR predeterminado si no se proporciona ninguna. Sí Serie
JSON Request username Cuerpo JSON La dirección de correo electrónico del usuario que se va a suministrar. Sí, al añadir un nuevo usuario. Serie
JSON Request usergroups Cuerpo JSON Matriz JSON de nombres de grupo. Añade usuario a la lista de usergroups (grupos de usuarios). El usuario no se añade a los grupos si la lista está vacía. Sí, para actualizar. Matriz JSON de series
businessunitid Cuerpo JSON ID de una unidad de negocio existente. La unidad de negocio ya debe existir. Nee Serie
businessunitname Cuerpo JSON Nombre de una unidad de negocio. Si ya existe una unidad de negocio con este nombre, se utiliza. De lo contrario, se crea una nueva unidad de negocio .

Puede especificar businessunitid o businessunitname. Si se proporcionan ambos, businessunitid tiene prioridad.

 Nee Serie
Respuesta
Entrada de ejemplo

Suministre un usuario específico: /scr/api/provision/user/

Suministre un usuario sólo con el parámetro username necesario en el cuerpo JSON:
  • Utilizando las credenciales de cliente OAuth 2:
    curl -i -H "Authorization: Bearer access_token" -H "Version:1.0" -H "Content-Type:application/json" 
    -X PUT --data "{\"username\":\"user1@us.ibm.com\"}" "https://your_server_url/scr/api/provision/user/"

Suministre un usuario con todos los parámetros en el cuerpo JSON:

curl -i -H "Authorization: Bearer access_token" -H "Version:1.0" -H "Content-Type:application/json" 
    -X PUT --data "{\"username\":\"john.smith@us.ibm.com\",\"fullname\":\"John Smith\",\"license\":\"EDITOR\",\"admin\":true,
    \"usergroups\":[{\"groupname\":\"group1\"},{\"groupname\":\"group2\"}]}" "https://your_server_url/scr/api/provision/user/"

Añadir un usuario existente a un grupo: /scr/api/provision/user/email_address

Importante: El parámetro email_address debe estar correctamente codificado.

Añada un usuario a grupos:

curl -i -H "Authorization: Bearer access_token" -H "Version:1.0" -H "Content-Type:application/json" -X PUT 
    --data "{\"usergroups\":[{\"groupname\":\"group1\"},{\"groupname\":\"group2\"}]}" "https://your_server_url/scr/api/provision/user/user1%40us.ibm.com"

Añada un usuario a un grupo no válido:

curl -i -H "Authorization: Bearer access_token" -H "Version:1.0" -H "Content-Type:application/json" -X PUT 
    --data "{\"usergroups\":[{\"groupname\":\"invalid\"}]}" "https://your_server_url/scr/api/provision/user/user1%40us.ibm.com"

Añada un nuevo usuario y asocie el usuario con una unidad de negocio existente utilizando un ID de unidad de negocio:

curl -i -H "Authorization: Bearer access_token" -H "Version:1.0" -H "Content-Type:application/json" -X PUT
    --data "{\"username\":\"john.smith4@acme.com\",\"fullname\":\"John Smith\",\"license\":\"VIEWER\",\"admin\":false, \"businessunitid\":\"150007\"}" 
    "https://your_server_url/scr/api/provision/user/user1%40us.ibm.com"

Añada un nuevo usuario y asocie el usuario con una unidad de negocio utilizando un nombre de unidad de negocio:

curl -i -H "Authorization: Bearer access_token" -H "Version:1.0" -H "Content-Type:application/json" -X PUT 
    --data "{\"username\":\"john.smith4@acme.com\",\"fullname\":\"John Smith\",\"license\":\"VIEWER\",\"admin\":false, \"businessunitname\":\"Shipping\"}"
    "https://your_server_url/scr/api/provision/user/user1%40us.ibm.com"
Adición de varios usuarios

Se utiliza un script MS-DOS de muestra para practicar con la solicitud PUT varias veces con valores de un archivo CSV. El script correlaciona la señal con cada columna en el archivo CSV. También se puede utilizar un script más sólido mediante Perl, Python u otro lenguaje.

            for /f "tokens=1,2,3,4,5,6* delims=," %%a in (usersdetail.csv) do curl -i -H "Authorization: Bearer access_token" 
            -H "Version:1.0" -H "Content-Type:application/json" -X PUT --data 
            "{\"username\":\"%%a\", \"fullname\":\"%%b\",\"license\":\"%%c\",\"admin\":%%d,\"usergroups\":[{\"groupname\":\"%%e\"},{\"groupname\":\"%%f\"}]}" 
            "http://localhost:8080/scr/api/provision/user/"
usersdetail.csv está entonces en el mismo directorio que el script de proceso por lotes con el siguiente contenido de ejemplo:
           abc@ibm.com,john smith,editor,true, groupA, groupB
           bac@ibm.com,smith john,community,false,group1, groupB
Nota: La señal se correlaciona manualmente con las columnas del archivo CSV; por lo tanto, es mejor si todos los usuarios suministrados pertenecen al mismo número de grupos.
Resultado de ejemplo

Suministre un usuario sólo con el parámetro username necesario en el cuerpo JSON:

HTTP/1.1 200 OK 
Content-Length: 107
{"username":"user1@us.ibm.com","fullname":"","license":"EDITOR","admin":false,"active":true}

Suministre un usuario con todos los parámetros en el cuerpo JSON:

HTTP/1.1 200 OK 
Content-Length: 155
{"username":"john.smith@us.ibm.com","fullname":"John Smith","license":"EDITOR","admin":true,"active":true, 
"usergroups":[{"groupname":"group1"},{"groupname":"group2"}]}

Añada un usuario duplicado:

HTTP/1.1 400 Bad Request  
Content-Length: 71
{"message":"The provided username is already a member of this account"}

Añada un usuario a grupos:

HTTP/1.1 200 
OK Content-Length: 107
{"username":"user1@us.ibm.com","fullname":"User One","license":"EDITOR","admin":true,"active":true, "usergroups":[{"groupname":"group1"},{"groupname":"group2"}]}

Añada un usuario a un grupo no válido:

HTTP/1.1 400 Bad Request 
Content-Length: 79
{"message":"One of the provided groupname is either archived or is not valid."}
Propiedades de respuesta
username
Dirección de correo electrónico del usuario suministrado.
fullname
Nombre completo del usuario suministrado. El valor por omisión es una serie de caracteres vacía.
license
Nivel de licencia del usuario suministrado. El valor predeterminado es EDITOR.
admin
El valor es true si el usuario es un administrador. De lo contrario, el valor es false.
active
El valor es true si el usuario está activo. De lo contrario, el valor es false.
usergroups
Lista de grupos de los que forma parte el usuario. Esto se devuelve sólo si el usuario forma parte de al menos un grupo.
usergroups.groupname
Nombre del grupo del que forma parte el usuario.
Mensajes de respuesta
Código HTTP Razón
200 con carga útil JSON

La solicitud se ha completado correctamente.
400 Se ha producido un error al procesar la solicitud. Compruebe el elemento de mensaje JSON para obtener más detalles. Este mensaje puede aparecer por una de las razones siguientes:
  • El usuario especificado ya existe.
  • Hay un problema con el formato o la licencia.
.
401

El usuario no está autorizado a realizar la petición.
403
El acceso está prohibido. Este mensaje puede aparecer por una de las razones siguientes:
  • Las credenciales especificadas no son válidas.
  • Este usuario no es un editor para este proceso.
  • El administrador no ha habilitado las API. Las API se deben habilitar en la pestaña Información de la cuenta.
  • El administrador no ha aceptado los Términos y condiciones del servicio.
404 No se ha encontrado el usuario especificado.

Suprimir /scr/api/provision/user/

Descripción
Utilice este método para archivar cada usuario individualmente, para eliminar un usuario de todos los grupos o para eliminar un usuario de uno o más grupos especificados. El servicio de archivado de usuarios proporciona un único formulario del método DELETE y por lo tanto no hay soporte para recopilaciones. Este método se puede llamar varias veces para suprimir varios usuarios.
Información de recursos
Requisitos Descripción
Formato de la respuesta JSON
Requiere autenticación Sí. El usuario debe ser un administrador de cuentas.
Permite credenciales de cliente de OAuth 2 Sí utilizando un ID de servicio de usuario que contiene la categoría de gestión de usuarios
Velocidad limitada Aún no
Parámetros
Nombre Ubicación Descripción Obligatorio Tipo
version Cabecera La versión de la API solicitada es 1.0. Sí Serie
groups/group-id Vía de acceso Identificador del grupo del que se debe eliminar el usuario. Utilice comas para separar varios grupos. Para eliminar el usuario de todos los grupos, utilice /groups. Nee Serie
Respuesta
Entrada de ejemplo
Importante: El parámetro email_address debe estar correctamente codificado.

Suprima un usuario específico en la cuenta: /scr/api/provision/user/email_address

  • Utilizando las credenciales de cliente OAuth 2:
    curl -i -H "Authorization: Bearer access_token" -H "Version:1.0"
     -X DELETE "https://your_server_url/scr/api/provision/user/user1%40domain.com"

Elimine un usuario de todos los grupos: /scr/api/provision/user/email_address/groups

  • Utilizando las credenciales de cliente OAuth 2:
    curl -i -H "Authorization: Bearer access_token" -H "Version:1.0"
    -X DELETE "https://your_server_url/scr/api/provision/user/user1%40domain.com/groups"

Elimine un usuario de grupos especificados basándose en los ID de grupo. Si hay más de un grupo, separe los ID de grupo con comas. /scr/api/provision/user/email_address/groups/group_ID

  • Utilizando las credenciales de cliente OAuth 2:
    curl -i -H "Authorization: Bearer access_token" -H "Version:1.0"
    -X DELETE "https://your_server_url/scr/api/provision/user/user1%40domain.com/groups/1310f8,180001"
Resultado de ejemplo

Suprima un usuario:

HTTP/1.1 200 OK  
Content-Length: 21
{"message":"Success"}

Suprima un usuario no existente:

HTTP/1.1 404 Not Found
Content-Length: 0

Elimine un usuario de los grupos especificados:

HTTP/1.1 200 OK  
Content-Length: 21
{"message":"Success"}
Propiedades de respuesta
Ninguna
Mensajes de respuesta
Código HTTP Razón
200 con carga útil JSON

La solicitud se ha completado correctamente.
400 Se ha producido un error al procesar la solicitud. Compruebe el elemento de mensaje JSON para obtener más detalles. Este mensaje puede aparecer por una de las razones siguientes:
  • El ID de grupo no es válido o no se puede encontrar el grupo.
  • El usuario no pertenece al grupo.
  • El usuario tiene permisos para Gestionar y Editar para el grupo y no se puede eliminar.
401

El usuario no está autorizado a realizar la petición.
403
El acceso está prohibido. Este mensaje puede aparecer por una de las razones siguientes:
  • Las credenciales especificadas no son válidas.
  • Este usuario no es un editor para este proceso.
  • El administrador no ha habilitado las API. Las API se deben habilitar en la pestaña Información de la cuenta.
  • El administrador no ha aceptado los Términos y condiciones del servicio.
404 No se ha encontrado el usuario solicitado.