Skip to main content

Auth

RallyHere Authentication API

This API is used by clients to retrieve an access token to be used when accessing other RallyHere APIs.

User-based Client Logins​

The /v1/login endpoint supports user-based authentication for a variety of platforms by "wrapping" a user's platform access token using a multi-step process:

  1. The client must authenticate the user and retrieve an access token for their respective platform.
  2. The client must subsequently authenticate the user using the /v1/login endpoint by setting the grant_type to the appropriate platform, and setting the portal_access_token to the access token retrieved above, which will return a new access token to be used for RallyHere APIs.

OAuth​

Version 1​

The /v1/oauth endpoints support user-based client authentication for a variety of different platforms, utilizing secure redirects to third-party authentication URLs. The OAuth flow allows authentication to the RallyHere APIs without the use of a game client.

Version 2​

Currently, the /v2/oauth endpoints only support a grant_type value of client_credentials, for the purposes of user-less client authentication, utilizing Basic authentication containing a RallyHere client ID and client secret. This type of authentication enables trusted clients (such as backend game instances) to access the RallyHere APIs without user-specific authentication.

The /v2/oauth endpoint will be updated in the future to include user-based authentication modes.