Usuarios Punto final

Resumen

Aunque las acciones CRUD de los usuarios se gestionan ahora en la API Frontdoor de Apptio, los administradores de Cloudability aún pueden recuperar una lista de sus usuarios y actualizar las vistas predeterminadas de los usuarios, así como ver las acciones a través de la API Users de Cloudability V3. Para utilizar este endpoint debe tener el UserManagementFeatureFullAccess permiso.

Este documento define la API para obtener/actualizar usuarios en Cloudability.
El punto final de todos los usuarios recupera todos los usuarios en función de los filtros, la paginación y los parámetros de ordenación proporcionados.
Todos los puntos finales devuelven datos utilizando un esquema de objetos de usuario unificado.
Todos los puntos finales requieren un token de portador válido para la autenticación.

Datos del punto final

Base URL :

https://api.cloudability.com/v3

Autenticación

Todos los terminales necesitan un token de portador válido.

Cabecera	Obligatorio	Descripción
Autorización	✅	Token portador para autenticación
Tipo de contenido	✅	application/json

Puntos finales de la API

Operación	Método	Punto final
Obtener datos de un usuario	GET	/v3/users/{userId}
Obtener todos los usuarios	GET	/v3/users
Actualizar un usuario	PUT	/v3/users/{userId}

Esquema de objetos de usuario

Este objeto es devuelto por múltiples endpoints como Get User, all Users, y Update User.

Campo	Tipo	Descripción
ID	entero	Identificador único del objeto Usuario.
id_usuario_puerta_principal	serie	El UUID del usuario Frontdoor, un identificador único para el usuario en un entorno Frontdoor determinado.
inicio_de_sesión_puerta_principal	serie	El login Frontdoor del usuario, un identificador único para el usuario en un entorno Frontdoor determinado.
correo electrónico	serie	La dirección de correo electrónico de Frontdoor del usuario.
nombre_completo	serie	El nombre completo del usuario tal y como aparecerá en las listas de usuarios.
id_del_conjunto_de_filtros_de_dimensión_predeterminado	entero	El ID de vista por defecto vinculado al usuario. Especifica qué vista se carga automáticamente cuando el usuario inicia la aplicación.
identificadores_del_conjunto_de_filtros_de_dimensiones_compartidas	array[entero]	Una lista de identificadores de vistas accesibles para el usuario, incluidas las vistas compartidas directamente con el usuario o con la organización.

Ejemplo de objeto de usuario

{
   "id": 1,
   "frontdoor_user_id": "33ab2211-2b2b-4411-ee99-d90v98475n", 
   "frontdoor_login": "john@cloudability.com",
   "email": "john@cloudability.com",
   "full_name": "John Doe",
   "default_dimension_filter_set_id": null,
   "shared_dimension_filter_set_ids": [
        12,
        999,
        3646
    ]
}

Obtener datos de un usuario

Punto final

GET /v3/users/{userId}

Descripción

Recupera información detallada sobre un usuario concreto.

Ruta y parámetros de consulta

Parámetro	Tipo	Obligatorio	Descripción
userId	entero	✅	ID del usuario solicitante

Respuesta (200 OK)

Devuelve un único objeto de usuario

Ejemplo de solicitud :

curl --location 'https://api.cloudability.com/v3/users/240772' \
--header 'accept: application/json, text/plain, */*' \
--header 'authorization;' \

Ejemplo de respuesta:

{
   "id": 1,
   "frontdoor_user_id": "33ab2211-2b2b-4411-ee99-d90v98475n", 
   "frontdoor_login": "john@cloudability.com",
   "email": "john@cloudability.com",
   "full_name": "John Doe",
   "default_dimension_filter_set_id": null,
   "shared_dimension_filter_set_ids": [
        12,
        999,
        3646
    ]
}

Obtener la lista de usuarios

Punto final

GET /v3/users

Descripción

Recupere la lista de todos los usuarios de su organización.

Parámetros de consulta opcionales

Parámetro	Tipo	Descripción
incluir_detalles_de_paginación	bool	Incluir metadatos de paginación (como recuento total, páginas totales) en la respuesta.
Límite	int	Número de usuarios a devolver por página si include_pagination_details es true
desplazamiento	int	Número de usuarios que hay que omitir antes de empezar a recopilar resultados.
clasificar_campo	serie	Campo por el que se ordenan los usuarios. Valores permitidos: user_full_name, role_key, invitation_state.
dirección_clasificación	serie	Orden de clasificación. Valores permitidos: asc, desc.
buscar	serie	Buscar usuarios por nombre o correo electrónico.

