Get Refresh Tokens

POST 
/users/me/tokens/refresh/_search

Returns the list of refresh tokens of the authenticated user.

Request

application/json

Body

required

object

application/grpc

Body

required

object

application/grpc-web+proto

Body

required

object

Responses

200

A successful response.

application/json

Schema

Schema

details

object

totalResult uint64

processedSequence uint64

viewTimestamp date-time

the last time the view got updated

result

object[]

Array [

id string

details

object

sequence uint64

on read: the sequence of the last event reduced by the projection

on manipulation: the timestamp of the event(s) added by the manipulation

creationDate date-time

on read: the timestamp of the first event of the object

on create: the timestamp of the event(s) added by the manipulation

changeDate date-time

on read: the timestamp of the last event reduced by the projection

on manipulation: the

resourceOwner resource_owner is the organization an object belongs to (string)

clientId string

oauth2/oidc client_id of the authorized application

authTime date-time

"time when the user authenticated, does not have to be the same time the token was created"

idleExpiration date-time

"time the refresh token will expire if not used, the user will have to reauthenticate"

expiration date-time

"time the refresh token will expire, the user will have to reauthenticate"

scopes string[]

scopes of the initial auth request, access tokens created by this refresh token can have a subset of these scopes

audience string[]

audience of the initial auth request and of all access tokens created by this refresh token

]

Example (from schema)

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2025-05-08T15:15:55.374Z"
  },
  "result": [
    {
      "id": "69629023906489455",
      "details": {
        "sequence": "2",
        "creationDate": "2025-05-08T15:15:55.374Z",
        "changeDate": "2025-05-08T15:15:55.374Z",
        "resourceOwner": "69629023906488334"
      },
      "clientId": "69629023906488334@ZITADEL",
      "authTime": "2023-02-13T08:45:00.000000Z",
      "idleExpiration": "2023-02-14T08:45:00.000000Z",
      "expiration": "2023-02-14T08:45:00.000000Z",
      "scopes": [
        "openid",
        "email",
        "profile",
        "offline_access"
      ],
      "audience": [
        "69629023906488334@ZITADEL",
        "69629023906481256"
      ]
    }
  ]
}

application/grpc

Schema

Schema

details

object

totalResult uint64

processedSequence uint64

viewTimestamp date-time

the last time the view got updated

result

object[]

Array [

id string

details

object

sequence uint64

on read: the sequence of the last event reduced by the projection

on manipulation: the timestamp of the event(s) added by the manipulation

creationDate date-time

on read: the timestamp of the first event of the object

on create: the timestamp of the event(s) added by the manipulation

changeDate date-time

on read: the timestamp of the last event reduced by the projection

on manipulation: the

resourceOwner resource_owner is the organization an object belongs to (string)

clientId string

oauth2/oidc client_id of the authorized application

authTime date-time

"time when the user authenticated, does not have to be the same time the token was created"

idleExpiration date-time

"time the refresh token will expire if not used, the user will have to reauthenticate"

expiration date-time

"time the refresh token will expire, the user will have to reauthenticate"

scopes string[]

scopes of the initial auth request, access tokens created by this refresh token can have a subset of these scopes

audience string[]

audience of the initial auth request and of all access tokens created by this refresh token

]

Example (from schema)

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2025-05-08T15:15:55.375Z"
  },
  "result": [
    {
      "id": "69629023906489455",
      "details": {
        "sequence": "2",
        "creationDate": "2025-05-08T15:15:55.376Z",
        "changeDate": "2025-05-08T15:15:55.376Z",
        "resourceOwner": "69629023906488334"
      },
      "clientId": "69629023906488334@ZITADEL",
      "authTime": "2023-02-13T08:45:00.000000Z",
      "idleExpiration": "2023-02-14T08:45:00.000000Z",
      "expiration": "2023-02-14T08:45:00.000000Z",
      "scopes": [
        "openid",
        "email",
        "profile",
        "offline_access"
      ],
      "audience": [
        "69629023906488334@ZITADEL",
        "69629023906481256"
      ]
    }
  ]
}

application/grpc-web+proto

Schema

Schema

details

object

totalResult uint64

processedSequence uint64

viewTimestamp date-time

the last time the view got updated

result

object[]

Array [

id string

details

object

sequence uint64

on read: the sequence of the last event reduced by the projection

on manipulation: the timestamp of the event(s) added by the manipulation

creationDate date-time

on read: the timestamp of the first event of the object

on create: the timestamp of the event(s) added by the manipulation

changeDate date-time

on read: the timestamp of the last event reduced by the projection

on manipulation: the

resourceOwner resource_owner is the organization an object belongs to (string)

clientId string

oauth2/oidc client_id of the authorized application

authTime date-time

"time when the user authenticated, does not have to be the same time the token was created"

idleExpiration date-time

"time the refresh token will expire if not used, the user will have to reauthenticate"

expiration date-time

"time the refresh token will expire, the user will have to reauthenticate"

scopes string[]

scopes of the initial auth request, access tokens created by this refresh token can have a subset of these scopes

audience string[]

audience of the initial auth request and of all access tokens created by this refresh token

]

Example (from schema)

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2025-05-08T15:15:55.377Z"
  },
  "result": [
    {
      "id": "69629023906489455",
      "details": {
        "sequence": "2",
        "creationDate": "2025-05-08T15:15:55.377Z",
        "changeDate": "2025-05-08T15:15:55.377Z",
        "resourceOwner": "69629023906488334"
      },
      "clientId": "69629023906488334@ZITADEL",
      "authTime": "2023-02-13T08:45:00.000000Z",
      "idleExpiration": "2023-02-14T08:45:00.000000Z",
      "expiration": "2023-02-14T08:45:00.000000Z",
      "scopes": [
        "openid",
        "email",
        "profile",
        "offline_access"
      ],
      "audience": [
        "69629023906488334@ZITADEL",
        "69629023906481256"
      ]
    }
  ]
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...