Org Webservice

Generate federated session token

Generate a federated session token login for organization

post/api/org/generateFederatedSessionToken

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/org/generateFederatedSessionToken
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Request body

deviceUUidstring DeviceFacetUuid nullable

RUUID with optional appended facet information

domainstring nullable

Optional. The origin that is allowed to use the federated token, specified as a fully qualified URL (scheme and host, plus a port if non-default). On the browser API the value is applied as a CORS allowed-origin, and must match the browser's Origin exactly. For media requests, which are not governed by CORS, the request's Referer is parsed and compared against this value on origin (scheme, host and port) — so the Referer may carry a path and query and still match. Omit the field to leave the token unrestricted, which is required for clients that cannot send a Referer, such as native and on-prem players. This restricts where a token can be used from a browser; it is not a substitute for treating the token as a bearer credential. Both Origin and Referer are supplied by the client, so a non-browser caller holding the token can send either value at will. Use a short durationSec, and deviceUUid where the token only needs one camera's media, to limit a token that has been extracted.

durationSecinteger nullable

Duration of the federated session token in seconds

Example request

{
  "deviceUUid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
  "domain": "https://app.example.com",
  "durationSec": 3600
}

Response

OK

federatedSessionTokenstring RUUID nullable

base 64 (url-safe) uuid string

Example response

{
  "federatedSessionToken": "AAAAAAAAAAAAAAAAAAAAAA"
}

Changes

No recorded changes to this operation across all 1 revision of this API.