POST /users/{userId}/logout
Terminates all active Retool sessions for the specified user. Optionally initiates an RP-initiated logout with the configured OIDC SSO provider by returning an sso_logout_url that the caller must redirect the user's browser to. Requires the users:write scope.
Servers
- https://api.retool.com/api/v2
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
userId |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
post_logout_redirect_uri |
String | No |
URI to redirect the user to after SSO logout completes. Only valid when sso_logout is true. Must be registered in your SSO provider. |
sso_logout |
Boolean | No |
If true, also initiates an RP-initiated logout with the configured SSO provider. Default value: false |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.