MAmatrix

Refresh an access token

Refresh an access token. Clients should use the returned access token when making subsequent API calls, and store the returned refresh token (if given) in order to refresh the new access token when necessary.

After an access token has been refreshed, a server can choose to invalidate the old access token immediately, or can choose not to, for example if the access token would expire soon anyways. Clients should not make any assumptions about the old access token still being valid, and should use the newly provided access token instead.

The old refresh token remains valid until the new access token or refresh token is used, at which point the old refresh token is revoked.

Note that this endpoint does not require authentication via an access token. Authentication is provided via the refresh token.

Application Service identity assertion is disabled for this endpoint.

post/_matrix/client/v3/refresh

Request

Request body

refresh_tokenstring required

The refresh token

Example request

{
  "refresh_token": "some_token"
}

Response

A new access token and refresh token were generated.

access_tokenstring required

The new access token to use.

expires_in_msinteger

The lifetime of the access token, in milliseconds. If not given, the client can assume that the access token will not expire.

refresh_tokenstring

The new refresh token to use when the access token needs to be refreshed again. If not given, the old refresh token can be re-used.

Changes

No recorded changes to this operation across all 1 revision of this API.