Socotra

Socotra Auth API

The Auth API from Socotra — 41 operation(s) for auth.

Documentation GitHub OpenAPI

Operations 57

GET /auth/identity/passwordPolicy #

PUT /auth/identity/passwordPolicy #

POST /auth/users #

GET /auth/users/{locator}/tokens #

POST /auth/users/{locator}/tokens #

POST /auth/users/{locator}/revoke #

GET /auth/users/tokens #

POST /auth/users/tokens #

POST /auth/users/tokens/permissions #

POST /auth/roles #

GET /auth/roles/tenant/{tenantLocator}/{roleLocator} #

POST /auth/roles/tenant/{tenantLocator}/{roleLocator} #

PATCH /auth/roles/tenant/{tenantLocator}/{roleLocator} #

DELETE /auth/roles/tenant/{tenantLocator}/{roleLocator} #

POST /auth/identity #

POST /auth/identity/saml #

POST /auth/identity/oidc #

GET /auth/users/{locator} #

PATCH /auth/users/{locator} #

DELETE /auth/users/{locator} #

PATCH /auth/users/{locator}/tenants #

PATCH /auth/users/{locator}/roles #

PATCH /auth/users/{locator}/passwordreset #

PATCH /auth/users/{locator}/enable #

GET /auth/users/{locator}/dataaccess/{tenantLocator} #

PATCH /auth/users/{locator}/dataaccess/{tenantLocator} #

DELETE /auth/users/{locator}/dataaccess/{tenantLocator} #

GET /auth/users/{locator}/accessmask #

PATCH /auth/users/{locator}/accessmask #

GET /auth/tenants/{locator} #

PATCH /auth/tenants/{locator} #

PATCH /auth/tenants/{locator}/retire #

GET /auth/roles/{locator} #

PATCH /auth/roles/{locator} #

DELETE /auth/roles/{locator} #

GET /auth/users/{userLocator}/tenant/{tenantLocator}/permissions #

GET /auth/users/{locator}/permissions #

GET /auth/users/{locator}/dataaccess #

GET /auth/users/{locator}/credentialStatus #

GET /auth/users/{locator}/accessmask/{tenantLocator} #

DELETE /auth/users/{locator}/accessmask/{tenantLocator} #

GET /auth/users/{locator}/accessmask/{tenantLocator}/{type} #

GET /auth/users/whoami #

GET /auth/users/username/{username} #

GET /auth/users/list #

GET /auth/users/basic/list #

GET /auth/tenants/mytenants/list #

GET /auth/tenants/list #

GET /auth/roles/tenant/{tenantLocator}/list #

GET /auth/roles/permissions #

GET /auth/roles/list #

GET /auth/identity/instances #

GET /auth/identity/instances/{name} #

DELETE /auth/identity/instances/{name} #

DELETE /auth/users/{locator}/tokens/{tokenOrName} #

DELETE /auth/users/{locator}/credentials #

DELETE /auth/users/tokens/{tokenOrName} #

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/socotra/refs/heads/main/openapi/socotra-auth-api-openapi.yml

Other Resources

🔗

APIsJSON

https://raw.githubusercontent.com/api-evangelist/socotra/refs/heads/main/apis.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/socotra-auth-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Socotra Insurance Suite OpenAPI Definition Auth API
  description: Socotra Insurance Suite API
  termsOfService: https://www.socotra.com
  version: v0
servers:
- url: /
  description: Generated server url
