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

Agrega un miembro a la organización.

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:AddUser

create

*Todos los recursos.

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
AdminUser `deprecated`	boolean	No	Especifica si se debe asignar el rol de administrador de la organización. Valores válidos: true: Sí. false: No. Importante Este parámetro está obsoleto. Cuando se especifica RoleIds, este parámetro no surte efecto.	true
AuthAdminUser `deprecated`	boolean	No	Especifica si se debe asignar el rol de administrador de gestión de permisos de la organización. Valores válidos: true: Sí. false: No. Importante Este parámetro ha caducado y ya no se recomienda. Cuando se especifica RoleIds, este parámetro no surte efecto.	true
UserType	integer	Sí	El tipo de usuario del miembro de la organización. Valores válidos: 1: Desarrollador. 2: Visitante. 3: Analista. Valores válidos: 1 : Desarrollador. 2 : Visitante. 3 : Analista.	1
AccountId	string	No	El ID de la cuenta de Alibaba Cloud. Aviso Para las versiones de Quick BI publicadas después del 31 de diciembre de 2024, AccountId es un parámetro obligatorio. Actualice sus llamadas a la API antes de esta fecha.	191476xxxxx23754
AccountName `deprecated`	string	No	El nombre de la cuenta de Alibaba Cloud. Nota: Para un usuario de RAM, el formato es "cuenta principal:usuario de RAM". Ejemplo: master_test@aliyun.com:subaccount Validación de formato: La longitud máxima es de 50 caracteres.	xxxxxx@163.com
NickName	string	Sí	El apodo de la cuenta de Alibaba Cloud. Validación de formato: La longitud máxima es de 50 caracteres. Validación de caracteres especiales: Caracteres chinos, caracteres en inglés, dígitos, _ \ / \| () ] [	John
RoleIds	string	No	Los ID de los roles de organización predefinidos o personalizados que se adjuntarán al usuario, separados por comas (,). Se admite un máximo de tres ID de rol. Valores válidos: Administrador de la organización (rol predefinido): 111111111 Administrador de gestión de permisos (rol predefinido): 111111112 Usuario común (rol predefinido): 111111113	111111111,456
CopilotModules	string	No	Las cuotas de módulos inteligentes del usuario. Separe varios módulos con comas (,). qreport -- Small Q Report qExploreNum -- Small Q Explorer smartQAskNum -- Small Q Ask smartQDevNum -- Small Q Builder	qreport,qExploreNum

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	Los detalles del usuario de Alibaba Cloud recién agregado.
AccountName	string	La cuenta de Alibaba Cloud.	xxxxxx@163.com
AdminUser	boolean	Indica si el rol de administrador de la organización está vinculado. Valores válidos: true: Sí. false: No. Importante Este parámetro está obsoleto. Cuando se especifica RoleIdList, este parámetro no surte efecto.	true
AuthAdminUser	boolean	Indica si el rol de administrador de gestión de permisos está adjunto. Valores válidos: true: Sí. false: No. Importante Este parámetro ha caducado y ya no se recomienda. Cuando se especifica RoleIdList, este parámetro no surte efecto.	true
NickName	string	El apodo de la cuenta de Alibaba Cloud.	John
RoleIdList	array	La lista de ID de roles de organización vinculados al usuario.
	integer	El ID del rol de organización. Se admite un máximo de tres ID de rol, que incluyen, entre otros, los siguientes roles predefinidos: Administrador de la organización (rol predefinido): 111111111 Administrador de gestión de permisos (rol predefinido): 111111112 Usuario común (rol predefinido): 111111113	111111111
CopilotModules	array	Las cuotas de módulos inteligentes que posee el usuario.
	string	Las cuotas de módulos inteligentes que posee el usuario.	qreport
UserId	string	El ID de usuario en Quick BI.	b5d8fd9348cc4327****afb604
UserType	integer	El tipo de usuario del miembro de la organización. Valores válidos: 1: Desarrollador. 2: Visitante. 3: Analista.	1
Success	boolean	Indica si la solicitud fue exitosa. Valores válidos: true: La solicitud fue exitosa. false: La solicitud falló.	true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "AccountName": "xxxxxx@163.com",
    "AdminUser": true,
    "AuthAdminUser": true,
    "NickName": "张三",
    "RoleIdList": [
      111111111
    ],
    "CopilotModules": [
      "qreport"
    ],
    "UserId": "b5d8fd9348cc4327****afb604",
    "UserType": 1
  },
  "Success": true
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	Organization.Developers.ReachedTheUpperLimit	The developers of the organization have reached the upper limit:%s	El número de desarrolladores de la organización ha alcanzado el límite máximo de %s. Póngase en contacto con el administrador de la organización para aumentar la cuota de desarrolladores.
400	Organization.Viewers.ReachedTheUpperLimit	The visitors of the organization have reached the upper limit:%s.	El número de visualizadores de la organización ha alcanzado el límite máximo de %s. Póngase en contacto con el administrador de la organización para aumentar la cuota de visualizadores.
400	Organization.Analysts.ReachedTheUpperLimit	The analysts of the organization have reached the upper limit:%s.	El número de analistas de la organización ha alcanzado el límite máximo de %s. Póngase en contacto con el administrador de la organización para aumentar la cuota de analistas.
400	NickName.AlreadyIn.Organization	The alias already exists.	El apodo ya existe.
400	User.AlreadyIn.Organization	This user is already a member of the current organization.	El usuario ya existe en otra organización.
400	Instance.Over.MaxLicense	You have reached the maximum number of users that can be added. Please upgrade the configurations or remove some users first.
400	AnalystUser.NotSupport.AdminOrDevRole	Analyst users do not support granting workspace administrator or developer roles.
400	Workspace.Not.Exist	The group workspace does not exist.	El espacio de trabajo de grupo no existe.
400	Workspace.Type.Error	The type of group workspace is invalid.	El tipo de espacio de trabajo de grupo no es válido.
400	Viewer.AddInTo.Workspace	Organization members with viewer type are not allowed to add to workspace: %s.	No se pueden agregar usuarios de tipo invitado de la organización al espacio de trabajo: %s.
400	User.AlreadyIn.Workspace	This user already exists.	El usuario ya existe en el espacio de trabajo.
400	User.AlreadyIn.Role	The user is already assigned this role.	El usuario ya tiene el rol especificado.
400	User.OrganizationRole.NotExist	User %s must have role in organization.	El usuario %s debe tener al menos un rol en la organización.
400	Viewer.CannotHave.CustomRole	Organization viewer cannot have custom roles.	Los visitantes de la organización no pueden tener roles personalizados.
400	UserAnalyst.NotSupport.ThisRole	This role has permissions that analysts cannot grant.	El rol tiene permisos que un analista no puede otorgar.
400	RoleCount.ExceedsLimit.Error	The user role cannot exceed three.	El número de roles de usuario no puede exceder 3.
400	BindRole.NotExist.Error	Bind role not exist, %s.	El rol vinculado no existe. %s.
400	DirtyData.Duplicate.User	Dirty data,duplicate user: %s.	Datos inconsistentes. Usuario duplicado: %s.
400	Robot.Module.Exhausted	The Quota of %s module has been exhausted.	Se ha agotado la cuota del módulo %s.

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.