Skip to main content
POST
Adicionar usuário à organização
Requer a ação do IAM workspace:AddUser. Consulte permissões de Workspace para obter a lista completa, o que cada uma abrange e um exemplo de política.

Authorizations

Authorization
string
header
required

Um token bearer OAuth 2.0, enviado como Authorization: Bearer <token>. Esta é a forma recomendada de autenticação.

Obtenha o token trocando o par de chaves de acesso de uma conta de serviço em POST /v1/oauth/token com grant_type=client_credentials. Esse é o fluxo padrão de credenciais de cliente; bibliotecas compatíveis com OAuth podem obter e renovar o token para você.

Os tokens duram uma hora por padrão. O mesmo par de chaves de acesso também serve como credencial AWS SigV4 para o endpoint de objetos compatível com S3, que aceita somente esse método de autenticação.

Headers

Idempotency-Key
string

Chave opcional gerada pelo cliente que torna uma criação segura para reprodução. A reintentar uma solicitação com a mesma chave retorna o resultado original literalmente em vez de criar um recurso duplicado. A reutilização de uma chave com um corpo de solicitação diferente é rejeitada (422); uma solicitação cuja chave ainda está sendo processada retorna 409. Os registros são honrados por 24 horas. Use um UUID ou token exclusivo semelhante.

Maximum string length: 255

Body

application/json
email
string<email>
required

E-mail do usuário a adicionar

Example:

"john.doe@acme.com"

tags
object
Example:
groups
string[]

Grupos a serem atribuídos quando o convite for aceito. Cada referência é validada na organização do chamador antes que o convite seja criado.

UUID do grupo, nome imutável na organização autenticada ou um CRN do espaço de trabalho na organização autenticada. Os grupos contêm apenas usuários.

Response

Convite criado e enviado por e-mail

invitation
object
required
status
enum<string>
required

Sempre invited — adicionar um usuário sempre passa por um convite que o convidado tem que aceitar, independentemente de já ter ou não uma conta na plataforma.

Available options:
invited
Example:

"invited"