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/secureauth:secureauth-tokens-api"

All apis

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

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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: Secureauth Tokens API
  version: latest
  description: 'Operations tagged tokens across 4 of this provider''s published API definitions: secureauth-admin-openapi.yml, secureauth-permissions-openapi.yml, secureauth-public-openapi.yml, secureauth-system-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://localhost:8443/api/admin/default
- url: https://localhost:8443/api/permissions/default
- url: https://localhost:8443/default/default
- url: https://localhost:8443/api/system/default
tags:
- name: Tokens
paths:
  /pools/{ipID}/tokens:
    delete:
      description: 'Revoke tokens for given set of userIds (min 1, max 100 userIds can be specified).


        Tokens includes access and refresh tokens but also authorization codes, authorization requests,

        sso sessions and scopes grants.'
      operationId: revokeTokensByPool
      parameters:
      - description: A server will only return requested resources if the resource matches one of the listed ETag value
        in: header
        name: if-match
        schema:
          type: string
          format: etag
      - description: Unique identifier included in audit events for request tracking
        in: header
        name: x-correlation-id
        schema:
          type: string
      - description: Key used to safely retry failed requests without duplicate processing
        in: header
        name: x-idempotency-key
        schema:
          type: string
      - description: Identity pool id
        in: path
        name: ipID
        required: true
        schema:
          type: string
          default: default
      responses:
        '204':
          description: ' tokens revoked'
        '401':
          $ref: '#/components/responses/unauthorizedHTTPError'
        '403':
          $ref: '#/components/responses/forbiddenHTTPError'
        '404':
          $ref: '#/components/responses/notFoundHTTPError'
        '422':
          $ref: '#/components/responses/unprocessableEntityHTTPError'
      security:
      - admin: []
      summary: Revoke tokens for users in pool
      tags:
      - Tokens
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RevokeTokensByPoolRequest'
    servers:
    - url: https://localhost:8443/api/admin/default
  /servers/{wid}/tokens:
    delete:
      description: 'Revoke tokens for given set of subjects (min 1, max 100 subjects can be specified).


        Tokens includes access and refresh tokens but also authorization codes, authorization requests,

        sso sessions and scopes grants.


        Optional IDP id if provided will recalculate subjects values if server is using hashed subject type.'
      operationId: revokeTokens
      parameters:
      - description: A server will only return requested resources if the resource matches one of the listed ETag value
        in: header
        name: if-match
        schema:
          type: string
          format: etag
      - description: Unique identifier included in audit events for request tracking
        in: header
        name: x-correlation-id
        schema:
          type: string
      - description: Key used to safely retry failed requests without duplicate processing
        in: header
        name: x-idempotency-key
        schema:
          type: string
      - description: Authorization server id
        in: path
        name: wid
        required: true
        schema:
          type: string
          default: default
      responses:
        '204':
          description: ' tokens revoked'
        '401':
          $ref: '#/components/responses/unauthorizedHTTPError'
        '403':
          $ref: '#/components/responses/forbiddenHTTPError'
        '404':
          $ref: '#/components/responses/notFoundHTTPError'
        '422':
          $ref: '#/components/responses/unprocessableEntityHTTPError'
      security:
      - admin: []
      summary: Revoke tokens
      tags:
      - Tokens
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RevokeTokenRequest'
    servers:
    - url: https://localhost:8443/api/admin/default
  /admin/systems/{psID}/tokens:
    get:
      description: Lists permission system tokens.
      operationId: listTokens
      parameters:
      - description: A server will only return requested resources if the resource matches one of the listed ETag value
        in: header
        name: if-match
        schema:
          type: string
          format: etag
      - description: Unique identifier included in audit events for request tracking
        in: header
        name: x-correlation-id
        schema:
          type: string
      - description: Key used to safely retry failed requests without duplicate processing
        in: header
        name: x-idempotency-key
        schema:
          type: string
      - in: path
        name: psID
        required: true
        schema:
          type: string
      responses:
        '200':
          $ref: '#/components/responses/TokensResponse'
        '401':
          $ref: '#/components/responses/unauthorizedHTTPError'
        '403':
          $ref: '#/components/responses/forbiddenHTTPError'
        '429':
          $ref: '#/components/responses/tooManyRequestsHTTPError'
      security:
      - admin: []
      summary: List permission system tokens
      tags:
      - Tokens
    post:
      description: Creates a permission system token.
      operationId: createToken
      parameters:
      - description: A server will only return requested resources if the resource matches one of the listed ETag value
        in: header
        name: if-match
        schema:
          type: string
          format: etag
      - description: Unique identifier included in audit events for request tracking
        in: header
        name: x-correlation-id
        schema:
          type: string
      - description: Key used to safely retry failed requests without duplicate processing
        in: header
        name: x-idempotency-key
        schema:
          type: string
      - in: path
        name: psID
        required: true
        schema:
          type: string
      responses:
        '201':
          $ref: '#/components/responses/TokenResponse'
        '400':
          $ref: '#/components/responses/badRequestHTTPError'
        '401':
          $ref: '#/components/responses/unauthorizedHTTPError'
        '403':
          $ref: '#/components/responses/forbiddenHTTPError'
        '404':
          $ref: '#/components/responses/notFoundHTTPError'
        '409':
          $ref: '#/components/responses/conflictHTTPError'
        '422':
          $ref: '#/components/responses/unprocessableEntityHTTPError'
        '429':
          $ref: '#/components/responses/tooManyRequestsHTTPError'
      security:
      - admin: []
      summary: Create permission system token
      tags:
      - Tokens
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Token'
    servers:
    - url: https://localhost:8443/api/permissions/default
  /admin/systems/{psID}/tokens/{tokenID}:
    delete:
      description: Deletes permission system token.
      operationId: deleteToken
      parameters:
      - description: A server will only return requested resources if the resource matches one of the listed ETag value
        in: header
        name: if-match
        schema:
          type: string
          format: etag
      - description: Unique identifier included in audit events for request tracking
        in: header
        name: x-correlation-id
        schema:
          type: string
      - description: Key used to safely retry failed requests without duplicate processing
        in: header
        name: x-idempotency-key
        schema:
          type: string
      - in: path
        name: psID
        required: true
        schema:
          type: string
      - in: path
        name: tokenID
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ' Permission system token has been deleted'
        '401':
          $ref: '#/components/responses/unauthorizedHTTPError'
        '403':
          $ref: '#/components/responses/forbiddenHTTPError'
        '404':
          $ref: '#/components/responses/notFoundHTTPError'
        '429':
          $ref: '#/components/responses/tooManyRequestsHTTPError'
      security:
      - admin: []
      summary: Delete permission system token
      tags:
      - Tokens
    get:
      description: Gets permission system token.
      operationId: getToken
      parameters:
      - description: A server will only return requested resources if the resource matches one of the listed ETag value
        in: header
        name: if-match
        schema:
          type: string
          format: etag
      - description: Unique identifier included in audit events for request tracking
        in: header
        name: x-correlation-id
        schema:
          type: string
      - description: Key used to safely retry failed requests without duplicate processing
        in: header
        name: x-idempotency-key
        schema:
          type: string
      - in: path
        name: psID
        required: true
        schema:
          type: string
      - in: path
        name: tokenID
        required: true
        schema:
          type: string
      responses:
        '200':
          $ref: '#/components/responses/TokenResponse'
        '401':
          $ref: '#/components/responses/unauthorizedHTTPError'
        '403':
          $ref: '#/components/responses/forbiddenHTTPError'
        '404':
          $ref: '#/components/responses/notFoundHTTPError'
        '429':
          $ref: '#/components/responses/tooManyRequestsHTTPError'
      security:
      - admin: []
      summary: Get permission system token
      tags:
      - Tokens
    put:
      description: Updates permission system token.
      operationId: updateToken
      parameters:
      - description: A server will only return requested resources if the resource matches one of the listed ETag value
        in: header
        name: if-match
        schema:
          type: string
          format: etag
      - description: Unique identifier included in audit events for request tracking
        in: header
        name: x-correlation-id
        schema:
          type: string
      - description: Key used to safely retry failed requests without duplicate processing
        in: header
        name: x-idempotency-key
        schema:
          type: string
      - in: path
        name: psID
        required: true
        schema:
          type: string
      - in: path
        name: tokenID
        required: true
        schema:
          type: string
      responses:
        '200':
          $ref: '#/components/responses/TokenResponse'
        '400':
          $ref: '#/components/responses/badRequestHTTPError'
        '401':
          $ref: '#/components/responses/unauthorizedHTTPError'
        '403':
          $ref: '#/components/responses/forbiddenHTTPError'
        '404':
          $ref: '#/components/responses/notFoundHTTPError'
        '409':
          $ref: '#/components/responses/conflictHTTPError'
        '422':
          $ref: '#/components/responses/unprocessableEntityHTTPError'
        '429':
          $ref: '#/components/responses/tooManyRequestsHTTPError'
      security:
      - admin: []
      summary: Update permission system token
      tags:
      - Tokens
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Token'
    servers:
    - url: https://localhost:8443/api/permissions/default
  /tokens:
    delete:
      description: 'Revokes tokens associated with the subject in the provided access token.


        Tokens includes access, refresh tokens and sso sessions.


        The optional `revoke_current_token` query parameter can be used to specify whether to revoke the current token as well (default: false).


        If `revoke_current_token` is set to `true`, all access tokens, refresh tokens, and SSO session will also be revoked.

        If `revoke_current_token` is set to `false`, the current access token, corresponding refresh token, and SSO session will remain active.'
      operationId: deleteTokens
      parameters:
      - description: Optional flag to revoke current token
        in: query
        name: revoke_current_token
        schema:
          type: boolean
          default: false
      responses:
        '204':
          description: ' Tokens have been revoked'
        '401':
          $ref: '#/components/responses/unauthorizedHTTPError'
        '403':
          $ref: '#/components/responses/forbiddenHTTPError'
        '429':
          $ref: '#/components/responses/tooManyRequestsHTTPError'
      security:
      - default:
        - manage_tokens
      summary: Revoke tokens
      tags:
      - Tokens
      x-operation-id-source: normalized
      x-operation-id-original: revokeTokens
    servers:
    - url: https://localhost:8443/default/default
