Command Type: refreshCredentials¶
Description: The "refreshCredentials" command is a feature used to update and extend the authentication credentials to establish and maintain a connection with the streaming API.
Use Case: This command ensures that the client's authentication credentials remain valid and up to date during the connection duration. It helps maintain a secure and uninterrupted connection to the streaming API.
Response: refreshSuccess
| Property | Type | Notes |
|---|---|---|
type | string | Must be refreshCredentials |
token | string | Auth0 token to reauthenticate with. Must be Bearer <token> |
selectedTenantRole | string | Tenant to role mapping that indicates which role provided by the token to assume. Has the form <tenant>:<role_name> |
requestId | optional string | If provided, responses to the command include the same requestId |