FOfountain
apikeys

get an authentication token from API key credentials

For enterprise-scoped API keys (see /processes/apikey/enterprise/generate), request a companyUuid:<uuid> scope value identifying which of the companies accessible to that enterprise identity to issue the access token for — e.g. scope=companyUuid:5f010f1e-6fc1-447f-93a8-fad19668b3af. This is a standard OAuth2 client_credentials request field, so any regular OAuth2 client can request it without Fountain-specific parameters.

post/api/servicesecurity/processes/apikey/oauth/token

Request

  • Base URL
    https://services.fountain.com
  • URL
    https://services.fountain.com/api/servicesecurity/processes/apikey/oauth/token
  • Auth
    none required

Request body application/x-www-form-urlencoded

grant_typestring
scopestring

Space-delimited scope values. Only relevant for enterprise-scoped API keys, which require a companyUuid:<uuid> value; ignored for standard company- and system-scoped keys.

Example request

{
  "grant_type": "client_credentials",
  "scope": "companyUuid:5f010f1e-6fc1-447f-93a8-fad19668b3af"
}

Response

Successfully authenticated

access_tokenstring
token_typestring
expires_innumber
scopestring

Example response

{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.xxx.xxx",
  "token_type": "Bearer",
  "scope": "employer"
}

Changes

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