CreateUserGroup - Quick BI - Centro de documentación de Alibaba Cloud

Crea un grupo de usuarios. Puede especificar un grupo de usuarios principal.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

quickbi-public:CreateUserGroup

create

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
UserGroupId	string	No	El ID único del grupo de usuarios. Si no especifica el parámetro UserGroupId, el sistema genera automáticamente el parámetro UserGroupId. Si especifica el parámetro UserGroupId, el ID de usuario se utiliza como ID del grupo de usuarios. Debe asegurarse de que el ID de usuario sea único dentro de la organización. Verificación de formato: longitud máxima de 64, no puede ser -1.	pop0001
UserGroupName	string	Sí	El nombre del grupo de usuarios de RAM. Verificación de formato: longitud máxima de 255. Verificación de formato especial: dígitos en chino e inglés _ \ / \| () ] [	杭州财报
UserGroupDescription	string	No	La descripción del grupo de usuarios. Verificación de formato: longitud máxima de 255. Verificación de formato especial: dígitos en chino e inglés _ \ / \| () ] [	用户分组描述
ParentUserGroupId	string	Sí	El ID del grupo de usuarios principal. Puede agregar nuevos grupos de usuarios a este grupo: Si ingresa el ID de un grupo de usuarios principal, el nuevo grupo de usuarios se agrega al grupo de usuarios con dicho ID. Si ingresa -1, el nuevo grupo de usuarios se agrega al directorio raíz.	3d2c23d4-2b41-4af8-a1f5-f6390f32****

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	36829379-0C38-5BC0-830A-92665BF77D4F
Result	string	Se devuelve el ID del grupo de usuarios agregado. Se devuelve una cadena vacía '' si la operación de agregar falla.	f5eeb52e-d9c2-4a8b-80e3-47ab55c2****
Success	boolean	Indica si la solicitud se realizó correctamente. Valores válidos: true: La solicitud se realizó correctamente. false: La solicitud falló.	true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "36829379-0C38-5BC0-830A-92665BF77D4F",
  "Result": "f5eeb52e-d9c2-4a8b-80e3-47ab55c2****",
  "Success": true
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
400	Usergroup.Not.Exist	The user group does not exist.
400	Duplicate.Name.Error	The name already exists.
400	UserGroup.Parent.NotFound	The parent user group does not exist.
400	Duplicate.UserGroup.Id	Duplicated usergroupId %s.
400	RootUserGroup.Create.Error	organization %s has synchronized with other organizational structures, so user groups cannot be created under the root user group.
400	UserGroup.Already.Synchronized	Organization has synchronized with other organizational structures, so you are not allowed to add users under group.
400	UserGroup.Layer.Limited	The user group cannot have more than ten layers.
400	UserGroup.ExceedsLimit.Error	User group exceed limit, %s.
400	Duplicate.UserGroupName.Error	There is already a user group with the same name %s, please rename it before saving.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.