Auth0

Auth0 Device Credentials API

The device-credentials API from Auth0 — 2 operation(s) for device-credentials.

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 3

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /device-credentials List a user's device credentials · Retrieve Device Credentials #
Ask an LLM
“Which refresh tokens or device public keys does a user have?”
“Can I filter device credentials by application or credential type?”
Tell an agent
List device credentials for user {user_id}.
List {type} device credentials for user {user_id} in client {client_id}.
POST /device-credentials Register a device public key · Create a Device Public Key Credential #
Ask an LLM
“How do I register a device's public key for refresh token rotation?”
“What details about the device are needed to create a device credential?”
Tell an agent
Create a {type} device credential for device {device_name} ({device_id}) with value {value}.
Register public key {value} for device {device_id} named {device_name} as type {type}.
DELETE /device-credentials/{id} Delete a device credential · Delete a Device Credential #
Ask an LLM
“Can I revoke a refresh token stored as a device credential?”
“Is deleting a device credential permanent?”
Tell an agent destructive · confirm first
Delete device credential {id}.
Permanently remove the device credential {id}.

Documentation

📖
Documentation
https://auth0.com/docs/api/management/v2
📖
APIReference
https://auth0.com/docs/api/management/v2
📖
GettingStarted
https://auth0.com/docs/get-started
📖
Authentication
https://auth0.com/docs/secure/tokens
📖
Documentation
https://auth0.com/docs/api/authentication
📖
APIReference
https://auth0.com/docs/api/authentication
📖
Documentation
https://docs.fga.dev

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/auth0/refs/heads/main/openapi/auth0-device-credentials-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/auth0/refs/heads/main/asyncapi/auth0-log-streams-and-actions-asyncapi.yml

Other Resources

🔗
OpenAPISource
https://auth0.com/docs/api/management/openapi.json
🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/auth0/refs/heads/main/rules/auth0-management-rules.yml
🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/auth0/refs/heads/main/rules/auth0-authentication-rules.yml
🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/auth0/refs/heads/main/rules/auth0-fga-rules.yml
🔗
Project
https://openfga.dev
🔗
Repository
https://github.com/openfga/openfga

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/auth0:auth0-device-credentials-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

auth0-device-credentials-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Auth0 Management Device Credentials 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: Device Credentials
paths:
  /device-credentials:
    get:
      summary: Retrieve Device Credentials
      description: Retrieve device credential information (public_key, refresh_token, or rotating_refresh_token) associated with a specific user.
      tags:
      - Device Credentials
      parameters:
      - name: page
        in: query
        description: Page index of the results to return. First page is 0.
        schema:
          type: integer
          minimum: 0
      - name: per_page
        in: query
        description: Number of results per page.  There is a maximum of 1000 results allowed from this endpoint.
        schema:
          type: integer
          minimum: 1
          maximum: 100
      - name: include_totals
        in: query
        description: Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).
        schema:
          type: boolean
      - 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
          pattern: ^((device_name)|(id)|(device_id)|(type)|(user_id)|(client_id))(,((device_name)|(id)|(device_id)|(type)|(user_id)|(client_id)))*$
      - name: include_fields
        in: query
        description: Whether specified fields are to be included (true) or excluded (false).
        schema:
          type: boolean
      - name: user_id
        in: query
        description: user_id of the devices to retrieve.
        schema:
          type: string
      - name: client_id
        in: query
        description: client_id of the devices to retrieve.
        schema:
          type: string
      - name: type
        in: query
        description: Type of credentials to retrieve. Must be `public_key`, `refresh_token` or `rotating_refresh_token`. The property will default to `refresh_token` when paging is requested
        schema:
          $ref: '#/components/schemas/DeviceCredentialTypeEnum'
      responses:
        '200':
          description: Device credentials successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDeviceCredentialsResponseContent'
        '400':
          description: Invalid request query string. The message will vary depending on the cause.
        '401':
          description: Invalid token.
          x-description-1: Client is not global.
          x-description-2: Invalid signature received for JSON Web Token validation.
          x-description-3: Username is malformed, try with '{connection}\{email_or_username}'
          x-description-4: Bad username or password.
        '403':
          description: User to be acted on does not match subject in bearer token.
          x-description-1: 'Insufficient scope, expected any of: read:device_credentials'
          x-description-2: Cannot retrieve device credentials for that user.
          x-description-3: Cannot retrieve device credentials for that client.
          x-description-4: Must provide client_id parameter.
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: get_device-credentials
      x-release-lifecycle: GA
      x-operation-name: list
      x-operation-request-parameters-name: ListDeviceCredentialsRequestParameters
      x-operation-group: deviceCredentials
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:device_credentials
    post:
      summary: Create a Device Public Key Credential
      description: 'Create a device credential public key to manage refresh token rotation for a given user_id. Device Credentials APIs are designed for ad-hoc administrative use only and paging is by default enabled for GET requests.


        When refresh token rotation is enabled, the endpoint becomes consistent. For more information, read Signing Keys.'
      tags:
      - Device Credentials
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePublicKeyDeviceCredentialRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreatePublicKeyDeviceCredentialRequestContent'
      responses:
        '201':
          description: Device credentials successfully created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePublicKeyDeviceCredentialResponseContent'
        '400':
          description: 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.
          x-description-2: Username is malformed, try with "{connection}\{email_or_username}".
          x-description-3: Bad username or password.
        '403':
          description: Cannot create device credentials for that user.
          x-description-1: Cannot create device credentials for that client.
          x-description-2: 'Insufficient scope; expected any of: create:current_user_device_credentials.'
        '409':
          description: A public key already exists for the device.
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: post_device-credentials
      x-release-lifecycle: GA
      x-operation-name: createPublicKey
      x-operation-group: deviceCredentials
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - create:current_user_device_credentials
  /device-credentials/{id}:
    delete:
      summary: Delete a Device Credential
      description: Permanently delete a device credential (such as a refresh token or public key) with the given ID.
      tags:
      - Device Credentials
      parameters:
      - name: id
        in: path
        description: ID of the credential to delete.
        required: true
        schema:
          type: string
          pattern: ^dcr_[A-Za-z0-9]{16}$
      responses:
        '204':
          description: Device credentials successfully deleted.
        '400':
          description: Invalid request URI. The message will vary depending on the cause.
        '401':
          description: Invalid token.
          x-description-1: Client is not global.
          x-description-2: Invalid signature received for JSON Web Token validation.
          x-description-3: Username is malformed, try with "{connection}\{email_or_username}".
          x-description-4: Bad username or password.
        '403':
          description: 'Insufficient scope; expected any of: delete:device_credentials, update:current_user, delete:current_user_device_credentials.'
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: delete_device-credentials_by_id
      x-release-lifecycle: GA
      x-operation-name: delete
      x-operation-group: deviceCredentials
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - delete:device_credentials
        - delete:current_user_device_credentials
