Share feedback
Answers are generated based on the documentation.

Experimental

Product manualDownload OpenAPI specificationMarkdown

Schema

OAuthRefreshMaterial

Type: object

OAuthRefreshMaterial is OAuth secret material. Unlike OAuthRefreshMaterialV2 it pairs no bootstrap token with an expiry and stores client_id as the caller supplied it.
clientId

Type: string

client_id is the OAuth client id.
All schema constraints and annotations
{
  "description": "client_id is the OAuth client id.",
  "type": "string"
}
expiresAt

Schema: Timestamp

expires_at is the access token expiry when supplied.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/Timestamp",
  "description": "expires_at is the access token expiry when supplied."
}
idToken· request only

Type: string

id_token is an optional OpenID Connect id token.
All schema constraints and annotations
{
  "description": "id_token is an optional OpenID Connect id token.",
  "type": "string",
  "writeOnly": true
}
initialAccessToken· request only

Type: string

initial_access_token is an optional bootstrap access token.
All schema constraints and annotations
{
  "description": "initial_access_token is an optional bootstrap access token.",
  "type": "string",
  "writeOnly": true
}
providerAccountId

Type: string

provider_account_id identifies the provider account.
All schema constraints and annotations
{
  "description": "provider_account_id identifies the provider account.",
  "type": "string"
}
refreshToken · required · request only

Type: string

refresh_token is the OAuth refresh token.
All schema constraints and annotations
{
  "description": "refresh_token is the OAuth refresh token.",
  "minLength": 1,
  "type": "string",
  "writeOnly": true
}
scopes

Type: array

scopes are requested OAuth scopes.
Array item

Type: string

All schema constraints and annotations
{
  "type": "string"
}
All schema constraints and annotations
{
  "description": "scopes are requested OAuth scopes.",
  "items": {
    "type": "string"
  },
  "type": "array"
}
All schema constraints and annotations
{
  "additionalProperties": false,
  "description": "OAuthRefreshMaterial is OAuth secret material. Unlike OAuthRefreshMaterialV2 it pairs\nno bootstrap token with an expiry and stores client_id as the caller supplied it.",
  "properties": {
    "clientId": {
      "description": "client_id is the OAuth client id.",
      "type": "string"
    },
    "expiresAt": {
      "$ref": "#/components/schemas/Timestamp",
      "description": "expires_at is the access token expiry when supplied."
    },
    "idToken": {
      "description": "id_token is an optional OpenID Connect id token.",
      "type": "string",
      "writeOnly": true
    },
    "initialAccessToken": {
      "description": "initial_access_token is an optional bootstrap access token.",
      "type": "string",
      "writeOnly": true
    },
    "providerAccountId": {
      "description": "provider_account_id identifies the provider account.",
      "type": "string"
    },
    "refreshToken": {
      "description": "refresh_token is the OAuth refresh token.",
      "minLength": 1,
      "type": "string",
      "writeOnly": true
    },
    "scopes": {
      "description": "scopes are requested OAuth scopes.",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "refreshToken"
  ],
  "title": "OAuthRefreshMaterial",
  "type": "object"
}