Respuesta (200 OK)

Devuelve un array de User Object

Ejemplo de solicitud :

curl --location 'https://api.cloudability.com/v3/users' \
--header 'accept: application/json, text/plain, */*' \
--header 'authorization;' \

Ejemplo de respuesta:

[
  {
   "id": 1,
   "frontdoor_user_id": "33ab2211-2b2b-4411-ee99-d90v98475n", 
   "frontdoor_login": "john@cloudability.com",
   "email": "john@cloudability.com",
   "full_name": "John Doe",
   "default_dimension_filter_set_id": 12,
   "shared_dimension_filter_set_ids": [
        12,
        999,
        3646
    ]
  }
  {
   "id": 123,
   "frontdoor_user_id": "22dd2222-2b2b-4444-ee99-d90v9847an", 
   "frontdoor_login": "lisa@cloudability.com",
   "email": "lisa@cloudability.com",
   "full_name": "Lisa Smith",
   "default_dimension_filter_set_id": 999,
   "shared_dimension_filter_set_ids": [
        12,
        999,
        4646
    ]
  }
]

Actualizar usuario

Punto final

PUT /v3/users/{userId}

Descripción

Actualiza los datos de un usuario concreto. Esto incluye la modificación de la función, el estado de restricción, el panel de control predeterminado y la lista de ID de vistas compartidas accesibles para el usuario. Todos los demás campos deben actualizarse en Access Administration. Aunque el nombre de un usuario se puede personalizar en Cloudability, tenga en cuenta que los cambios que se realicen aquí no se reflejarán en Access Administration.

Ruta y cuerpo de la solicitud

Parámetro	Tipo	Descripción
userId	entero	ID del usuario a actualizar.
usuario	objeto mencionado a continuación	Objeto envoltorio que contiene los detalles de actualización del usuario.

Parámetros de solicitud (Actualizar usuario)

Parámetro	Tipo	Descripción
ID	entero	ID único del usuario a actualizar (parámetro de ruta).
nombre_completo	serie	Nombre completo del usuario.
rol	serie	Rol asignado al usuario. Valores permitidos: Administrador, Usuario.
Eliminar conjuntos de filtros de dimensiones existentes	bool	Si es true, elimina todos los conjuntos de filtros previamente compartidos antes de aplicar los nuevos.
restringido	bool	Restringe el acceso de los usuarios a recursos específicos.
nuevo_conjunto_de_identificadores_de_filtro_de_dimensión_compartida	array[entero]	Lista de nuevos ID de vista para compartir con este usuario.
identificadores_del_conjunto_de_filtros_de_dimensiones_compartidas	array[entero]	Lista actual de ID de conjuntos de filtros de dimensión compartidos.
id_del_conjunto_de_filtros_de_dimensión_predeterminado	entero	ID del conjunto de vistas/filtros por defecto asociado al usuario.
id_panel_predeterminado	entero	ID por defecto del panel de control para el usuario.

Respuesta (200 OK)

Devuelve el Objeto de Usuario actualizado reflejando todos los campos modificados.

Ejemplo de solicitud :

curl –X PUT https://api.cloudability.com/v3/users/1 \\
     -H ‘Content-Type: application/json’ \\
     -u ‘[auth_token]:’ \\
     -d @- << EOF
{
     "full_name": "Joan Doe",
     "default_dimension_filter_set_id": 12,
     "new_shared_dimension_filter_set_ids": [12, 999]
}
EOF

(Sustituya el valor 1 del ejemplo por el identificador único de su usuario)

Ejemplo de solicitud - Eliminar todas las acciones de vista de usuario

curl –X PUT https://api.cloudability.com/v3/users/1 \\
     -H ‘Content-Type: application/json’ \\
     -u ‘[auth_token]:’ \\
     -d @- << EOF
{
     "full_name": "Joan Doe",
     "default_dimension_filter_set_id": 1,
     "unshare_existing_dimension_filter_sets": true,
     "new_shared_dimension_filter_set_ids": []
}
EOF

(Sustituya el valor 1 del ejemplo por el identificador único de su usuario)