v1

latestOpenAPI 3.0.02026-07-14121153292.2 KB
authorization

Refresh an account or profile level authorization token which is marked as refreshable.

post/authorization/refresh

Query parameters

ffstring[]

The set of opt in feature flags which cause breaking changes to responses.

While Rocket APIs look to avoid breaking changes under the active major version, the formats of responses may need to evolve over this time.

These feature flags allow clients to select which response formats they expect and avoid breaking clients as these formats evolve under the current major version.

Flags

  • all - Enable all flags. Useful for testing. Don't use in production.
  • idp - Dynamic item detail pages with schedulable rows.
  • ldp - Dynamic list detail pages with schedulable rows.
  • hb - Hubble formatted image urls.
  • rpt - Updated resume point threshold logic.
  • cas - "Custom Asset Search", inlcude customAssets in search results.
  • lrl - Do not pre-populate related list if more than max_list_prefetch down the page.
  • cd - Custom Destination support.

See the feature-flags.md for available flag details.

langstring

Language code for the preferred language to be returned in the response.

Parameter value is case-insensitive and should be

  • a valid 2 letter language code without region such as en, de
  • or with region such as en_us, en_au

If undefined then defaults to 'en', unless the server has been configured with a custom default.

See https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes

Request body

cookieType'Session' | 'Persistent'

If you specify a cookie type then a content filter cookie will be returned along with the token(s). This is only intended for web based clients which need to pass the cookies to a server to render a page based on the user's content filters e.g subscription code.

If type Session the cookie will be session based. If type Persistent the cookie will have a medium term lifespan. If undefined no cookies will be set.

tokenstring required

The token to refresh.

Response

OK

accountCreatedboolean

When a UserAccount token is issued during a single-sign-on flow a user may have been automatically registered if they didn't have an account already. If this occurs then accountCreated will be true.

expirationDatestring date-time required

The timestamp this token expires.

refreshableboolean required

True if this token can be refreshed, false if not.

type'UserAccount' | 'UserProfile' required

The type of the token.

valuestring required

The token value used for authenticated requests.