> ## Documentation Index
> Fetch the complete documentation index at: https://docs.basaltic.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Adicionar usuário à organização

> Convide um usuário para a organização por email. Um e-mail de convite é sempre enviado e o usuário se junta ao aceitá-lo — não há nenhum caminho que adicione alguém sem o consentimento dele, mesmo que ele já tenha uma conta na plataforma. Convidar um membro existente ou alguém que já tenha um convite pendente é rejeitado com 409.

Opcionalmente, especifique grupos para adicionar o usuário na aceitação.


<Info>
  Requer a ação do IAM **`workspace:AddUser`**. Consulte [permissões de Workspace](/pt/workspace/permissions) para obter a lista completa, o que cada uma abrange e um exemplo de política.
</Info>


## OpenAPI

````yaml /pt/api-reference/specs/workspace.yaml post /v1/users
openapi: 3.0.3
info:
  title: Basaltic Workspace API
  version: 1.0.0
  description: >
    Gerenciamento de organização: organizações, contas, usuários humanos, grupos
    somente de usuários e políticas de organização. As identidades do IAM de
    conta podem receber políticas de organização explicitamente delegadas por
    meio dessa API. A autenticação pessoal permanece no endpoint do IAM.


    Os recursos da organização são globais e são resolvidos na organização
    autenticada.CRNs canônicos são crn:workspace:::<type>/<name-or-uuid>As
    políticas da organização são separadas das políticas de conta; as políticas
    de sistema compartilhadas usam crn:workspace:::system-policy/<name>.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://workspace.basaltic.sh
    description: Endpoint global da API
security:
  - BearerAuth: []
paths:
  /v1/users:
    post:
      tags:
        - Workspace
      summary: Adicionar usuário à organização
      description: >
        Convide um usuário para a organização por email. Um e-mail de convite é
        sempre enviado e o usuário se junta ao aceitá-lo — não há nenhum caminho
        que adicione alguém sem o consentimento dele, mesmo que ele já tenha uma
        conta na plataforma. Convidar um membro existente ou alguém que já tenha
        um convite pendente é rejeitado com 409.


        Opcionalmente, especifique grupos para adicionar o usuário na aceitação.
      operationId: addUser
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserAddRequest'
      responses:
        '201':
          description: Convite criado e enviado por e-mail
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserAddResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          description: O usuário já é membro ou tem um convite pendente
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - BearerAuth: []
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      description: >-
        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.
      required: false
      schema:
        type: string
        maxLength: 255
      example: 550e8400-e29b-41d4-a716-446655440000
  schemas:
    UserAddRequest:
      type: object
      additionalProperties: false
      required:
        - email
      properties:
        email:
          type: string
          format: email
          description: E-mail do usuário a adicionar
          example: john.doe@acme.com
        tags:
          $ref: '#/components/schemas/Tags'
        groups:
          type: array
          description: >-
            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.
          items:
            $ref: '#/components/schemas/GroupReference'
    UserAddResponse:
      type: object
      required:
        - invitation
        - status
      properties:
        invitation:
          $ref: '#/components/schemas/Invitation'
        status:
          type: string
          enum:
            - invited
          description: >
            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.
          example: invited
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              description: Código de erro identificando o tipo de erro
              example: INVALID_INPUT
            message:
              type: string
              description: Mensagem de erro legível pelo ser humano
              example: Invalid request parameters
            params:
              type: object
              additionalProperties: true
              description: >-
                Valores não sensíveis opcionais para interpolação de erros
                localizados, codificados por código de erro. Nunca presente para
                erros de servidor.
              example:
                instances: 2
                pools: 0
            request_id:
              type: string
              format: uuid
              description: Solicitar ID para depuração
              example: 550e8400-e29b-41d4-a716-446655440000
    Tags:
      type: object
      additionalProperties:
        type: string
      example:
        environment: production
        team: backend
    GroupReference:
      type: string
      description: >-
        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.
      example: crn:workspace:::group/developers
    Invitation:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          example: 550e8400-e29b-41d4-a716-446655440000
        email:
          type: string
          format: email
          description: Endereço de e-mail do usuário convidado
          example: jane.doe@example.com
        groups:
          type: array
          description: Grupos aos quais o usuário será adicionado após aceitar
          items:
            $ref: '#/components/schemas/GroupSummary'
        invited_by:
          type: object
          readOnly: true
          properties:
            id:
              type: string
              format: uuid
              example: 550e8400-e29b-41d4-a716-446655440000
            name:
              type: string
              example: John Doe
            email:
              type: string
              format: email
              example: john.doe@acme.com
              description: E-mail do convidado humano; omitido para identidades de máquina.
            type:
              type: string
              enum:
                - user
                - service_account
                - assumed_role
              description: >-
                Tipo de ator real. Convites de função assumida registram o UUID
                da sessão em id.
            crn:
              type: string
              description: >-
                CRN de usuário do Canonical Workspace ou conta IAM
                service-account/session CRN capturado quando convidado.
            account_id:
              type: string
              format: uuid
              description: >-
                Conta de proprietário para um convidado de conta de serviço ou
                função assumida; omitido para um convidado humano.
        status:
          type: string
          enum:
            - pending
            - accepted
            - expired
            - cancelled
          readOnly: true
          example: pending
        expires_at:
          type: string
          format: date-time
          readOnly: true
          example: '2026-01-22T09:30:00Z'
        created_at:
          type: string
          format: date-time
          readOnly: true
          example: '2026-01-15T09:30:00Z'
        crn:
          type: string
          readOnly: true
          example: crn:workspace:::invitation/550e8400-e29b-41d4-a716-446655440002
    GroupSummary:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: a1b2c3d4-e5f6-7890-1234-567890abcdef
        name:
          description: >-
            Os nomes de recursos não devem começar com o prefixo literal crn: ou
            ser UUIDs (formas canônicas, compactas, entre colchetes ou
            urn:uuid:, em qualquer caso).
          type: string
          example: developers
  responses:
    BadRequest:
      description: Parâmetros de solicitação inválidos
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INVALID_INPUT
              message: Invalid request parameters
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Unauthorized:
      description: Autenticação necessária ou token inválido
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Authentication required
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Forbidden:
      description: Permissões insuficientes
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: ACCESS_DENIED
              message: You don't have permission to perform this action
              request_id: 550e8400-e29b-41d4-a716-446655440000
    UnprocessableEntity:
      description: >
        A solicitação está bem formada, mas não pode ser processada conforme
        enviada. Nas operações que aceitam `Idempotency-Key` este é o caso de
        reutilização de chave: a chave foi vista pela primeira vez com uma carga
        de solicitação diferente, então reproduzir o resultado armazenado
        responderia a uma pergunta que o chamador não fez.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: IDEMPOTENCY_KEY_REUSED
              message: >-
                This Idempotency-Key was already used with a different request
                payload
              request_id: 550e8400-e29b-41d4-a716-446655440000
    InternalServerError:
      description: Erro interno do servidor
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INTERNAL_ERROR
              message: An internal error occurred
              request_id: 550e8400-e29b-41d4-a716-446655440000
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >+
        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ê.


        ```

        curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \
          https://iam.basaltic.sh/v1/oauth/token
        ```


        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.


````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.