REST API›Enterprise›User

DEL

Delete access token

Revokes an access token by setting its expiration to the current time. The token can no longer be used for authentication. Returns the expired token document.

Path Params

  • token string required
    The public ID of the access token to revoke (32-character lowercase hex string).

    matches ^[0-9a-f]{32}$

Responses

200
OK

Response Body

object

  • id string required

    matches ^[0-9a-f]{32}$

  • isExtensible boolean required
  • adminScope string enum
    readfull
  • bitgoAdminPermissions array of strings
  • client string
  • created string date-time
  • enterprise string
  • expires string date-time
  • extensionAddress string
  • ip string ipv4
    IP address of the client that requested this access token
  • ipRestrict array of strings
  • label string
  • origin string
    BitGo environment that issued this token
  • token string
  • scope array of strings
  • unlock object
    unlock object
    • spendingLimits map of objects
      spendingLimits object
      • <key> object
        value object
        • txCount number
          The transaction count limit for the coin
        • txValue number
          The transaction value limit for the coin
        • txValueLimit number
          The maximum transaction value limit for the coin
    • allErc20TokensLimit object
      allErc20TokensLimit object
      • enabled boolean required
        Indicates if the limit is enabled for all ERC20 tokens
      • txCount number required
        The transaction count limit for all ERC20 tokens
      • txValue string required
        The transaction value limit for all ERC20 tokens
      • txValueLimitInSmallUnits string
        The transaction value limit in small units for all ERC20 tokens
      • maxLimit boolean
        Indicates if the maximum limit is enabled
    • expires string date-time
    • time string date-time
    • txCount number
    • txValue number
    • txValueLimit number
  • user string

    matches ^[0-9a-f]{32}$

  • oauth object
    oauth object
    • oauthRequired boolean
    • expires string date-time
  • isMobileAccessToken boolean
    Flag indicating if this token was created via mobile session endpoint
400
Bad Request

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id
401
Unauthorized

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id
403
Forbidden

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id
404
Not Found

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id