platform/applications/authtickets
Use the Authetickets for applications resource to manage authentication tickets for your apps.
JSON Example
AuthTicket Properties
Property | Description |
---|---|
accessToken |
type: string Alphanumeric string used to authenticate the user in API request headers. The token stores an encrypted list of the application's configured behaviors and authenticates the application. |
accessTokenExpiration |
type: DateTime The date and time the user access token expires. If the token will expire, a new token will need to be generated and assigned to the account to continue and restore access to the store, data, and account. |
refreshToken |
type: string Alphanumeric string used for access tokens. This token refreshes access for accounts by generating a new developer or application account authentication ticket after an access token expires. |
refreshTokenExpiration |
type: DateTime The date and time the developer account or application refresh token expires. |
Operations
Operation Name | Request URI | Description |
---|---|---|
AuthenticateApp | POST %3fresponseFields%3d%7bresponseFields%7d |
Generate an authentication ticket for an application. |
DeleteAppAuthTicket | DELETE %7brefreshToken%7d |
Deletes an authentication for an application based on the specified refresh token. |
RefreshAppAuthTicket | PUT refresh-ticket%3fresponseFields%3d%7bresponseFields%7d |
Refreshes the application's authentication ticket and generates a new access token by providing the refresh token string. |