> ## 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.

# Obter uma política inline de grupo pelo nome

<Info>
  Requer a ação do IAM **`workspace:GetInlinePolicy`**. 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 get /v1/groups/{group_id}/inline-policies/{policy_name}
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/groups/{group_id}/inline-policies/{policy_name}:
    parameters:
      - name: group_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          example: a1b2c3d4-e5f6-7890-1234-567890abcdef
      - name: policy_name
        description: >-
          Nome da política em linha. As ortografias UUID e o prefixo literal
          crn: são reservados e não podem ser usados ao criar uma política.
        in: path
        required: true
        schema:
          type: string
          example: S3BucketAccess
    get:
      tags:
        - Workspace
      summary: Obter uma política inline de grupo pelo nome
      operationId: getGroupInlinePolicy
      responses:
        '200':
          description: A política inline
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InlinePolicyResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - BearerAuth: []
components:
  schemas:
    InlinePolicyResponse:
      type: object
      properties:
        inline_policy:
          $ref: '#/components/schemas/InlinePolicy'
    InlinePolicy:
      type: object
      required:
        - crn
      properties:
        crn:
          type: string
          description: >-
            Identidade de política em linha com escopo principal canônico; os
            principais nomeados usam seu nome imutável, os usuários usam UUID.
          example: crn:workspace:::role/deployer/inline-policy/read-storage
        id:
          type: string
          format: uuid
          example: d4e5f6a7-b8c9-0123-4567-890abcdef123
        principal_id:
          type: string
          format: uuid
          example: 550e8400-e29b-41d4-a716-446655440000
        principal_type:
          type: string
          enum:
            - user
            - group
          example: user
        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: S3BucketAccess
        document:
          $ref: '#/components/schemas/PolicyDocument'
        created_at:
          type: string
          format: date-time
          example: '2026-01-15T09:30:00Z'
        updated_at:
          type: string
          format: date-time
          example: '2026-01-16T14:20:00Z'
    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
    PolicyDocument:
      type: object
      description: Documento de política estilo IAM
      required:
        - version
        - statements
      properties:
        version:
          type: string
          enum:
            - '2024-01-01'
          example: '2024-01-01'
        statements:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/PolicyStatement'
    PolicyStatement:
      type: object
      description: >
        Uma única declaração. O conjunto de ações é nomeado positivamente
        (`actions`) ou por exclusão (`not_actions`), e o conjunto de recursos da
        mesma forma (`resources` / `not_resources`) — exatamente um de cada par.
        Uma instrução que define ambos os lados de um par, ou nenhum, é
        rejeitada com `INVALID_INPUT` quando o documento é salvo.
      required:
        - effect
      allOf:
        - oneOf:
            - required:
                - actions
            - required:
                - not_actions
        - oneOf:
            - required:
                - resources
            - required:
                - not_resources
      properties:
        sid:
          type: string
          description: Identificador da declaração
          example: ReadOrganizationUsers
        effect:
          type: string
          enum:
            - allow
            - deny
          example: allow
        actions:
          type: array
          minItems: 1
          items:
            type: string
          description: Ações no formato service:action
          example:
            - workspace:GetUser
            - workspace:ListUsers
        not_actions:
          type: array
          minItems: 1
          items:
            type: string
          description: >
            A declaração cobre todas as ações *exceto* estas. Emparelha
            naturalmente com `effect: deny` para esculpir um buraco fora de um
            amplo allow; com `effect: allow` ele concede tudo o que os padrões
            listados não nomeiam, incluindo ações adicionadas por serviços
            futuros.
          example:
            - workspace:*
        resources:
          type: array
          minItems: 1
          items:
            type: string
          description: Identificadores ou padrões de recursos
          example:
            - crn:workspace:::user/*
        not_resources:
          type: array
          minItems: 1
          items:
            type: string
          description: >
            A declaração cobre todos os recursos *exceto* estes. Mesmo trade-off
            que `not_actions`: com `effect: allow` ele alcança recursos que
            ainda não existem.
          example:
            - crn:workspace:::user/*
        conditions:
          type: array
          description: Condições opcionais para a declaração
          items:
            $ref: '#/components/schemas/PolicyCondition'
    PolicyCondition:
      type: object
      description: Uma condição que deve ser satisfeita para que a instrução se aplique
      required:
        - operator
        - key
        - values
      properties:
        operator:
          type: string
          enum:
            - equals
            - not_equals
            - starts_with
            - ends_with
            - contains
            - in
            - not_in
            - greater_than
            - less_than
            - greater_than_or_equals
            - less_than_or_equals
            - exists
            - not_exists
            - ip_address
            - not_ip_address
          description: O operador de comparação
          example: equals
        key:
          type: string
          description: A chave de condição a avaliar
          example: s3:prefix
        values:
          type: array
          items:
            type: string
          description: Valores para comparar
          example:
            - home/
            - shared/
        set_operator:
          type: string
          enum:
            - for_all_values
            - for_any_value
          description: >
            Avalia `operator` contra uma chave de contexto multi-valor (um
            conjunto, como `basalt:TagKeys` — as chaves de tag que uma
            requisição carrega) em vez de um único valor. Omitir para uma
            condição de valor único comum.


            - `for_all_values` — mantém quando cada membro do conjunto de
            solicitação satisfaz `operator`. Um conjunto ausente ou vazio é
            mantido vacuamente, então uma requisição que não possui tags não é
            cercada por uma restrição de tag-chave.

            - `for_any_value` — mantém quando pelo menos um membro faz. Um
            conjunto ausente ou vazio não se mantém.
          example: for_all_values
  responses:
    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
    NotFound:
      description: Página não encontrada
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: NOT_FOUND
              message: Resource not found
              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.