POST /authentication-tokens/{token}/exchange
Exchanges an authentication token for a JWT.
By default, this operation invalidates the exchanged authentication token.
Servers
- https://api-sandbox.rebilly.com/organizations/{organizationId}
- https://api.rebilly.com/organizations/{organizationId}
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 |
|---|---|---|---|
id |
String | No |
ID of the session. |
invalidate |
Boolean | No |
Specifies if the token must be invalidated after the exchange is performed. Default value: true |
_links[] |
Array | No |
Related links. |
_links[].href |
String | No |
Link URL. |
_links[].rel |
String | No |
Type of link. Valid values:
|
oneTimePassword |
String | No |
One-time password that is sent by email. This value must contain digits only. |
updatedTime |
String | No |
Date and time when the batch was last updated. |
createdTime |
String | No |
Date and time when the batch was created. |
token |
String | No |
Token used for authentication. |
type |
String | No |
Type of session. Valid values:
|
customClaims |
Object | No | |
expiredTime |
String | No |
Date and time when the session expires.
The default value is one hour after the |
acl[] |
Array | No |
Access Control List (ACL) information. |
acl[].scope |
Object | Yes |
Scope of the API key. |
acl[].scope.customFieldName[] |
Array | No |
Array of custom field names. |
acl[].scope.productId[] |
Array | No |
Array of product IDs. |
acl[].scope.planId[] |
Array | No |
Array of plan IDs. |
acl[].scope.organizationId[] |
Array | No |
Array of account IDs. |
acl[].permissions[] |
Array | Yes |
If you are creating a restricted API key, use this field to specify individual permissions.
Use the wildcard character |
customerId |
Object | No |
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.