HashiCorp Vault Group Alias API

openapi: 3.1.0
info:
  title: HashiCorp Vault Vault Auth Methods AppRole Group Alias API
  description: APIs for authentication methods in HashiCorp Vault including Token, AppRole, Kubernetes, LDAP, JWT/OIDC, GitHub, Userpass, and AWS auth methods. These endpoints handle user and machine authentication to obtain Vault tokens.
  version: '1.0'
  contact:
    name: HashiCorp Support
    email: support@hashicorp.com
    url: https://support.hashicorp.com/
  license:
    name: Business Source License 1.1
    url: https://github.com/hashicorp/vault/blob/main/LICENSE
servers:
- url: https://vault.example.com/v1
  description: Vault Server
security:
- vaultToken: []
tags:
- name: Group Alias
  description: Identity group alias management
paths:
  /identity/group-alias:
    post:
      operationId: createGroupAlias
      summary: HashiCorp Vault Create group alias
      description: Creates a group alias that maps an external group from an auth method to a Vault identity group.
      tags:
      - Group Alias
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupAliasRequest'
      responses:
        '200':
          description: Group alias created
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        description: Group alias ID
                      canonical_id:
                        type: string
                        description: Group ID
        '400':
          description: Invalid request
        '403':
          description: Permission denied
  /identity/group-alias/id/{id}:
    get:
      operationId: readGroupAlias
      summary: HashiCorp Vault Read group alias
      description: Reads the group alias with the given ID.
      tags:
      - Group Alias
      parameters:
      - name: id
        in: path
        required: true
        description: Group alias ID
        schema:
          type: string
      responses:
        '200':
          description: Group alias returned
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/GroupAlias'
        '404':
          description: Group alias not found
    post:
      operationId: updateGroupAlias
      summary: HashiCorp Vault Update group alias
      description: Updates the group alias with the given ID.
      tags:
      - Group Alias
      parameters:
      - name: id
        in: path
        required: true
        description: Group alias ID
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupAliasRequest'
      responses:
        '200':
          description: Group alias updated
        '400':
          description: Invalid request
    delete:
      operationId: deleteGroupAlias
      summary: HashiCorp Vault Delete group alias
      description: Deletes the group alias with the given ID.
      tags:
      - Group Alias
      parameters:
      - name: id
        in: path
        required: true
        description: Group alias ID
        schema:
          type: string
      responses:
        '204':
          description: Group alias deleted
components:
  schemas:
    GroupAliasRequest:
      type: object
      required:
      - name
      - mount_accessor
      - canonical_id
      properties:
        name:
          type: string
          description: Name of the alias (external group identifier)
        mount_accessor:
          type: string
          description: Auth mount accessor
        canonical_id:
          type: string
          description: Group ID to associate with
    GroupAlias:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the alias
        canonical_id:
          type: string
          description: Group ID this alias belongs to
        mount_accessor:
          type: string
          description: Auth mount accessor
        mount_path:
          type: string
          description: Auth mount path
        mount_type:
          type: string
          description: Auth mount type
        name:
          type: string
          description: Name of the alias (external group name)
        creation_time:
          type: string
          format: date-time
        last_update_time:
          type: string
          format: date-time
  securitySchemes:
    vaultToken:
      type: apiKey
      in: header
      name: X-Vault-Token
      description: Vault authentication token
externalDocs:
  description: Vault Auth Methods API Documentation
  url: https://developer.hashicorp.com/vault/api-docs/auth