components:
  schemas:
    DeviceCredentialTypeEnum:
      type: string
      enum:
      - public_key
      - refresh_token
      - rotating_refresh_token
      description: Type of credentials to retrieve. Must be `public_key`, `refresh_token` or `rotating_refresh_token`. The property will default to `refresh_token` when paging is requested
    ListDeviceCredentialsOffsetPaginatedResponseContent:
      type: object
      additionalProperties: false
      properties:
        start:
          type: number
        limit:
          type: number
        total:
          type: number
        device_credentials:
          type: array
          items:
            $ref: '#/components/schemas/DeviceCredential'
    ListDeviceCredentialsResponseContent:
      oneOf:
      - type: array
        items:
          $ref: '#/components/schemas/DeviceCredential'
      - $ref: '#/components/schemas/ListDeviceCredentialsOffsetPaginatedResponseContent'
    DeviceCredentialPublicKeyTypeEnum:
      type: string
      description: Type of credential. Must be `public_key`.
      enum:
      - public_key
    DeviceCredential:
      type: object
      additionalProperties: false
      properties:
        id:
          type: string
          description: ID of this device.
          default: dcr_0000000000000001
        device_name:
          type: string
          description: User agent for this device
          default: iPhone Mobile Safari UI/WKWebView
        device_id:
          type: string
          description: 'Unique identifier for the device. NOTE: This field is generally not populated for refresh_tokens and rotating_refresh_tokens'
          default: 550e8400-e29b-41d4-a716-446655440000
        type:
          $ref: '#/components/schemas/DeviceCredentialTypeEnum'
          description: Type of credential. Can be `public_key`, `refresh_token`, or `rotating_refresh_token`.
        user_id:
          type: string
          description: user_id this credential is associated with.
          default: usr_5457edea1b8f33391a000004
        client_id:
          type: string
          description: client_id of the client (application) this credential is for.
          default: AaiyAPdpYdesoKnqjj8HJqRn4T5titww
    CreatePublicKeyDeviceCredentialRequestContent:
      type: object
      additionalProperties: true
      required:
      - device_name
      - type
      - value
      - device_id
      properties:
        device_name:
          type: string
          description: Name for this device easily recognized by owner.
          minLength: 1
        type:
          $ref: '#/components/schemas/DeviceCredentialPublicKeyTypeEnum'
        value:
          type: string
          description: Base64 encoded string containing the credential.
          minLength: 1
        device_id:
          type: string
          description: Unique identifier for the device. Recommend using <a href="http://developer.android.com/reference/android/provider/Settings.Secure.html#ANDROID_ID">Android_ID</a> on Android and <a href="https://developer.apple.com/library/ios/documentation/UIKit/Reference/UIDevice_Class/index.html#//apple_ref/occ/instp/UIDevice/identifierForVendor">identifierForVendor</a>.
          maxLength: 36
          pattern: ^[-A-Fa-f0-9]+$
        client_id:
          type: string
          description: client_id of the client (application) this credential is for.
          format: client-id
    CreatePublicKeyDeviceCredentialResponseContent:
      type: object
      additionalProperties: true
      required:
      - id
      properties:
        id:
          type: string
          description: The credential's identifier
          default: dcr_0000000000000001
  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/