Auth0 refresh-tokens API

openapi: 3.2.0
info:
  title: Auth0 Management Refresh Tokens API
  description: Auth0 Management API v2.
  termsOfService: https://auth0.com/web-terms/
  contact:
    name: Auth0 Support
    url: https://support.auth0.com
  version: '2.0'
servers:
- url: https://{tenantDomain}/api/v2
  variables:
    tenantDomain:
      default: '{TENANT}.auth0.com'
      description: Auth0 Tenant Domain
security:
- bearerAuth: []
tags:
- name: refresh-tokens
paths:
  /refresh-tokens:
    get:
      summary: Get Refresh Tokens
      description: Retrieve a paginated list of refresh tokens for a specific user, with optional filtering by client ID. Results are sorted by credential_id ascending.
      tags:
      - refresh-tokens
      parameters:
      - name: user_id
        in: query
        description: ID of the user whose refresh tokens to retrieve. Required.
        required: true
        schema:
          type: string
      - name: client_id
        in: query
        description: Filter results by client ID. Only valid when user_id is provided.
        schema:
          type: string
      - name: from
        in: query
        description: An opaque cursor from which to start the selection (exclusive). Expires after 24 hours. Obtained from the next property of a previous response.
        schema:
          type: string
      - name: take
        in: query
        description: Number of results per page. Defaults to 50.
        schema:
          type: integer
          minimum: 1
          maximum: 100
      - name: fields
        in: query
        description: Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields.
        schema:
          type: string
      - name: include_fields
        in: query
        description: Whether specified fields are to be included (true) or excluded (false).
        schema:
          type: boolean
      responses:
        '200':
          description: The refresh tokens were retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRefreshTokensPaginatedResponseContent'
        '400':
          description: Missing required 'user_id' parameter.
          x-description-1: The checkpoint ID provided in the 'from' parameter has expired or is invalid, please remove the checkpoint ID and try again
        '401':
          description: Invalid token.
          x-description-1: Invalid signature received for JSON Web Token validation
        '403':
          description: 'Insufficient scope, expected any of: read:refresh_tokens'
        '404':
          description: User not found
          x-description-1: The client does not exist.
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: get_refresh_tokens
      x-release-lifecycle: EA
      x-operation-name: list
      x-operation-request-parameters-name: GetRefreshTokensRequestParameters
      x-operation-group: refreshTokens
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:refresh_tokens
  /refresh-tokens/revoke:
    post:
      summary: Revoke Refresh Tokens
      description: Revoke refresh tokens in bulk by ID list, user, user+client, or client.
      tags:
      - refresh-tokens
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RevokeRefreshTokensRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/RevokeRefreshTokensRequestContent'
      responses:
        '202':
          description: Refresh token revocation request accepted.
        '400':
          description: Invalid request body. The message will vary depending on the cause.
          x-description-1: Invalid combination of parameters.
          x-description-2: 'API doesn''t support Online Refresh Tokens. To revoke an Online Refresh Token, use the Sessions API: POST /api/v2/sessions/{session_id}/revoke'
          x-description-3: User not found.
          x-description-4: Client not found.
        '401':
          description: Invalid token.
          x-description-1: Invalid signature received for JSON Web Token validation.
        '403':
          description: 'Insufficient scope; expected: delete:refresh_tokens'
          x-description-1: This feature is not enabled for this tenant.
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: revoke_refresh_tokens
      x-release-lifecycle: EA
      x-operation-name: revoke
      x-operation-group: refreshTokens
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - delete:refresh_tokens
  /refresh-tokens/{id}:
    get:
      summary: Get a Refresh Token
      description: Retrieve refresh token information.
      tags:
      - refresh-tokens
      parameters:
      - name: id
        in: path
        description: ID refresh token to retrieve
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The refresh token was retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRefreshTokenResponseContent'
        '400':
          description: API doesn't support Online Refresh Tokens
        '401':
          description: Invalid token.
          x-description-1: Invalid signature received for JSON Web Token validation
        '403':
          description: 'Insufficient scope, expected: read:refresh_tokens'
        '404':
          description: The refresh token does not exist.
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: get_refresh_token
      x-release-lifecycle: GA
      x-operation-name: get
      x-operation-group: refreshTokens
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:refresh_tokens
    delete:
      summary: Delete a Refresh Token
      description: Delete a refresh token by its ID.
      tags:
      - refresh-tokens
      parameters:
      - name: id
        in: path
        description: ID of the refresh token to delete.
        required: true
        schema:
          type: string
      responses:
        '202':
          description: Refresh token deletion request accepted.
        '400':
          description: Invalid request URI. The message will vary depending on the cause.
          x-description-1: 'API doesn''t support Online Refresh Tokens. To revoke an Online Refresh Token, use the Sessions API: POST /api/v2/sessions/{session_id}/revoke'
        '401':
          description: Invalid token.
          x-description-1: Invalid signature received for JSON Web Token validation.
        '403':
          description: 'Insufficient scope; expected: delete:refresh_tokens'
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: delete_refresh_token
      x-release-lifecycle: GA
      x-operation-name: delete
      x-operation-group: refreshTokens
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - delete:refresh_tokens
    patch:
      summary: Update a Refresh Token
      description: Update a refresh token by its ID.
      tags:
      - refresh-tokens
      parameters:
      - name: id
        in: path
        description: ID of the refresh token to update.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRefreshTokenRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateRefreshTokenRequestContent'
      responses:
        '200':
          description: Refresh token successfully updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateRefreshTokenResponseContent'
        '400':
          description: Invalid request URI. The message will vary depending on the cause.
          x-description-1: Invalid request body. The message will vary depending on the cause.
        '401':
          description: Invalid token.
          x-description-1: Invalid signature received for JSON Web Token validation.
        '403':
          description: 'Insufficient scope; expected: update:refresh_tokens.'
          x-description-1: The account is not allowed to perform this operation.
          x-description-2: Subscription missing entitlement.
          x-description-3: This feature is not enabled for this tenant.
        '404':
          description: The refresh token does not exist.
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: patch_refresh-tokens_by_id
      x-release-lifecycle: GA
      x-operation-name: update
      x-operation-group: refreshTokens
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - update:refresh_tokens
components:
  schemas:
    GetRefreshTokensPaginatedResponseContent:
      type: object
      additionalProperties: true
      properties:
        refresh_tokens:
          type: array
          items:
            $ref: '#/components/schemas/RefreshTokenResponseContent'
        next:
          type: string
          description: A cursor to be used as the "from" query parameter for the next page of results.
    RefreshTokenDateObject:
      type: object
      description: The date and time when the refresh token was created
      additionalProperties: true
    RefreshTokenMetadata:
      type:
      - object
      - 'null'
      description: Metadata associated with the refresh token, in the form of an object with string values (max 255 chars). Maximum of 25 metadata properties allowed.
      additionalProperties: true
      maxProperties: 25
    UpdateRefreshTokenRequestContent:
      type: object
      additionalProperties: false
      minProperties: 1
      properties:
        refresh_token_metadata:
          $ref: '#/components/schemas/RefreshTokenMetadata'
          description: Metadata associated with the refresh token. Pass null or {} to remove all metadata.
    RefreshTokenDevice:
      type: object
      description: Device used while issuing/exchanging the refresh token
      additionalProperties: true
      properties:
        initial_ip:
          type: string
          description: First IP address associated with the refresh token
        initial_asn:
          type: string
          description: First autonomous system number associated with the refresh token
        initial_user_agent:
          type: string
          description: First user agent associated with the refresh token
        last_ip:
          type: string
          description: Last IP address associated with the refresh token
        last_asn:
          type: string
          description: Last autonomous system number associated with the refresh token
        last_user_agent:
          type: string
          description: Last user agent associated with the refresh token
    RefreshTokenSessionId:
      type:
      - string
      - 'null'
      description: ID of the authenticated session used to obtain this refresh-token
    RevokeRefreshTokensRequestContent:
      type: object
      description: 'Exactly one of the following combinations must be provided: `ids` (up to 100 token IDs); `user_id`; `user_id` + `client_id`; or `client_id` alone. `ids` cannot be combined with `user_id` or `client_id`.'
      additionalProperties: false
      properties:
        ids:
          type: array
          description: Array of refresh token IDs to revoke. Limited to 100 at a time.
          minItems: 1
          items:
            type: string
            minLength: 1
            maxLength: 30
        user_id:
          type: string
          description: Revoke all refresh tokens for this user.
          minLength: 1
          maxLength: 300
          format: user-id
        client_id:
          type: string
          description: Revoke all refresh tokens for this client.
          minLength: 1
          maxLength: 64
          format: client-id
    RefreshTokenResponseContent:
      type: object
      additionalProperties: true
      properties:
        id:
          type: string
          description: The ID of the refresh token
        user_id:
          type: string
          description: ID of the user which can be used when interacting with other APIs.
          default: auth0|507f1f77bcf86cd799439020
        created_at:
          $ref: '#/components/schemas/RefreshTokenDate'
        idle_expires_at:
          $ref: '#/components/schemas/RefreshTokenDate'
        expires_at:
          $ref: '#/components/schemas/RefreshTokenDate'
        device:
          $ref: '#/components/schemas/RefreshTokenDevice'
        client_id:
          type: string
          description: ID of the client application granted with this refresh token
        session_id:
          $ref: '#/components/schemas/RefreshTokenSessionId'
        rotating:
          type: boolean
          description: True if the token is a rotating refresh token
        resource_servers:
          type: array
          description: A list of the resource server IDs associated to this refresh-token and their granted scopes
          items:
            $ref: '#/components/schemas/RefreshTokenResourceServer'
        refresh_token_metadata:
          $ref: '#/components/schemas/RefreshTokenMetadata'
        last_exchanged_at:
          $ref: '#/components/schemas/RefreshTokenDate'
    RefreshTokenDate:
      oneOf:
      - type: string
        description: The date and time when the refresh token was created
        format: date-time
      - $ref: '#/components/schemas/RefreshTokenDateObject'
      - type: 'null'
    GetRefreshTokenResponseContent:
      type: object
      additionalProperties: true
      properties:
        id:
          type: string
          description: The ID of the refresh token
        user_id:
          type: string
          description: ID of the user which can be used when interacting with other APIs.
          default: auth0|507f1f77bcf86cd799439020
        created_at:
          $ref: '#/components/schemas/RefreshTokenDate'
        idle_expires_at:
          $ref: '#/components/schemas/RefreshTokenDate'
        expires_at:
          $ref: '#/components/schemas/RefreshTokenDate'
        device:
          $ref: '#/components/schemas/RefreshTokenDevice'
        client_id:
          type: string
          description: ID of the client application granted with this refresh token
        session_id:
          $ref: '#/components/schemas/RefreshTokenSessionId'
        rotating:
          type: boolean
          description: True if the token is a rotating refresh token
        resource_servers:
          type: array
          description: A list of the resource server IDs associated to this refresh-token and their granted scopes
          items:
            $ref: '#/components/schemas/RefreshTokenResourceServer'
        refresh_token_metadata:
          $ref: '#/components/schemas/RefreshTokenMetadata'
        last_exchanged_at:
          $ref: '#/components/schemas/RefreshTokenDate'
    RefreshTokenResourceServer:
      type: object
      additionalProperties: true
      properties:
        audience:
          type: string
          description: Resource server ID
        scopes:
          type: string
          description: List of scopes for the refresh token
    UpdateRefreshTokenResponseContent:
      type: object
      additionalProperties: true
      properties:
        id:
          type: string
          description: The ID of the refresh token
        user_id:
          type: string
          description: ID of the user which can be used when interacting with other APIs.
          default: auth0|507f1f77bcf86cd799439020
        created_at:
          $ref: '#/components/schemas/RefreshTokenDate'
        idle_expires_at:
          $ref: '#/components/schemas/RefreshTokenDate'
        expires_at:
          $ref: '#/components/schemas/RefreshTokenDate'
        device:
          $ref: '#/components/schemas/RefreshTokenDevice'
        client_id:
          type: string
          description: ID of the client application granted with this refresh token
        session_id:
          $ref: '#/components/schemas/RefreshTokenSessionId'
        rotating:
          type: boolean
          description: True if the token is a rotating refresh token
        resource_servers:
          type: array
          description: A list of the resource server IDs associated to this refresh-token and their granted scopes
          items:
            $ref: '#/components/schemas/RefreshTokenResourceServer'
        refresh_token_metadata:
          $ref: '#/components/schemas/RefreshTokenMetadata'
        last_exchanged_at:
          $ref: '#/components/schemas/RefreshTokenDate'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: jwt
    oAuth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: /oauth/token/
          x-form-parameters:
            audience: /api/v2/
          scopes:
            create:actions: Create Actions
            read:actions: Read Actions
            update:actions: Update Actions
            delete:actions: Delete Actions
            read:anomaly_blocks: Read Anomaly Blocks
            delete:anomaly_blocks: Delete Anomaly Blocks
            read:attack_protection: Read Attack Protection
            update:attack_protection: Update Attack Protection
            create:authentication_methods: Create Authentication Methods
            read:authentication_methods: Read Authentication Methods
            update:authentication_methods: Update Authentication Methods
            delete:authentication_methods: Delete Authentication Methods
            read:branding: Read Branding
            update:branding: Update Branding
            delete:branding: Delete Branding
            create:client_credentials: Create Client Credentials
            read:client_credentials: Read Client Credentials
            update:client_credentials: Update Client Credentials
            delete:client_credentials: Delete Client Credentials
            create:client_grants: Create Client Grants
            read:client_grants: Read Client Grants
            update:client_grants: Update Client Grants
            delete:client_grants: Delete Client Grants
            read:client_keys: Read Client Keys
            update:client_keys: Update Client Keys
            read:client_summary: Read Client Summary
            update:client_token_vault_privileged_access: Update Client Token Vault Privileged Access
            create:clients: Create Clients
            read:clients: Read Clients
            update:clients: Update Clients
            delete:clients: Delete Clients
            create:connection_profiles: Create Connection Profiles
            read:connection_profiles: Read Connection Profiles
            update:connection_profiles: Update Connection Profiles
            delete:connection_profiles: Delete Connection Profiles
            create:connections: Create Connections
            read:connections: Read Connections
            update:connections: Update Connections
            delete:connections: Delete Connections
            create:connections_keys: Create Connections Keys
            read:connections_keys: Read Connections Keys
            update:connections_keys: Update Connections Keys
            read:current_user: Read Current User
            delete:current_user: Delete Current User
            create:current_user_device_credentials: Create Current User Device Credentials
            delete:current_user_device_credentials: Delete Current User Device Credentials
            update:current_user_identities: Update Current User Identities
            update:current_user_metadata: Update Current User Metadata
            create:custom_domains: Create Custom Domains
            read:custom_domains: Read Custom Domains
            update:custom_domains: Update Custom Domains
            delete:custom_domains: Delete Custom Domains
            create:custom_signing_keys: Create Custom Signing Keys
            read:custom_signing_keys: Read Custom Signing Keys
            update:custom_signing_keys: Update Custom Signing Keys
            delete:custom_signing_keys: Delete Custom Signing Keys
            read:device_credentials: Read Device Credentials
            delete:device_credentials: Delete Device Credentials
            create:directory_provisionings: Create Directory Provisionings
            read:directory_provisionings: Read Directory Provisionings
            update:directory_provisionings: Update Directory Provisionings
            delete:directory_provisionings: Delete Directory Provisionings
            create:email_provider: Create Email Provider
            read:email_provider: Read Email Provider
            update:email_provider: Update Email Provider
            delete:email_provider: Delete Email Provider
            create:email_templates: Create Email Templates
            read:email_templates: Read Email Templates
            update:email_templates: Update Email Templates
            create:encryption_keys: Create Encryption Keys
            read:encryption_keys: Read Encryption Keys
            update:encryption_keys: Update Encryption Keys
            delete:encryption_keys: Delete Encryption Keys
            read:event_deliveries: Read Event Deliveries
            update:event_deliveries: Update Event Deliveries
            create:event_streams: Create Event Streams
            read:event_streams: Read Event Streams
            update:event_streams: Update Event Streams
            delete:event_streams: Delete Event Streams
            read:events: Read Events
            read:federated_connections_tokens: Read Federated Connections Tokens
            delete:federated_connections_tokens: Delete Federated Connections Tokens
            create:flows: Create Flows
            read:flows: Read Flows
            update:flows: Update Flows
            delete:flows: Delete Flows
            read:flows_executions: Read Flows Executions
            delete:flows_executions: Delete Flows Executions
            create:flows_vault_connections: Create Flows Vault Connections
            read:flows_vault_connections: Read Flows Vault Connections
            update:flows_vault_connections: Update Flows Vault Connections
            delete:flows_vault_connections: Delete Flows Vault Connections
            create:forms: Create Forms
            read:forms: Read Forms
            update:forms: Update Forms
            delete:forms: Delete Forms
            read:grants: Read Grants
            delete:grants: Delete Grants
            read:group_members: Read Group Members
            read:groups: Read Groups
            delete:groups: Delete Groups
            create:guardian_enrollment_tickets: Create Guardian Enrollment Tickets
            read:guardian_enrollments: Read Guardian Enrollments
            delete:guardian_enrollments: Delete Guardian Enrollments
            read:guardian_factors: Read Guardian Factors
            update:guardian_factors: Update Guardian Factors
            create:hooks: Create Hooks
            read:hooks: Read Hooks
            update:hooks: Update Hooks
            delete:hooks: Delete Hooks
            create:log_streams: Create Log Streams
            read:log_streams: Read Log Streams
            update:log_streams: Update Log Streams
            delete:log_streams: Delete Log Streams
            read:logs: Read Logs
            read:logs_users: Read Logs Users
            read:mfa_policies: Read Mfa Policies
            update:mfa_policies: Update Mfa Policies
            create:network_acls: Create Network Acls
            read:network_acls: Read Network Acls
            update:network_acls: Update Network Acls
            delete:network_acls: Delete Network Acls
            create:organization_client_grants: Create Organization Client Grants
            read:organization_client_grants: Read Organization Client Grants
            delete:organization_client_grants: Delete Organization Client Grants
            create:organization_connections: Create Organization Connections
            read:organization_connections: Read Organization Connections
            update:organization_connections: Update Organization Connections
            delete:organization_connections: Delete Organization Connections
            create:organization_discovery_domains: Create Organization Discovery Domains
            read:organization_discovery_domains: Read Organization Discovery Domains
            update:organization_discovery_domains: Update Organization Discovery Domains
            delete:organization_discovery_domains: Delete Organization Discovery Domains
            create:organization_invitations: Create Organization Invitations
            read:organization_invitations: Read Organization Invitations
            delete:organization_invitations: Delete Organization Invitations
            create:organization_member_roles: Create Organization Member Roles
            read:organization_member_roles: Read Organization Member Roles
            delete:organization_member_roles: Delete Organization Member Roles
            create:organization_members: Create Organization Members
            read:organization_members: Read Organization Members
            delete:organization_members: Delete Organization Members
            create:organizations: Create Organizations
            read:organizations: Read Organizations
            update:organizations: Update Organizations
            delete:organizations: Delete Organizations
            read:organizations_summary: Read Organizations Summary
            create:phone_providers: Create Phone Providers
            read:phone_providers: Read Phone Providers
            update:phone_providers: Update Phone Providers
            delete:phone_providers: Delete Phone Providers
            create:phone_templates: Create Phone Templates
            read:phone_templates: Read Phone Templates
            update:phone_templates: Update Phone Templates
            delete:phone_templates: Delete Phone Templates
            read:prompts: Read Prompts
            update:prompts: Update Prompts
            read:refresh_tokens: Read Refresh Tokens
            update:refresh_tokens: Update Refresh Tokens
            delete:refresh_tokens: Delete Refresh Tokens
            create:resource_servers: Create Resource Servers
            read:resource_servers: Read Resource Servers
            update:resource_servers: Update Resource Servers
            delete:resource_servers: Delete Resource Servers
            create:role_members: Create Role Members
            read:role_members: Read Role Members
            delete:role_members: Delete Role Members
            create:roles: Create Roles
            read:roles: Read Roles
            update:roles: Update Roles
            delete:roles: Delete Roles
            create:rules: Create Rules
            read:rules: Read Rules
            update:rules: Update Rules
            delete:rules: Delete Rules
            read:rules_configs: Read Rules Configs
            update:rules_configs: Update Rules Configs
            delete:rules_configs: Delete Rules Configs
            create:scim_config: Create Scim Config
            read:scim_config: Read Scim Config
            update:scim_config: Update Scim Config
            delete:scim_config: Delete Scim Config
            create:scim_token: Create Scim Token
            read:scim_token: Read Scim Token
            delete:scim_token: Delete Scim Token
            read:self_service_profile_custom_texts: Read Self Service Profile Custom Texts
            update:self_service_profile_custom_texts: Update Self Service Profile Custom Texts
            create:self_service_profiles: Create Self Service Profiles
            read:self_service_profiles: Read Self Service Profiles
            update:self_service_profiles: Update Self Service Profiles
            delete:self_service_profiles: Delete Self Service Profiles
            read:sessions: Read Sessions
            update:sessions: Update Sessions
            delete:sessions: Delete Sessions
            create:signing_keys: Create Signing Keys
            read:signing_keys: Read Signing Keys
            update:signing_keys: Update Signing Keys
            create:sso_access_tickets: Create Sso Access Tickets
            delete:sso_access_tickets: Delete Sso Access Tickets
            read:stats: Read Stats
            read:tenant_settings: Read Tenant Settings
            update:tenant_settings: Update Tenant Settings
            create:token_exchange_profiles: Create Token Exchange Profiles
            read:token_exchange_profiles: Read Token Exchange Profiles
            update:token_exchange_profiles: Update Token Exchange Profiles
            delete:token_exchange_profiles: Delete Token Exchange Profiles
            create:user_attribute_profiles: Create User Attribute Profiles
            read:user_attribute_profiles: Read User Attribute Profiles
            update:user_attribute_profiles: Update User Attribute Profiles
            delete:user_attribute_profiles: Delete User Attribute Profiles
            read:user_idp_tokens: Read User Idp Tokens
            create:user_tickets: Create User Tickets
            create:users: Create Users
            read:users: Read Users
            update:users: Update Users
            delete:users: Delete Users
            update:users_app_metadata: Update Users App Metadata
            create:vdcs_templates: Create Vdcs Templates
            read:vdcs_templates: Read Vdcs Templates
            update:vdcs_templates: Update Vdcs Templates
            delete:vdcs_templates: Delete Vdcs Templates
externalDocs:
  description: Auth0 Management API Documentation
  url: https://auth0.com/docs/api/management/v2/