components:
  responses:
    unprocessableEntityHTTPError:
      description: Unprocessable entity
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    forbiddenHTTPError:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    notFoundHTTPError:
      description: Not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    unauthorizedHTTPError:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    TokenResponse:
      description: Permission system token
      headers:
        etag:
          description: 'The ETag HTTP header is an identifier for a specific version of a resource


            in:header'
          schema:
            type: string
            format: etag
        x-external-error:
          description: 'Indicates that a 5xx error was caused by tenant-provided code


            in:header'
          schema:
            type: string
        x-trace-id:
          description: 'OpenTelemetry trace identifier


            in:header'
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Token'
    TokensResponse:
      description: Permission system tokens
      headers:
        etag:
          description: 'The ETag HTTP header is an identifier for a specific version of a resource


            in:header'
          schema:
            type: string
            format: etag
        x-external-error:
          description: 'Indicates that a 5xx error was caused by tenant-provided code


            in:header'
          schema:
            type: string
        x-trace-id:
          description: 'OpenTelemetry trace identifier


            in:header'
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Tokens'
    conflictHTTPError:
      description: Conflict
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    tooManyRequestsHTTPError:
      description: Too many requests
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    badRequestHTTPError:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    RevokeTokensByPoolRequest:
      properties:
        users:
          description: list of userIds (min 1, max 100)
          items:
            format: userID
            type: string
          type: array
      type: object
    RevokeTokenRequest:
      properties:
        idp_id:
          description: optional idp id - if provided subjects will be recalculated if server is using hashed subject type
          format: idpID
          type: string
        subjects:
          description: list of subjects (min 1, max 100)
          items:
            format: subject
            type: string
          type: array
      type: object
    Error:
      description: HTTP error response
      properties:
        details:
          type: object
        error:
          type: string
        error_code:
          type: string
        status_code:
          format: int64
          type: integer
      type: object
    Tokens:
      properties:
        tokens:
          items:
            $ref: '#/components/schemas/Token'
          type: array
      type: object
    Token:
      properties:
        created_at:
          format: date-time
          type: string
        description:
          type: string
        hashed_key:
          readOnly: true
          type: string
        id:
          example: default
          format: tokenID
          type: string
        key:
          type: string
        name:
          type: string
        system_id:
          example: default
          format: systemID
          type: string
        tenant_id:
          example: default
          format: tenantID
          type: string
        updated_at:
          format: date-time
          type: string
      required:
      - system_id
      - name
      type: object
  securitySchemes:
    admin:
      type: oauth2
      flows:
        authorizationCode:
          scopes: {}
          authorizationUrl: /default/admin/oauth2/authorize
          tokenUrl: /default/admin/oauth2/token
    token:
      in: header
      name: X-API-KEY
      type: apiKey
    default:
      type: oauth2
      flows:
        authorizationCode:
          scopes:
            list_clients_with_access: list_clients_with_access
            manage_consents: manage_consents
            manage_post_authn: manage_post_authn
            manage_sessions: manage_sessions
            revoke_client_access: revoke_client_access
            transient_otp: transient_otp
            view_consents: view_consents
            view_sessions: view_sessions
          authorizationUrl: /default/default/oauth2/authorize
          tokenUrl: /default/default/oauth2/token
    system:
      type: oauth2
      flows:
        authorizationCode:
          scopes:
            introspect_tokens: introspect_tokens
            manage_clients: manage_clients
            manage_configuration: manage_configuration
            manage_consents: manage_consents
            manage_idps: manage_idps
            manage_logins: manage_logins
            manage_post_authn: manage_post_authn
            manage_scope_grants: manage_scope_grants
            push_gateway_requests: push_gateway_requests
            read_configuration: read_configuration
            read_gateway_configuration: read_gateway_configuration
            view_audit_events: view_audit_events
            view_clients: view_clients
            view_consents: view_consents
            write_gateway_configuration: write_gateway_configuration
          authorizationUrl: /default/system/oauth2/authorize
          tokenUrl: /default/system/oauth2/token
x-refined-from:
- secureauth-admin-openapi.yml
- secureauth-permissions-openapi.yml
- secureauth-public-openapi.yml
- secureauth-system-openapi.yml