Token

An Object

Table of Contents
Note

Drop in one of our language drivers to accelerate your development.
Here are links to some of our popular Cookbooks to help you get started!

Parent

This Token is contained within a Cluster.

Properties

The following properties are available:

Property Type Default Read-Only Description
_doc string No The primary ID
_system object No Metadata maintained by the system
client_authorities array No
client_id string No
client_redirect_uri string No
client_resource_ids array No
expiration object No
platform_id string No
registrar_id string No
tenant_id string No
user_directory_id string No
user_domain_id string No
user_identity_id string No
user_principal_id string No
user_principal_name string No

Methods

The following methods are available:

Expire

POST /tokens/access/{accessTokenId}/expire

Parameters

Name Required Type Description
accessTokenId true string
refresh false string

Response

{}

Expire

POST /tokens/refresh/{refreshTokenId}/expire

Parameters

Name Required Type Description
refreshTokenId true string
access false string

Response

{}

Lists Token

Retrieves a list of Token instances
GET /tokens/refresh

Parameters

Name Required Type Description
sort false object Defines how to sort fields in the result set
skip false number Skips the result set cursor ahead the specified number of records
limit false number Specifies the number of records to be handed back in the result set

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_token"
      }
    }
  }
}

Lists Token

Retrieves a list of Token instances
GET /tokens/access

Parameters

Name Required Type Description
sort false object Defines how to sort fields in the result set
skip false number Skips the result set cursor ahead the specified number of records
limit false number Specifies the number of records to be handed back in the result set

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_token"
      }
    }
  }
}

Read Token

Reads an instance of a Token
GET /tokens/access/{accessTokenId}

Parameters

Name Required Type Description
accessTokenId true string

Response

{
  "type": "object",
  "extends": "document",
  "container": "cluster",
  "description": "Token",
  "properties": {
    "expiration": {
      "type": "object"
    },
    "client_id": {
      "type": "string"
    },
    "client_redirect_uri": {
      "type": "string"
    },
    "client_resource_ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "client_authorities": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "user_directory_id": {
      "type": "string"
    },
    "user_identity_id": {
      "type": "string"
    },
    "user_domain_id": {
      "type": "string"
    },
    "user_principal_id": {
      "type": "string"
    },
    "user_principal_name": {
      "type": "string"
    },
    "platform_id": {
      "type": "string"
    },
    "registrar_id": {
      "type": "string"
    },
    "tenant_id": {
      "type": "string"
    },
    "_doc": null,
    "_system": null
  }
}

Read Token

Reads an instance of a Token
GET /tokens/refresh/{refreshTokenId}

Parameters

Name Required Type Description
refreshTokenId true string

Response

{
  "type": "object",
  "extends": "document",
  "container": "cluster",
  "description": "Token",
  "properties": {
    "expiration": {
      "type": "object"
    },
    "client_id": {
      "type": "string"
    },
    "client_redirect_uri": {
      "type": "string"
    },
    "client_resource_ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "client_authorities": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "user_directory_id": {
      "type": "string"
    },
    "user_identity_id": {
      "type": "string"
    },
    "user_domain_id": {
      "type": "string"
    },
    "user_principal_id": {
      "type": "string"
    },
    "user_principal_name": {
      "type": "string"
    },
    "platform_id": {
      "type": "string"
    },
    "registrar_id": {
      "type": "string"
    },
    "tenant_id": {
      "type": "string"
    },
    "_doc": null,
    "_system": null
  }
}

Schema


{
  "type": "object",
  "extends": "document",
  "container": "cluster",
  "description": "Token",
  "properties": {
    "expiration": {
      "type": "object"
    },
    "client_id": {
      "type": "string"
    },
    "client_redirect_uri": {
      "type": "string"
    },
    "client_resource_ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "client_authorities": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "user_directory_id": {
      "type": "string"
    },
    "user_identity_id": {
      "type": "string"
    },
    "user_domain_id": {
      "type": "string"
    },
    "user_principal_id": {
      "type": "string"
    },
    "user_principal_name": {
      "type": "string"
    },
    "platform_id": {
      "type": "string"
    },
    "registrar_id": {
      "type": "string"
    },
    "tenant_id": {
      "type": "string"
    },
    "_doc": null,
    "_system": null
  },
  "id": "token"
}