tags:
- name: Auth
paths:
  /auth/identity/passwordPolicy:
    get:
      operationId: fetchPasswordPolicy
      parameters: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordPolicyResponse'
                deprecated: false
      x-securityGroup: identity
      x-securityPermission:
      - read
      - custom
      deprecated: false
      tags:
      - Auth
    put:
      operationId: updatePasswordPolicy
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasswordPolicyUpdateRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
      x-securityGroup: identity
      x-securityPermission:
      - add
      - custom
      deprecated: false
      tags:
      - Auth
  /auth/users:
    post:
      operationId: createUser
      parameters:
      - name: enableUser
        in: query
        description: When true, user will be active (enabled) even if password is not set. Useful for SSO since user cannot use any other credentials to log in
        required: false
        schema:
          type: boolean
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserCreateRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserResponse'
                deprecated: false
      x-securityGroup: users
      x-securityPermission:
      - add
      deprecated: false
      tags:
      - Auth
  /auth/users/{locator}/tokens:
    get:
      operationId: fetchAuthTokensForUser
      parameters:
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                deprecated: false
                items:
                  $ref: '#/components/schemas/AuthTokenResponse'
                  deprecated: false
      x-securityGroup: users
      x-securityPermission:
      - read
      - custom
      deprecated: false
      tags:
      - Auth
    post:
      operationId: createServiceAccountAuthToken
      parameters:
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthTokenCreateRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
                deprecated: false
      x-securityGroup: users
      x-securityPermission:
      - custom
      deprecated: false
      tags:
      - Auth
  /auth/users/{locator}/revoke:
    post:
      operationId: revokeUserOauthTokens
      parameters:
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      responses:
        '200':
          description: OK
      x-securityGroup: users
      x-securityPermission:
      - write
      - custom
      - revoke
      deprecated: false
      tags:
      - Auth
  /auth/users/tokens:
    get:
      operationId: fetchAuthTokens
      parameters: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                deprecated: false
                items:
                  $ref: '#/components/schemas/AuthTokenResponse'
                  deprecated: false
      x-securityGroup: users
      x-securityPermission:
      - read
      - custom
      deprecated: false
      tags:
      - Auth
    post:
      operationId: createAuthToken
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthTokenCreateRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
                deprecated: false
      x-securityGroup: users
      x-securityPermission:
      - write
      - token
      deprecated: false
      tags:
      - Auth
  /auth/users/tokens/permissions:
    post:
      operationId: getGroupedTokenPermissions
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: string
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                deprecated: false
                additionalProperties:
                  type: array
                  deprecated: false
                  items:
                    type: string
                    deprecated: false
      x-securityGroup: users
      x-securityPermission:
      - read
      - custom
      deprecated: false
      tags:
      - Auth
  /auth/roles:
    post:
      operationId: createRole
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleCreateRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleResponse'
                deprecated: false
      x-securityGroup: roles
      x-securityPermission:
      - add
      deprecated: false
      tags:
      - Auth
  /auth/roles/tenant/{tenantLocator}/{roleLocator}:
    get:
      operationId: getTenantRole
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: roleLocator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleResponse'
                deprecated: false
      x-securityGroup: roles
      x-securityPermission:
      - read
      deprecated: false
      tags:
      - Auth
    post:
      operationId: createTenantRole
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: roleLocator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTenantRoleReq'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleResponse'
                deprecated: false
      x-securityGroup: roles
      x-securityPermission:
      - add
      deprecated: false
      tags:
      - Auth
    patch:
      operationId: updateTenantRole
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: roleLocator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchTenantRoleReq'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleResponse'
                deprecated: false
      x-securityGroup: roles
      x-securityPermission:
      - update
      deprecated: false
      tags:
      - Auth
    delete:
      operationId: deleteTenantRole
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: roleLocator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      responses:
        '200':
          description: OK
      x-securityGroup: roles
      x-securityPermission:
      - delete
      deprecated: false
      tags:
      - Auth
  /auth/identity:
    post:
      operationId: createIdentityProvider
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SAMLIdentityProviderCreateRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityProviderResponse'
                deprecated: false
      x-securityGroup: identity
      x-securityPermission:
      - add
      - custom
      deprecated: true
      tags:
      - Auth
  /auth/identity/saml:
    post:
      operationId: addSAMLIdentityProvider
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SAMLIdentityProviderCreateRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityProviderResponse'
                deprecated: false
      x-securityGroup: identity
      x-securityPermission:
      - add
      - custom
      deprecated: false
      tags:
      - Auth
  /auth/identity/oidc:
    post:
      operationId: addOIDCIdentityProvider
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OIDCIdentityProviderCreateRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityProviderResponse'
                deprecated: false
      x-securityGroup: identity
      x-securityPermission:
      - add
      - custom
      deprecated: false
      tags:
      - Auth
  /auth/users/{locator}:
    get:
      operationId: fetchUserByLocator
      parameters:
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserResponse'
                deprecated: false
      x-securityGroup: users
      x-securityPermission:
      - custom
      - read
      deprecated: false
      tags:
      - Auth
    patch:
      operationId: updateUser
      parameters:
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserUpdateRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserResponse'
                deprecated: false
      x-securityGroup: users
      x-securityPermission:
      - update
      - custom
      deprecated: false
      tags:
      - Auth
    delete:
      operationId: deleteUser
      parameters:
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      responses:
        '200':
          description: OK
      x-securityGroup: users
      x-securityPermission:
      - delete
      deprecated: false
      tags:
      - Auth
  /auth/users/{locator}/tenants:
    patch:
      operationId: updateUserTenantAssignments
      parameters:
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserTenantsAssignmentsUpdateRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserResponse'
                deprecated: false
      x-securityGroup: users
      x-securityPermission:
      - update-tenants
      deprecated: false
      tags:
      - Auth
  /auth/users/{locator}/roles:
    patch:
      operationId: updateUserRoles
      parameters:
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserRolesUpdateRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserResponse'
                deprecated: false
      x-securityGroup: users
      x-securityPermission:
      - update-roles
      deprecated: false
      tags:
      - Auth
  /auth/users/{locator}/passwordreset:
    patch:
      operationId: resetUserPassword
      parameters:
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              type: string
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
      x-securityGroup: users
      x-securityPermission:
      - password-reset
      deprecated: false
      tags:
      - Auth
  /auth/users/{locator}/enable:
    patch:
      operationId: enableUser
      parameters:
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserResponse'
                deprecated: false
      x-securityGroup: users
      x-securityPermission:
      - enable
      deprecated: false
      tags:
      - Auth
  /auth/users/{locator}/dataaccess/{tenantLocator}:
    get:
      operationId: fetchUserDataAccessForTenant
      parameters:
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserDataAccessResponse'
                deprecated: false
      x-securityGroup: users
      x-securityPermission:
      - read
      deprecated: false
      tags:
      - Auth
    patch:
      operationId: addUserDataAccess
      parameters:
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserDataAccessRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserDataAccessResponse'
                deprecated: false
      x-securityGroup: users
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Auth
    delete:
      operationId: deleteUserDataAccess
      parameters:
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      responses:
        '200':
          description: OK
      x-securityGroup: users
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Auth
  /auth/users/{locator}/accessmask:
    get:
      operationId: fetchUserMasks
      parameters:
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                deprecated: false
                items:
                  $ref: '#/components/schemas/UserDataAccessControlMaskResponse'
                  deprecated: false
      x-securityGroup: users
      x-securityPermission:
      - read
      deprecated: true
      tags:
      - Auth
    patch:
      operationId: addDataSecurityMask
      parameters:
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserDataSecurityMaskRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserDataAccessControlMaskResponse'
                deprecated: false
      x-securityGroup: users
      x-securityPermission:
      - write
      deprecated: true
      tags:
      - Auth
  /auth/tenants/{locator}:
    get:
      operationId: fetchTenant
      parameters:
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantResponse'
                deprecated: false
      x-securityGroup: tenants
      x-securityPermission:
      - read
      deprecated: false
      tags:
      - Auth
    patch:
      operationId: updateTenant
      parameters:
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TenantUpdateRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantResponse'
                deprecated: false
      x-securityGroup: tenants
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Auth
  /auth/tenants/{locator}/retire:
    patch:
      operationId: retireTenant
      parameters:
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantResponse'
                deprecated: false
      x-securityGroup: tenants
      x-securityPermission:
      - retire
      deprecated: false
      tags:
      - Auth
  /auth/roles/{locator}:
    get:
      operationId: getRole
      parameters:
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleResponse'
                deprecated: false
      x-securityGroup: roles
      x-securityPermission:
      - read
      deprecated: false
      tags:
      - Auth
    patch:
      operationId: updateRole
      parameters:
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleUpdateRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleResponse'
                deprecated: false
      x-securityGroup: roles
      x-securityPermission:
      - update
      deprecated: false
      tags:
      - Auth
    delete:
      operationId: deleteRole
      parameters:
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      responses:
        '200':
          description: OK
      x-securityGroup: roles
      x-securityPermission:
      - delete
      deprecated: false
      tags:
      - Auth
  /auth/users/{userLocator}/tenant/{tenantLocator}/permissions:
    get:
      operationId: fetchUserTenantPermissions
      parameters:
      - name: userLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                deprecated: false
                items:
                  type: string
                  deprecated: false
      x-securityGroup: users
      x-securityPermission:
      - read
      - custom
      deprecated: false
      tags:
      - Auth
  /auth/users/{locator}/permissions:
    get:
      operationId: fetchUserPermissions
      parameters:
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                deprecated: false
                items:
                  type: string
                  deprecated: false
      x-securityGroup: users
      x-securityPermission:
      - read
      - custom
      deprecated: false
      tags:
      - Auth
  /auth/users/{locator}/dataaccess:
    get:
      operationId: fetchUserDataAccess
      parameters:
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                deprecated: false
                items:
                  $ref: '#/components/schemas/UserDataAccessResponse'
                  deprecated: false
      x-securityGroup: users
      x-securityPermission:
      - read
      deprecated: false
      tags:
      - Auth
  /auth/users/{locator}/credentialStatus:
    get:
      operationId: fetchCredentialStatus
      parameters:
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialResponse'
                deprecated: false
      x-securityGroup: users
      x-securityPermission:
      - read
      - custom
      deprecated: false
      tags:
      - Auth
  /auth/users/{locator}/accessmask/{tenantLocator}:
    get:
      operationId: fetchUserMasksForTenant
      parameters:
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                deprecated: false
                items:
                  $ref: '#/components/schemas/UserDataAccessControlMaskResponse'
                  deprecated: false
      x-securityGroup: users
      x-securityPermission:
      - read
      deprecated: true
      tags:
      - Auth
    delete:
      operationId: deleteUserMasks
      parameters:
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      responses:
        '200':
          description: OK
      x-securityGroup: users
      x-securityPermission:
      - write
      deprecated: true
      tags:
      - Auth
  /auth/users/{locator}/accessmask/{tenantLocator}/{type}:
    get:
      operationId: fetchUserMask
      parameters:
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: type
        in: path
        required: true
        schema:
          type: string
          enum:
          - account
          - policy
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserDataAccessControlMaskResponse'
                deprecated: false
      x-securityGroup: users
      x-securityPermission:
      - read
      deprecated: true
      tags:
      - Auth
  /auth/users/whoami:
    get:
      operationId: fetchMyUserDetails
      parameters: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserResponse'
                deprecated: false
      x-securityGroup: users
      x-securityPermission:
      - custom
      deprecated: false
      tags:
      - Auth
  /auth/users/username/{username}:
    get:
      operationId: fetchUserByName
      parameters:
      - name: username
        in: path
        required: true
        schema:
          type: string
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                deprecated: false
                items:
                  $ref: '#/components/schemas/UserResponse'
                  deprecated: false
      x-securityGroup: users
      x-securityPermission:
      - read
      deprecated: false
      tags:
      - Auth
  /auth/users/list:
    get:
      operationId: fetchMultipleUsers
      parameters:
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          format: int32
          deprecated: false
      - name: count
        in: query
        required: false
        schema:
          type: integer
          format: int32
          deprecated: false
      - name: extended
        in: query
        description: When false, returns a bare array.
        required: false
        schema:
          type: boolean
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserListResponse'
                deprecated: false
      x-securityGroup: users
      x-securityPermission:
      - read
      - list
      deprecated: false
      tags:
      - Auth
  /auth/users/basic/list:
    get:
      operationId: fetchMultipleBasicUsers
      description: This endpoint returns a simplified response and therefore has a higher count limit compared to 'fetchMultipleUsers'.
      parameters:
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          format: int32
          deprecated: false
      - name: count
        in: query
        required: false
        schema:
          type: integer
          format: int32
          deprecated: false
      - name: extended
        in: query
        required: false
        schema:
          type: boolean
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicUserResponse'
                deprecated: false
      x-securityGroup: users
      x-securityPermission:
      - read
      - list
      deprecated: false
      tags:
      - Auth
  /auth/tenants/mytenants/list:
    get:
      operationId: fetchMyTenants
      description: Returns a list of tenants you have access to.
      parameters:
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          format: int32
          deprecated: false
      - name: count
        in: query
        required: false
        schema:
          type: integer
          format: int32
          deprecated: false
      - name: extended
        in: query
        description: When false, returns a bare array.
        required: false
        schema:
          type: boolean
          deprecated: false
      responses:
        '

# --- truncated at 32 KB (58 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/socotra/refs/heads/main/openapi/socotra-auth-api-openapi.yml