N-able Cloud User Hub (versión preliminar)
Cloud User Hub es un portal unificado de CSP de Microsoft que le permite automatizar tareas comunes en todas las aplicaciones de Microsoft 365 sin cambiar de consola o clientes.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | Premium | Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Power Automate | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Contacto | |
|---|---|
| Nombre | Soporte técnico de Cloud User Hub |
| URL | https://documentation.clouduserhub.management/kb/en |
| Correo Electrónico | technicalsupport@n-able.com |
| Metadatos del conector | |
|---|---|
| Publicador | N-able Cloud User Hub B.V. |
| Website | https://www.n-able.com |
| Directiva de privacidad | https://www.n-able.com/legal/privacy |
| Categorías | Business Management;IT Operations |
Cloud User Hub es un portal unificado de CSP de Microsoft que le permite automatizar tareas comunes en todas las aplicaciones de Microsoft 365 sin cambiar de consola o clientes.
Prerrequisitos
Necesitará lo siguiente para continuar:
- Una suscripción de Cloud User Hub
- Soluciones configuradas en Cloud User Hub para las operaciones específicas que quiere usar
- Roles configurados en Cloud User Hub para las operaciones específicas que pretende usar .
Obtención de credenciales
Puede iniciar sesión con cualquier cuenta configurada para acceder a Cloud User Hub. Para escenarios de automatización, le recomendamos que use una cuenta de servicio dedicada.
Introducción al conector
Comience con Get organizations (Obtener organizaciones) para recuperar una lista de las organizaciones que puede administrar (incluidas las suyas propias). Las organizaciones se devuelven según los ámbitos de rol configurados en Cloud User Hub. Use los identificadores para las llamadas consecutivas. Para las operaciones que requieren un identificador de asociado, use el identificador de su propia organización. Para algunas operaciones, necesitará un identificador de inquilino en lugar del identificador interno del centro de usuarios en la nube o ambos.
Problemas y limitaciones conocidos
Algunas operaciones requieren que la organización de destino tenga una licencia de Microsoft 365 coincidente o una suscripción de Azure activa. Por ejemplo: la configuración del acceso condicional requiere una licencia de Microsoft Entra ID Premium.
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Actualización de la cantidad de suscripción |
Actualice la cantidad de una suscripción. |
| Agregar un miembro a un grupo |
Agregue un miembro a un grupo de Microsoft 365 o a un grupo de seguridad a través de la propiedad de navegación members. |
| Agregar un miembro a un grupo de usuarios |
Agregue un miembro a un grupo de usuarios; el miembro debe pertenecer a la misma organización que el grupo. |
| Agregar un trabajo de bloque de comandos para un grupo |
Agregue un trabajo bloque de comandos. La validación de proveedor y acción se basa en el bloque de comandos específico. |
| Agregar un trabajo de bloque de comandos para un usuario |
Agregue un trabajo bloque de comandos. La validación de proveedor y acción se basa en el bloque de comandos específico. |
| Agregar un trabajo de bloque de comandos para una organización |
Agregue un trabajo bloque de comandos. La validación de proveedor y acción se basa en el bloque de comandos específico. |
| Asignar una licencia a un usuario |
Agregue o quite licencias para el usuario. También puede habilitar y deshabilitar planes específicos asociados a una licencia. |
| Contraseña de cambio de usuario |
Actualice el perfil de contraseña de un usuario para restablecer su contraseña. |
| Creación de un grupo de Azure AD |
Cree un grupo de Azure AD. |
| Creación de un usuario |
El cuerpo de la solicitud contiene el usuario que se va a crear. Como mínimo, debe especificar las propiedades necesarias para el usuario. Opcionalmente, puede especificar cualquier otra propiedad grabable. |
| Eliminación de usuario |
Eliminar un usuario. Cuando se eliminan, los recursos de usuario se mueven a un contenedor temporal y se pueden restaurar en un plazo de 30 días. Después de ese tiempo, se eliminan permanentemente. |
| Eliminación del grupo de usuarios de Cloud User Hub |
Eliminar un grupo de usuarios. |
| Enumerar bloques de comandos |
Recupere una lista de los bloques de comandos disponibles. |
| Enumerar dominios de organización |
Recuperar una lista de objetos de dominio. |
| Obtención de detalles de licencia de usuario |
Recupere una lista de objetos de detalles de licencia para los usuarios empresariales. |
| Obtención de detalles de un único trabajo de usuario |
Obtenga detalles de un único trabajo de usuario, proveedor y validación de acciones depende del bloque de comandos específico. |
| Obtención de detalles del usuario |
Obtener un usuario por identificador de objeto de Microsoft. |
| Obtención de estadísticas en los trabajos del bloque de comandos para todas las organizaciones autorizadas |
Obtenga estadísticas sobre los trabajos de bloque de comandos para los bloques de comandos que está autorizado para ver. |
| Obtención de grupos de seguridad de Azure AD |
Obtenga una lista de los grupos de seguridad de Azure AD de todas las organizaciones que tiene autorización para ver. |
| Obtención de grupos de usuarios de Cloud User Hub |
Obtenga una lista de grupos de todas las organizaciones que está autorizado para ver. |
| Obtención de organizaciones |
Obtenga todas las organizaciones que está autorizado para ver. |
| Obtención de SKU suscritas a la organización |
Obtenga la lista de suscripciones comerciales que ha adquirido una organización. |
| Obtener categorías de comandos |
Obtenga todas las categorías y subcategorías disponibles. |
| Obtener configuraciones regionales |
Obtiene configuraciones regionales. |
| Obtener detalles del bloque de comandos |
Obtenga los detalles de un bloque de comandos. La validación de proveedor y acción depende del bloque de comandos específico. |
| Obtener suscripciones |
Recupera todas las suscripciones para el cliente de un asociado por su identificador de inquilino de Active Directory. |
| Obtener trabajos de bloque de comandos de una organización específica |
Obtenga los trabajos del bloque de comandos para los bloques de comandos que está autorizado para ver. |
| Obtener trabajos de bloque de comandos para todas las organizaciones autorizadas |
Obtenga los trabajos del bloque de comandos para los bloques de comandos que está autorizado para ver. |
| Obtener una lista de miembros del grupo de usuarios de Cloud User Hub |
Obtiene una lista de miembros del grupo de usuarios de un grupo específico. |
| Obtener usuarios |
Recuperar una lista de objetos de usuario. |
| Quitar miembro |
Quite un miembro de un grupo a través de la propiedad de navegación members. |
| Quitar un miembro de un grupo de usuarios |
Quite un miembro a un grupo de usuarios. |
Actualización de la cantidad de suscripción
Actualice la cantidad de una suscripción.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador del asociado de Cloud User Hub.
|
partnerId | True | string |
Identificador de asociado de Cloud User Hub. |
|
Identificador de cliente de Cloud User Hub.
|
customerId | True | string |
Identificador de cliente de Cloud User Hub. |
|
Identificador de inquilino de Microsoft del cliente.
|
tenantId | True | string |
Identificador de inquilino de Microsoft del cliente. |
|
Id. de subsripción.
|
subscriptionId | True | string |
Identificador de suscripción del cliente. |
|
Cantidad
|
quantity | integer |
Cantidad de la suscripción. |
Agregar un miembro a un grupo
Agregue un miembro a un grupo de Microsoft 365 o a un grupo de seguridad a través de la propiedad de navegación members.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de organización de Cloud User Hub.
|
organizationId | True | string |
Identificador de organización de Cloud User Hub. |
|
Identificador de objeto de Microsoft del grupo.
|
microsoftObjectId | True | string |
Identificador de objeto de Microsoft del grupo. |
|
Miembro
|
@odata.id | True | string |
URI del directorio, el usuario, el grupo o el objeto de contacto organizativo que se va a agregar. |
Agregar un miembro a un grupo de usuarios
Agregue un miembro a un grupo de usuarios; el miembro debe pertenecer a la misma organización que el grupo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de organización de Cloud User Hub.
|
organizationId | True | string |
Identificador de organización de Cloud User Hub. |
|
Identificador de grupo de usuarios de Cloud User Hub.
|
userGroupId | True | string |
Identificador de grupo de usuarios de Cloud User Hub. |
|
Identificador de usuario de Cloud User Hub.
|
userId | True | string |
Identificador de usuario de Cloud User Hub. |
Agregar un trabajo de bloque de comandos para un grupo
Agregue un trabajo bloque de comandos. La validación de proveedor y acción se basa en el bloque de comandos específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de organización
|
organizationId | True | string |
Formato: uuid. Identificador único de la organización. |
|
Id. de bloque de comandos
|
commandBlockId | True | string |
Formato: uuid. Identificador único del bloque de comandos. |
|
Id. de grupo de destino
|
targetGroupId | True | string |
Formato: uuid. Identificador único del grupo de destino. |
|
Identificador técnico
|
technicalIdentifier | string |
Identificador técnico. |
|
|
Importancia
|
value | string |
Valor. |
|
|
Id. de programación
|
scheduleId | string |
Identificador de programación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Importancia
|
value | string |
Valor. |
Agregar un trabajo de bloque de comandos para un usuario
Agregue un trabajo bloque de comandos. La validación de proveedor y acción se basa en el bloque de comandos específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de organización
|
organizationId | True | string |
Formato: uuid. Identificador único de la organización. |
|
Id. de bloque de comandos
|
commandBlockId | True | string |
Formato: uuid. Identificador único del bloque de comandos. |
|
Id. de usuario de destino
|
targetUserId | True | string |
Formato: uuid. Identificador único del usuario de destino. |
|
Identificador técnico
|
technicalIdentifier | string |
Identificador técnico. |
|
|
Importancia
|
value | string |
Valor. |
|
|
Id. de programación
|
scheduleId | string |
Identificador de programación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Importancia
|
value | string |
Valor. |
Agregar un trabajo de bloque de comandos para una organización
Agregue un trabajo bloque de comandos. La validación de proveedor y acción se basa en el bloque de comandos específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de organización
|
organizationId | True | string |
Formato: uuid. Identificador único de la organización. |
|
Id. de bloque de comandos
|
commandBlockId | True | string |
Formato: uuid. Identificador único del bloque de comandos. |
|
Id. de organización de destino
|
targetOrganizationId | True | string |
Formato: uuid. Identificador único de la organización de destino. |
|
Identificador técnico
|
technicalIdentifier | string |
Identificador técnico |
|
|
Importancia
|
value | string |
Valor. |
|
|
Id. de programación
|
scheduleId | string |
Identificador de programación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Importancia
|
value | string |
Valor. |
Asignar una licencia a un usuario
Agregue o quite licencias para el usuario. También puede habilitar y deshabilitar planes específicos asociados a una licencia.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de organización de Cloud User Hub.
|
organizationId | True | string |
Identificador de organización de Cloud User Hub. |
|
Identificador de objeto de Microsoft del usuario.
|
microsoftObjectId | True | string |
Identificador de objeto de Microsoft del usuario. |
|
disabledPlans
|
disabledPlans | array of |
Planes deshabilitados. |
|
|
Identificador de SKU
|
skuId | string |
Identificador de SKU de la licencia de Microsoft. |
|
|
Quitar licencias
|
removeLicenses | array of |
Colección de GUID que identifican las licencias que se van a quitar. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
value
|
value | array of object |
Valor. |
|
Id
|
value.id | string |
Identificador del objeto de licencia. |
|
Identificador de SKU
|
value.skuId | string |
Identificador de SKU de Microsoft. |
|
Número de elementos de Sku
|
value.skuPartNumber | string |
Número de elementos de Sku de Microsoft. |
|
servicePlans
|
value.servicePlans | array of object |
Planes de servicio. |
|
servicePlanId
|
value.servicePlans.servicePlanId | string |
Identificador del plan de servicio. |
|
servicePlanName
|
value.servicePlans.servicePlanName | string |
Nombre del plan de servicio. |
|
provisioningStatus
|
value.servicePlans.provisioningStatus | string |
Estado de aprovisionamiento. |
|
se aplicaA
|
value.servicePlans.appliesTo | string |
Se aplica a. |
Contraseña de cambio de usuario
Actualice el perfil de contraseña de un usuario para restablecer su contraseña.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de organización de Cloud User Hub.
|
organizationId | True | string |
Identificador de organización de Cloud User Hub. |
|
Identificador de objeto de Microsoft del usuario.
|
microsoftObjectId | True | string |
Identificador de objeto de Microsoft del usuario. |
|
Forzar el cambio de contraseña en el inicio de sesión
|
forceChangePasswordNextSignIn | boolean |
Forzar al usuario a cambiar la contraseña en el siguiente inicio de sesión. |
|
|
Contraseña
|
password | string |
Nueva contraseña que se va a establecer. |
Creación de un grupo de Azure AD
Cree un grupo de Azure AD.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de organización de Cloud User Hub.
|
organizationId | True | string |
Identificador de organización de Cloud User Hub. |
|
Description
|
description | string |
Descripción del grupo. |
|
|
Nombre para mostrar
|
displayName | string |
Nombre para mostrar del grupo. |
|
|
groupTypes
|
groupTypes | array of string |
Tipos de grupo. |
|
|
Correo habilitado
|
mailEnabled | boolean |
Indica si el grupo está habilitado para correo. |
|
|
Alias de correo
|
mailNickname | string |
Alias de correo del grupo. |
|
|
Seguridad habilitada
|
securityEnabled | boolean |
Indica si el grupo está habilitado para la seguridad. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string |
Identificador del grupo. |
|
Eliminado en
|
deletedDateTime | string |
Eliminado. |
|
Classification
|
classification | string |
Clasificación del grupo. |
|
Fecha de creación
|
createdDateTime | string |
Creado en. |
|
creationOptions
|
creationOptions | array of string |
Opciones de creación. |
|
Description
|
description | string |
Descripción. |
|
Nombre para mostrar
|
displayName | string |
Nombre para mostrar. |
|
groupTypes
|
groupTypes | array of string |
groupTypes |
|
Mail
|
string |
Dirección de correo electrónico del grupo. |
|
|
Correo habilitado
|
mailEnabled | boolean |
Indica que el grupo está habilitado para correo. |
|
Alias de correo
|
mailNickname | string |
Alias de correo del grupo. |
|
Última sincronización local
|
onPremisesLastSyncDateTime | string |
Indica cuándo se sincronizó el grupo en el entorno local. |
|
Identificador de seguridad local
|
onPremisesSecurityIdentifier | string |
Identificador de seguridad local del grupo. |
|
Sincronización local habilitada
|
onPremisesSyncEnabled | string |
Indica si la sincronización local está habilitada. |
|
Ubicación de datos preferida
|
preferredDataLocation | string |
Ubicación de datos preferida del grupo. |
|
direcciones de proxy
|
proxyAddresses | array of string |
Direcciones de proxy. |
|
Renovado
|
renewedDateTime | string |
Fecha y hora renovadas del grupo. |
|
resourceBehaviorOptions
|
resourceBehaviorOptions | array of string |
Opciones de comportamiento de recursos. |
|
resourceProvisioningOptions
|
resourceProvisioningOptions | array of string |
Opciones de aprovisionamiento de recursos. |
|
Seguridad habilitada
|
securityEnabled | boolean |
Indica si el grupo está habilitado para la seguridad. |
|
Visbilidad
|
visibility | string |
Visibilidad del grupo. |
|
onPremisesProvisioningErrors
|
onPremisesProvisioningErrors | array of string |
Errores de aprovisionamiento local. |
Creación de un usuario
El cuerpo de la solicitud contiene el usuario que se va a crear. Como mínimo, debe especificar las propiedades necesarias para el usuario. Opcionalmente, puede especificar cualquier otra propiedad grabable.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de organización de Cloud User Hub.
|
organizationId | True | string |
Identificador de organización de Cloud User Hub. |
|
Cuenta habilitada
|
accountEnabled | boolean |
Cuenta habilitada true o false. |
|
|
Nombre para mostrar
|
displayName | string |
El nombre para mostrar del usuario. |
|
|
Alias de correo
|
mailNickname | string |
Alias de correo del usuario. |
|
|
Nombre principal de usuario
|
userPrincipalName | string |
Nombre principal de usuario del usuario. |
|
|
Forzar el cambio de contraseña siguiente inicio de sesión
|
forceChangePasswordNextSignIn | boolean |
Forzar al usuario a cambiar la contraseña en el siguiente inicio de sesión. |
|
|
Contraseña
|
password | string |
Nueva contraseña para el usuario. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contexto de OData
|
@odata.context | string |
Contexto de OData. |
|
Id
|
id | string |
Identificador de Centro de usuarios en la nube. |
|
businessPhones
|
businessPhones | array of string |
Teléfonos empresariales del usuario. |
|
Nombre para mostrar
|
displayName | string |
El nombre para mostrar del usuario. |
|
Nombre propio
|
givenName | string |
Nombre de pila. |
|
Puesto
|
jobTitle | string |
Título del trabajo del usuario. |
|
Mail
|
string |
Dirección de correo electrónico del usuario. |
|
|
Teléfono móvil
|
mobilePhone | string |
Número de teléfono móvil del usuario. |
|
Ubicación de Office
|
officeLocation | string |
Ubicación de office del usuario. |
|
Lenguaje preferido
|
preferredLanguage | string |
Idioma preferido como configurado en Azure AD. |
|
Surname
|
surname | string |
Apellido del usuario. |
|
Nombre principal del usuario
|
userPrincipalName | string |
Nombre principal de usuario del usuario. |
Eliminación de usuario
Eliminar un usuario. Cuando se eliminan, los recursos de usuario se mueven a un contenedor temporal y se pueden restaurar en un plazo de 30 días. Después de ese tiempo, se eliminan permanentemente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de organización de Cloud User Hub.
|
organizationId | True | string |
Identificador de organización de Cloud User Hub. |
|
Identificador de objeto de Microsoft del usuario.
|
microsoftObjectId | True | string |
Identificador de objeto de Microsoft del usuario. |
Eliminación del grupo de usuarios de Cloud User Hub
Eliminar un grupo de usuarios.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de organización de Cloud User Hub.
|
organizationId | True | string |
Identificador de organización de Cloud User Hub. |
|
Identificador de Centro de usuarios en la nube para el grupo de usuarios.
|
userGroupId | True | string |
Identificador de Centro de usuarios en la nube para el grupo de usuarios. |
Enumerar bloques de comandos
Recupere una lista de los bloques de comandos disponibles.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
elementos de $top
|
$top | string |
Devuelve solo los primeros elementos de $top. |
|
|
elementos de $skip
|
$skip | string |
Número de elementos que se deben omitir. |
|
|
Seleccionar filtro
|
$select | string |
$select filtro odata. |
|
|
Ordenar por
|
$orderby | string |
Determina qué valores se usan para ordenar una colección de registros. |
|
|
Filter
|
$filter | string |
Función que debe evaluarse como true para que se devuelva un registro. |
|
|
Contar
|
$count | string |
Determina que no se debe incluir el recuento de elementos de una colección. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contexto de OData
|
@odata.context | string |
Contexto de OData. |
|
Recuento de OData
|
@odata.count | integer |
Recuento de OData. |
|
Vínculo siguiente de OData
|
@odata.nextLink | string |
Vínculo siguiente de OData. |
|
value
|
value | array of object |
Valor. |
|
Id
|
value.id | string |
Identificador. |
|
Identificador técnico
|
value.technicalIdentifier | string |
Identificador técnico. |
|
Tipo
|
value.type | string |
Tipo. |
|
Versión
|
value.version | integer |
Versión. |
|
Id. de categoría
|
value.categoryId | string |
Identificador de categoría. |
|
Acción de lectura necesaria
|
value.requiredReadAction | string |
Acción de lectura necesaria. |
|
Acción de escritura necesaria
|
value.requiredWriteAction | string |
Acción de escritura necesaria. |
|
Proveedor necesario
|
value.requiredProvider | string |
Proveedor requerido. |
|
Id. de categoría de menú
|
value.menuCategory.id | string |
Identificador de la categoría de menú. |
|
Identificador técnico
|
value.menuCategory.technicalIdentifier | string |
Identificador técnico. |
|
Identificador de categoría principal
|
value.parentCategory.id | string |
Identificador de la categoría primaria. |
|
Identificador técnico
|
value.parentCategory.technicalIdentifier | string |
Identificador técnico. |
|
Id
|
value.category.id | string |
Id. de la categoría. |
|
Identificador técnico
|
value.category.technicalIdentifier | string |
Identificador técnico. |
Enumerar dominios de organización
Recuperar una lista de objetos de dominio.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de organización de Cloud User Hub.
|
organizationId | True | string |
Identificador de organización de Cloud User Hub. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
value
|
value | array of object |
Valor. |
|
Tipo de autenticación
|
value.authenticationType | string |
Tipo de autenticación del dominio. |
|
Estado de disponibilidad
|
value.availabilityStatus | string |
Estado de disponibilidad del dominio. |
|
Id
|
value.id | string |
Identificador del dominio. |
|
Administrador administrado
|
value.isAdminManaged | boolean |
Indica si el dominio está administrado por el administrador. |
|
Predeterminado
|
value.isDefault | boolean |
Indica si se trata del dominio predeterminado. |
|
Inicial
|
value.isInitial | boolean |
Indica si se trata del dominio inicial. |
|
Root
|
value.isRoot | boolean |
Indica si se trata del dominio raíz. |
|
Verificada
|
value.isVerified | boolean |
Indica si se comprueba el dominio. |
|
supportedServices
|
value.supportedServices | array of string |
Servicios admitidos. |
|
Validez de contraseña
|
value.passwordValidityPeriodInDays | integer |
Indica la validez de la contraseña en días. |
|
Ventanas de notificación de contraseña
|
value.passwordNotificationWindowInDays | integer |
Indica la ventana de notifcación de contraseña en días. |
|
Estado
|
value.state | string |
Estado del dominio. |
Obtención de detalles de licencia de usuario
Recupere una lista de objetos de detalles de licencia para los usuarios empresariales.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de organización de Cloud User Hub.
|
organizationId | True | string |
Identificador de organización de Cloud User Hub. |
|
Identificador de objeto de Microsoft del usuario.
|
microsoftObjectId | True | string |
Identificador de objeto de Microsoft del usuario. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
value
|
value | array of object |
Valor. |
|
Id
|
value.id | string |
Identificador de la licencia del usuario. |
|
Identificador de SKU
|
value.skuId | string |
Identificador de SKU de la licencia de Microsoft. |
|
Número de elementos de Sku
|
value.skuPartNumber | string |
Número de parte de Sku de la licencia de Microsoft. |
|
servicePlans
|
value.servicePlans | array of object |
Planes de servicio. |
|
servicePlanId
|
value.servicePlans.servicePlanId | string |
Identificador del plan de servicio. |
|
servicePlanName
|
value.servicePlans.servicePlanName | string |
Nombre del plan de servicio. |
|
provisioningStatus
|
value.servicePlans.provisioningStatus | string |
Estado de aprovisionamiento. |
|
se aplicaA
|
value.servicePlans.appliesTo | string |
Se aplica a. |
Obtención de detalles de un único trabajo de usuario
Obtenga detalles de un único trabajo de usuario, proveedor y validación de acciones depende del bloque de comandos específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de organización
|
organizationId | True | string |
Formato: uuid. Identificador único de la organización. |
|
Id. de bloque de comandos
|
commandBlockId | True | string |
Formato: uuid. Identificador único del bloque de comandos. |
|
Id. de trabajo
|
jobId | True | string |
Formato: uuid. Identificador único del trabajo. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string |
Identificación. |
|
Id. de bloque de comandos
|
commandBlockId | string |
Identificador del bloque de comandos. |
|
Nombre del conjunto de comandos
|
commandSetName | string |
Nombre del conjunto de comandos. |
|
Identificador del conjunto de comandos
|
commandSetId | string |
Identificador del conjunto de comandos. |
|
Id. de bloque del conjunto de comandos
|
commandSetBlockId | string |
Identificador de bloque del conjunto de comandos. |
|
Id. de usuario
|
userId | string |
Identificador de usuario. |
|
Upn de usuario
|
userUpn | string |
Nombre principal de usuario del usuario. |
|
Id. de grupo
|
groupId | string |
Identificador de grupo. |
|
Nombre del grupo
|
groupName | string |
Nombre del grupo. |
|
Id. de organización
|
organizationId | string |
Identificador de la organización. |
|
Nombre de la organización
|
organizationName | string |
Nombre de la organización. |
|
Upn de actor
|
actorUserUpn | string |
Nombre principal de usuario del actor. |
|
Id. de organización de actor
|
actorOrganizationId | string |
Identificador de la organización del actor. |
|
Nombre de la organización del actor
|
actorOrganizationName | string |
Nombre de la organización del actor. |
|
Estado
|
status | string |
Estado. |
|
Ejecutado en
|
executedOn | string |
Se ejecutó en. |
|
Identificador técnico del bloque de comandos
|
commandBlockTechnicalIdentifier | string |
Identificador técnico del bloque de comandos. |
|
Versión del bloque de comandos
|
commandBlockVersion | integer |
Versión del bloque de comandos. |
|
layoutGroups
|
output.body.layoutGroups | array of object |
Formatos de grupo de diseño. |
|
layoutGroupFormats
|
output.body.layoutGroups.layoutGroupFormats | array of object |
Formatos de grupo de diseño. |
|
type
|
output.body.layoutGroups.layoutGroupFormats.type | string |
Tipo. |
|
property
|
output.body.layoutGroups.layoutGroupFormats.property | string |
Propiedad. |
|
Propiedades
|
output.body.layoutGroups.layoutGroupFormats.properties | array of string |
Propiedades. |
|
parameters
|
output.body.parameters | array of object |
Parámetros. |
|
Identificador técnico
|
output.body.parameters.technicalIdentifier | string |
Identificador técnico. |
|
Importancia
|
output.body.parameters.value | string |
Valor. |
|
Schema
|
output.body.parameters.schema | string |
Esquema. |
|
Conjunto de comandos
|
output.body.parameters.placeholderEnabled.commandSet | boolean |
Conjunto de comandos. |
|
Bloque de comandos
|
output.body.parameters.placeholderEnabled.commandBlock | boolean |
Bloque de comandos. |
|
Código de error
|
output.errorCode | string |
Código de error. |
|
Success
|
output.isSuccess | boolean |
Exitoso. |
|
layoutGroups
|
input.layoutGroups | array of object |
Grupos de diseño. |
|
layoutGroupFormats
|
input.layoutGroups.layoutGroupFormats | array of object |
Formatos de grupo de diseño. |
|
type
|
input.layoutGroups.layoutGroupFormats.type | string |
Tipo. |
|
property
|
input.layoutGroups.layoutGroupFormats.property | string |
Propiedad. |
|
Propiedades
|
input.layoutGroups.layoutGroupFormats.properties | array of string |
Propiedades. |
|
Varias organizaciones
|
input.multiSelection.multipleOrganizations | boolean |
Varias organizaciones. |
|
Varios usuarios
|
input.multiSelection.multipleUsers | boolean |
Varios usuarios. |
|
parameters
|
input.parameters | array of object |
Parámetros. |
|
Identificador técnico
|
input.parameters.technicalIdentifier | string |
Identificador técnico. |
|
Importancia
|
input.parameters.value | string |
Valor. |
|
Valor predeterminado
|
input.parameters.defaultValue | string |
Valor predeterminado. |
|
Tipo
|
input.parameters.schema.type | string |
Tipo. |
|
Formato
|
input.parameters.schema.format | string |
Formato. |
|
Modelo
|
input.parameters.schema.pattern | string |
Patrón. |
|
Longitud mínima
|
input.parameters.schema.minLength | string |
Longitud mínima. |
|
Conjunto de comandos
|
input.parameters.placeholderEnabled.commandSet | boolean |
Conjunto de comandos. |
|
Bloque de comandos
|
input.parameters.placeholderEnabled.commandBlock | boolean |
Bloque de comandos. |
|
linkedCommandBlocks
|
input.parameters.placeholderEnabled.linkedCommandBlocks | array of object |
Bloques de comandos vinculados. |
|
technicalIdentifier
|
input.parameters.placeholderEnabled.linkedCommandBlocks.technicalIdentifier | string |
Identificador técnico. |
|
version
|
input.parameters.placeholderEnabled.linkedCommandBlocks.version | integer |
Versión. |
Obtención de detalles del usuario
Obtener un usuario por identificador de objeto de Microsoft.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de organización de Cloud User Hub.
|
organizationId | True | string |
Identificador de organización de Cloud User Hub. |
|
Identificador de objeto de Microsoft del usuario.
|
microsoftObjectId | True | string |
Identificador de objeto de Microsoft del usuario. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Cuenta habilitada
|
accountEnabled | boolean |
Cuenta habilitada true o false. |
|
Id. de empleado
|
employeeId | string |
Identificador de empleado del usuario. |
|
Nombre para mostrar
|
displayName | string |
El nombre para mostrar del usuario. |
|
Nombre propio
|
givenName | string |
Nombre dado del usuario. |
|
Surname
|
surname | string |
Apellido del usuario. |
|
Nombre principal de usuario
|
userPrincipalName | string |
Nombre principal de usuario del usuario. |
|
Puesto
|
jobTitle | string |
Título del trabajo del usuario. |
|
Departamento
|
department | string |
Departamento del usuario. |
|
Nombre de la compañía
|
companyName | string |
Nombre de la compañía del usuario. |
|
Usagelocation
|
usageLocation | string |
Ubicación de uso del usuario. |
|
Dirección postal
|
streetAddress | string |
Dirección postal del usuario. |
|
City
|
city | string |
Ciudad del usuario. |
|
Estado
|
state | string |
Estado del usuario. |
|
Código postal
|
postalCode | string |
Código postal del usuario. |
|
País
|
country | string |
País del usuario. |
Obtención de estadísticas en los trabajos del bloque de comandos para todas las organizaciones autorizadas
Obtenga estadísticas sobre los trabajos de bloque de comandos para los bloques de comandos que está autorizado para ver.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de categoría
|
categoryId | True | string |
Formato: uuid. Identificador único de la categoría. |
|
Seleccionar filtro
|
$select | string |
$select filtro odata. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contexto de OData
|
@odata.context | string |
Contexto de OData. |
|
Tipo
|
type | string |
Tipo. |
|
Categoría
|
category | string |
Categoría. |
|
Período
|
period | string |
Periodo. |
|
Completado
|
completed | integer |
Completado. |
|
En cola
|
queued | integer |
Cola. |
|
Fracasado
|
failed | integer |
Fracasado. |
Obtención de grupos de seguridad de Azure AD
Obtenga una lista de los grupos de seguridad de Azure AD de todas las organizaciones que tiene autorización para ver.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de organización de Cloud User Hub.
|
organizationId | True | string |
Identificador de organización de Cloud User Hub. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
value
|
value | array of object |
Valor. |
|
Fecha de creación
|
value.createdDateTime | string |
Creado en. |
|
Displayname
|
value.displayName | string |
Nombre para mostrar. |
|
groupTypes
|
value.groupTypes | array of string |
Tipos de grupo. |
|
Id
|
value.id | string |
Identificador de objeto de Microsoft del grupo. |
|
Seguridad habilitada
|
value.securityEnabled | boolean |
Indica si el grupo está habilitado para la seguridad. |
|
Mail
|
value.mail | string |
Dirección de correo electrónico del grupo. |
Obtención de grupos de usuarios de Cloud User Hub
Obtenga una lista de grupos de todas las organizaciones que está autorizado para ver.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Filtrar grupos.
|
$filter | True | string |
Filtre por grupos de una organización. Use: organizationId en ('{organizationId}'). |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
@odata.count | integer |
Recuento de OData. |
|
value
|
value | array of object |
Valor. |
|
Identificador de organización
|
value.organizationId | string |
Identificador de organización de Cloud User Hub. |
|
Nombre
|
value.name | string |
Nombre del grupo. |
|
Description
|
value.description | string |
Descripción del grupo. |
|
Id
|
value.id | string |
Identificador del grupo. |
|
Fecha de creación
|
value.createdOn | string |
Creado en. |
|
Fecha de modificación
|
value.modifiedOn | string |
Modificado. |
Obtención de organizaciones
Obtenga todas las organizaciones que está autorizado para ver.
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Recuento de OData
|
@odata.count | integer |
Recuento de OData. |
|
value
|
value | array of object |
Valor. |
|
Nombre
|
value.name | string |
Nombre de la organización de Azure AD. |
|
Microsoft tenantId
|
value.microsoftTenantId | string |
Identificador de inquilino de Microsoft de la organización. |
|
Fecha de creación
|
value.createdOn | string |
Creado en. |
|
Fecha de modificación
|
value.modifiedOn | string |
Modificado. |
|
Id
|
value.id | string |
Identificador de Centro de usuarios en la nube. |
Obtención de SKU suscritas a la organización
Obtenga la lista de suscripciones comerciales que ha adquirido una organización.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de organización de Cloud User Hub.
|
organizationId | True | string |
Identificador de organización de Cloud User Hub. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
value
|
value | array of object |
Valor. |
|
Estado de la funcionalidad
|
value.capabilityStatus | string |
Estado de funcionalidad de la SKU de Microsoft. |
|
Unidades consumidas
|
value.consumedUnits | integer |
Unidades consumidas para esta SKU. |
|
Id
|
value.id | string |
Identificador del objeto de SKU suscrito. |
|
Identificador de SKU
|
value.skuId | string |
Identificador de SKU de la licencia de Microsoft. |
|
Número de elementos de Sku
|
value.skuPartNumber | string |
Número de parte de Sku de la licencia de Microsoft. |
|
Se aplica a
|
value.appliesTo | string |
Se aplica al usuario o a la organización. |
|
Enabled
|
value.prepaidUnits.enabled | integer |
Se ha habilitado la sku suscrita. |
|
Suspendido
|
value.prepaidUnits.suspended | integer |
Sku suscrita suspendida. |
|
Advertencia
|
value.prepaidUnits.warning | integer |
Sku suscrita con advertencia. |
|
servicePlans
|
value.servicePlans | array of object |
Planes de servicio. |
|
servicePlanId
|
value.servicePlans.servicePlanId | string |
Identificador del plan de servicio. |
|
servicePlanName
|
value.servicePlans.servicePlanName | string |
Nombre del plan de servicio. |
|
provisioningStatus
|
value.servicePlans.provisioningStatus | string |
Estado de aprovisionamiento. |
|
se aplicaA
|
value.servicePlans.appliesTo | string |
Se aplica a. |
Obtener categorías de comandos
Obtenga todas las categorías y subcategorías disponibles.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
elementos de $top
|
$top | string |
Devuelve solo los primeros elementos de $top. |
|
|
elementos de $skip
|
$skip | string |
Número de elementos que se deben omitir. |
|
|
Seleccionar filtro
|
$select | string |
$select filtro odata. |
|
|
Ordenar por
|
$orderby | string |
Determina qué valores se usan para ordenar una colección de registros. |
|
|
Filter
|
$filter | string |
Función que debe evaluarse como true para que se devuelva un registro. |
|
|
Contar
|
$count | string |
Determina el tiempo o no incluir el recuento de elementos de una colección. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contexto de OData
|
@odata.context | string |
Contexto de OData. |
|
Recuento de OData
|
@odata.count | integer |
Recuento de OData. |
|
Vínculo siguiente de OData
|
@odata.nextLink | string |
Vínculo siguiente de OData. |
|
value
|
value | array of object |
Valor. |
|
Id
|
value.id | string |
Identificación. |
|
Identificador técnico
|
value.technicalIdentifier | string |
Identificador técnico. |
|
Identificador de categoría principal
|
value.parentCategoryId | string |
Identificador de categoría principal. |
Obtener configuraciones regionales
Obtiene configuraciones regionales.
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contexto de OData
|
@odata.context | string |
Contexto de OData. |
|
Contar
|
@odata.count | integer |
Recuento de OData. |
|
NextLink de OData
|
@odata.nextLink | string |
Siguiente vínculo de OData. |
|
value
|
value | array of object |
Valor. |
|
Id
|
value.id | string |
Identificador de configuración regional. |
|
Código de configuración regional
|
value.localeCode | string |
Códigos de idioma ISO-639. |
|
Código de país
|
value.countryCode | string |
Códigos de país ISO-3166. |
|
Nombre del país
|
value.countryName | string |
Nombre del país. |
Obtener detalles del bloque de comandos
Obtenga los detalles de un bloque de comandos. La validación de proveedor y acción depende del bloque de comandos específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de bloque de comandos
|
commandBlockId | True | string |
Formato: uuid. Identificador único del bloque de comandos. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string |
Identificación. |
|
Versión
|
version | integer |
Versión. |
|
Id. de categoría
|
categoryId | string |
Id. de categoría. |
|
Identificador técnico
|
technicalIdentifier | string |
Identificador técnico. |
|
Acción de lectura necesaria
|
requiredReadAction | string |
Acción de lectura necesaria. |
|
Acción de escritura necesaria
|
requiredWriteAction | string |
Acción de escritura necesaria. |
|
Proveedor necesario
|
requiredProvider | string |
Proveedor requerido. |
|
Tipo
|
type | string |
Tipo. |
|
Id
|
category.id | string |
Identificación. |
|
Identificador técnico
|
category.technicalIdentifier | string |
Identificador técnico. |
|
Id
|
parentCategory.id | string |
Identificación. |
|
Identificador técnico
|
parentCategory.technicalIdentifier | string |
Identificador técnico. |
|
Id
|
menuCategory.id | string |
Identificación. |
|
Identificador técnico
|
menuCategory.technicalIdentifier | string |
Identificador técnico. |
|
Selección múltiple
|
commandInput.multiSelection | string |
Selección múltiple. |
|
layoutGroups
|
commandInput.layoutGroups | array of object |
Grupos de diseño. |
|
Identificador técnico
|
commandInput.layoutGroups.technicalIdentifier | string |
Identificador técnico. |
|
layoutGroupFormats
|
commandInput.layoutGroups.layoutGroupFormats | array of object |
Formatos de grupo de diseño. |
|
type
|
commandInput.layoutGroups.layoutGroupFormats.type | string |
Tipo. |
|
property
|
commandInput.layoutGroups.layoutGroupFormats.property | string |
Propiedad. |
|
Propiedades
|
commandInput.layoutGroups.layoutGroupFormats.properties | array of |
Propiedades. |
|
parameters
|
commandInput.parameters | array of object |
Parámetros. |
|
Valor predeterminado
|
commandInput.parameters.defaultValue | string |
Valor predeterminado. |
|
Identificador técnico
|
commandInput.parameters.technicalIdentifier | string |
Identificador técnico. |
|
Schema
|
commandInput.parameters.schema | string |
Esquema. |
|
Confidencial
|
commandInput.parameters.sensitive | boolean |
Sensible. |
|
Obligatorio
|
commandInput.parameters.required | boolean |
Obligatorio. |
|
Importancia
|
commandInput.parameters.value | string |
Valor. |
|
Conjunto de comandos
|
commandInput.parameters.placeholderEnabled.commandSet | boolean |
Conjunto de comandos. |
|
Bloque de comandos
|
commandInput.parameters.placeholderEnabled.commandBlock | boolean |
Bloque de comandos. |
|
linkedCommandBlocks
|
commandInput.parameters.placeholderEnabled.linkedCommandBlocks | array of object |
Bloques de comandos vinculados. |
|
technicalIdentifier
|
commandInput.parameters.placeholderEnabled.linkedCommandBlocks.technicalIdentifier | string |
Identificador técnico. |
|
version
|
commandInput.parameters.placeholderEnabled.linkedCommandBlocks.version | integer |
Versión. |
|
layoutGroups
|
commandOutput.layoutGroups | array of object |
Grupos de diseño. |
|
Identificador técnico
|
commandOutput.layoutGroups.technicalIdentifier | string |
Identificador técnico. |
|
layoutGroupFormats
|
commandOutput.layoutGroups.layoutGroupFormats | array of object |
Formatos de grupo de diseño. |
|
type
|
commandOutput.layoutGroups.layoutGroupFormats.type | string |
Tipo. |
|
property
|
commandOutput.layoutGroups.layoutGroupFormats.property | string |
Propiedad. |
|
Propiedades
|
commandOutput.layoutGroups.layoutGroupFormats.properties | array of |
Propiedades. |
|
parameters
|
commandOutput.parameters | array of object |
Parámetros. |
|
Example
|
commandOutput.parameters.example | string |
Ejemplo. |
|
Identificador técnico
|
commandOutput.parameters.technicalIdentifier | string |
Identificador técnico. |
|
Schema
|
commandOutput.parameters.schema | string |
Esquema. |
|
Confidencial
|
commandOutput.parameters.sensitive | boolean |
Sensible. |
|
Obligatorio
|
commandOutput.parameters.required | boolean |
Obligatorio. |
|
Importancia
|
commandOutput.parameters.value | string |
Valor. |
|
Conjunto de comandos
|
commandOutput.parameters.placeholderEnabled.commandSet | boolean |
Conjunto de comandos. |
|
Bloque de comandos
|
commandOutput.parameters.placeholderEnabled.commandBlock | boolean |
Bloque de commmand. |
Obtener suscripciones
Recupera todas las suscripciones para el cliente de un asociado por su identificador de inquilino de Active Directory.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de asociado de Cloud User Hub.
|
partnerId | True | string |
Identificador de asociado de Cloud User Hub. |
|
Identificador de cliente de Cloud User Hub.
|
customerId | True | string |
Identificador de cliente de Cloud User Hub. |
|
Identificador de inquilino de Microsoft del cliente.
|
tenantId | True | string |
Identificador de inquilino de Microsoft del cliente. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Recuento total
|
totalCount | integer |
Recuento total del objeto de suscripción. |
|
items
|
items | array of object |
Artículos. |
|
Id
|
items.id | string |
Identificador de la suscripción. |
|
Id. de derecho
|
items.entitlementId | string |
Identificador de derechos de la suscripción. |
|
Nombre amigable
|
items.friendlyName | string |
Nombre descriptivo de la suscripción. |
|
Cantidad
|
items.quantity | integer |
Cantidad de la suscripción. |
|
Tipo de unidad
|
items.unitType | string |
Tipo de unidad de la suscripción. |
|
Fecha de creación
|
items.creationDate | string |
Creado en la fecha de la suscripción. |
|
Fecha de inicio efectiva
|
items.effectiveStartDate | string |
Fecha de inicio efectiva de la suscripción. |
|
Fecha de finalización del compromiso
|
items.commitmentEndDate | string |
Fecha de finalización del compromiso de la suscripción. |
|
Estado
|
items.status | string |
Estado de la suscripción. |
|
Renovación automática
|
items.autoRenewEnabled | boolean |
Indica si la renovación automática está habilitada para la suscripción. |
|
Tipo de facturación
|
items.billingType | string |
Tipo de facturación de la suscripción. |
|
Tipo de contrato
|
items.contractType | string |
Tipo de contrato de la suscripción. |
|
Uri
|
items.links.offer.uri | string |
Uri de la suscripción. |
|
Método
|
items.links.offer.method | string |
Método de la suscripción. |
|
headers
|
items.links.offer.headers | array of |
Encabezados. |
|
Uri
|
items.links.self.uri | string |
Uri de la suscripción. |
|
Método
|
items.links.self.method | string |
Método de la suscripción. |
|
headers
|
items.links.self.headers | array of |
Encabezados. |
|
Id. de pedido
|
items.orderId | string |
Identificador de pedido de la suscripción. |
|
Etag
|
items.attributes.etag | string |
Etag de la suscripción. |
|
Tipo de objeto
|
items.attributes.objectType | string |
Tipo de objeto de la suscripción. |
|
Tipo de objeto
|
attributes.objectType | string |
Tipo de objeto de la suscripción. |
Obtener trabajos de bloque de comandos de una organización específica
Obtenga los trabajos del bloque de comandos para los bloques de comandos que está autorizado para ver.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de organización.
|
organizationId | True | string |
Formato: uuid. Identificador único de la organización. |
|
elementos de $top
|
$top | string |
Devuelve solo los primeros elementos de $top. |
|
|
elementos de $skip
|
$skip | string |
Número de elementos que se deben omitir. |
|
|
Seleccionar filtro
|
$select | string |
$select filtro odata. |
|
|
Ordenar por
|
$orderby | string |
Determina qué valores se usan para ordenar una colección de registros. |
|
|
Filter
|
$filter | string |
Función que debe evaluarse como true para que se devuelva un registro. |
|
|
Contar
|
$count | string |
Determina el tiempo o no incluir el recuento de elementos de una colección. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contexto de OData
|
@odata.context | string |
Contexto de OData. |
|
Recuento de OData
|
@odata.count | integer |
Recuento de OData. |
|
Nextlink de OData
|
@odata.nextLink | string |
Siguiente vínculo de OData. |
|
value
|
value | array of object |
Valor. |
|
Id
|
value.id | string |
Identificación. |
|
Id. de bloque de comandos
|
value.commandBlockId | string |
Identificador del bloque de comandos. |
|
Nombre del conjunto de comandos
|
value.commandSetName | string |
Nombre del conjunto de comandos. |
|
Identificador del conjunto de comandos
|
value.commandSetId | string |
Identificador del conjunto de comandos. |
|
Id. de bloque del conjunto de comandos
|
value.commandSetBlockId | string |
Identificador de bloque del conjunto de comandos. |
|
Id. de usuario
|
value.userId | string |
Identificador de usuario. |
|
Upn de usuario
|
value.userUpn | string |
Nombre principal de usuario. |
|
Id. de grupo
|
value.groupId | string |
Identificador de grupo. |
|
Nombre del grupo
|
value.groupName | string |
Nombre del grupo. |
|
Id. de organización
|
value.organizationId | string |
Identificador de la organización. |
|
Nombre de la organización
|
value.organizationName | string |
Nombre de la organización. |
|
Nombre principal de usuario del actor
|
value.actorUserUpn | string |
Nombre principal de usuario del actor. |
|
Id. de organización de actor
|
value.actorOrganizationId | string |
Identificador de la organización del actor. |
|
Nombre de la organización del actor
|
value.actorOrganizationName | string |
Nombre de la organización del actor. |
|
Estado
|
value.status | string |
Estado. |
|
Ejecutado en
|
value.executedOn | string |
Se ejecutó en. |
|
Identificador técnico del bloque de comandos
|
value.commandBlockTechnicalIdentifier | string |
Identificador técnico del bloque de comandos. |
|
Versión del bloque de comandos
|
value.commandBlockVersion | integer |
Versión del bloque de comandos. |
|
Ejecución planeada
|
value.plannedExecution | string |
Ejecución planeada. |
|
Id. de programación
|
value.scheduleId | string |
Identificador de programación. |
|
Nombre de programación
|
value.scheduleName | string |
Nombre del programa. |
Obtener trabajos de bloque de comandos para todas las organizaciones autorizadas
Obtenga los trabajos del bloque de comandos para los bloques de comandos que está autorizado para ver.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
elementos de $top
|
$top | string |
Devuelve solo los primeros elementos de $top. |
|
|
elementos de $skip
|
$skip | string |
Número de elementos que se deben omitir. |
|
|
Seleccionar filtro
|
$select | string |
$select filtro odata. |
|
|
Ordenar por
|
$orderby | string |
Determina qué valores se usan para ordenar una colección de registros. |
|
|
Filter
|
$filter | string |
Función que debe evaluarse como true para que se devuelva un registro. |
|
|
Contar
|
$count | string |
Determina si el recuento de elementos debe incluirse en una colección. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contexto de OData
|
@odata.context | string |
Contexto de OData. |
|
Recuento de OData
|
@odata.count | integer |
Recuento de OData. |
|
Vínculo siguiente de OData
|
@odata.nextLink | string |
Vínculo siguiente de OData |
|
value
|
value | array of object |
Valor. |
|
Id
|
value.id | string |
Identificador. |
|
Id. de bloque de comandos
|
value.commandBlockId | string |
Identificador del bloque de comandos. |
|
Nombre del conjunto de comandos
|
value.commandSetName | string |
Nombre del conjunto de comandos. |
|
Identificador del conjunto de comandos
|
value.commandSetId | string |
Identificador del conjunto de comandos |
|
Id. de bloque del conjunto de comandos
|
value.commandSetBlockId | string |
Identificador de bloque del conjunto de comandos. |
|
Id. de usuario
|
value.userId | string |
Identificador de usuario. |
|
Nombre principal de usuario
|
value.userUpn | string |
Nombre principal de usuario. |
|
Id. de grupo
|
value.groupId | string |
Identificador de grupo. |
|
Nombre del grupo
|
value.groupName | string |
Nombre del grupo. |
|
Id. de organización
|
value.organizationId | string |
Identificador de la organización. |
|
Nombre de la organización
|
value.organizationName | string |
Nombre de la organización. |
|
Upn de usuario de actor
|
value.actorUserUpn | string |
Nombre principal de usuario del actor. |
|
Id. de organización de actor
|
value.actorOrganizationId | string |
Identificador de la organización del actor. |
|
Nombre de la organización del actor
|
value.actorOrganizationName | string |
Nombre de la organización del actor. |
|
Estado
|
value.status | string |
Estado. |
|
Ejecutado en
|
value.executedOn | string |
Se ejecutó en. |
|
Identificador técnico del bloque de comandos
|
value.commandBlockTechnicalIdentifier | string |
Identificador técnico del bloque de comandos. |
|
Versión del bloque de comandos
|
value.commandBlockVersion | integer |
Versión del bloque de comandos. |
|
Ejecución planeada
|
value.plannedExecution | string |
Ejecución planeada. |
|
Id. de programación
|
value.scheduleId | string |
Identificador de programación. |
|
Nombre de programación
|
value.scheduleName | string |
Nombre del programa. |
Obtener una lista de miembros del grupo de usuarios de Cloud User Hub
Obtiene una lista de miembros del grupo de usuarios de un grupo específico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de organización de Cloud User Hub.
|
organizationId | True | string |
Identificador de organización de Cloud User Hub. |
|
Identificador del centro de usuarios en la nube del grupo.
|
userGroupId | True | string |
Identificador del centro de usuarios en la nube del grupo. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
@odata.count | integer |
Recuento de OData. |
|
value
|
value | array of object |
Valor. |
|
Nombre
|
value.name | string |
Nombre. |
|
Nombre principal de usuario
|
value.upn | string |
Nombre principal de usuario del grupo. |
|
Id
|
value.id | string |
Identificador del objeto miembro del grupo. |
|
Id. de grupo
|
value.groupId | string |
Identificador del centro de usuarios en la nube del grupo. |
|
Fecha de creación
|
value.createdOn | string |
Creado en. |
|
Fecha de modificación
|
value.modifiedOn | string |
Modificado. |
Obtener usuarios
Recuperar una lista de objetos de usuario.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Filtrar usuarios.
|
$filter | True | string |
Filtre por los usuarios de una organización. Use: organizationId en ('{organizationId}'). |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Recuento de OData
|
@odata.count | integer |
Recuento de OData. |
|
value
|
value | array of object |
Valor. |
|
Id. de organización
|
value.organizationId | string |
Identificador de organización de Cloud User Hub. |
|
Identificador de objeto de Microsoft
|
value.microsoftObjectIdentifier | string |
Identificador de objeto de Microsoft del usuario. |
|
Nombre principal de usuario
|
value.upn | string |
Nombre principal de usuario del usuario. |
|
Nombre
|
value.firstName | string |
Nombre del usuario. |
|
Apellido
|
value.lastName | string |
Apellidos del usuario. |
|
Nombre para mostrar
|
value.displayName | string |
El nombre para mostrar del usuario. |
|
Language
|
value.language | string |
Idioma del usuario. |
|
Ubicación de uso
|
value.usageLocation | string |
Ubicación de uso del usuario. |
|
Id
|
value.id | string |
Identificador del centro de usuarios en la nube del usuario. |
|
Creadas el
|
value.createdOn | string |
Creado activado. |
|
Fecha de modificación
|
value.modifiedOn | string |
Modificado. |
Quitar miembro
Quite un miembro de un grupo a través de la propiedad de navegación members.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de organización de Cloud User Hub.
|
organizationId | True | string |
Identificador de organización de Cloud User Hub. |
|
Identificador de objeto de Microsoft del grupo.
|
groupMicrosoftObjectId | True | string |
Identificador de objeto de Microsoft del grupo. |
|
Identificador de objeto de Microsoft del usuario.
|
userMicrosoftObjectId | True | string |
Identificador de objeto de Microsoft del usuario. |
Quitar un miembro de un grupo de usuarios
Quite un miembro a un grupo de usuarios.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de organización de Cloud User Hub.
|
organizationId | True | string |
Identificador de organización de Cloud User Hub. |
|
Identificador de grupo de usuarios de Cloud User Hub.
|
userGroupId | True | string |
Identificador de grupo de usuarios de Cloud User Hub. |
|
Identificador de usuario de Cloud User Hub.
|
userId | True | string |
Identificador de usuario de Cloud User Hub. |