Get Refresh Tokens

Returns the list of refresh tokens of the authenticated user.

application/json

application/grpc

application/grpc-web+proto

Request Body required

object

Request Body required

object

Request Body required

object

Responses

• 200
• default

---

A successful response.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from 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
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
]

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2024-04-26T16:05:04.566Z"
  },
  "result": [
    {
      "id": "69629023906489455",
      "details": {
        "sequence": "2",
        "creationDate": "2024-04-26T16:05:04.567Z",
        "changeDate": "2024-04-26T16:05:04.567Z",
        "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"
      ]
    }
  ]
}

Schema

Example (from 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
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
]

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2024-04-26T16:05:04.567Z"
  },
  "result": [
    {
      "id": "69629023906489455",
      "details": {
        "sequence": "2",
        "creationDate": "2024-04-26T16:05:04.567Z",
        "changeDate": "2024-04-26T16:05:04.567Z",
        "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"
      ]
    }
  ]
}

Schema

Example (from 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
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
]

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2024-04-26T16:05:04.567Z"
  },
  "result": [
    {
      "id": "69629023906489455",
      "details": {
        "sequence": "2",
        "creationDate": "2024-04-26T16:05:04.567Z",
        "changeDate": "2024-04-26T16:05:04.567Z",
        "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"
      ]
    }
  ]
}

An unexpected error response.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Loading...