Challengermode
Home
Dashboard
Game Integration API
Client API
Auth API
Embeds

Auth API

Definitions

A full list of the object definitions used in the Auth API.

Auth

AccessKey

Access keys are short-lived tokens that grant API calls access to authorized endpoints. When an access key expires, it needs to be refreshed using the `POST v1/auth/access_keys` endpoint.

Field
Type
Description
value
string

Generated access key for access to authorized endpoints.

expiresAt
string (date-time)

When the access key will expire (in UTC).

AccessKeyRequest

Payload for retrieving an AccessKey.

Field
Type
Description
refreshKey
string

Refresh key, generated for one of your applications.

UserInfo

Model containing claims about the authenticated end user.

Field
Type
Description
sub
string (uuid)

Subject ID - the user's Challengermode user ID.

nickname
string

The username of the user on Challengermode.

profile
string

URL to the user profile on Challengermode.

picture
string

URL to the user's profile picture on Challengermode.

User

ExternalLogin

Field
Type
Description
id
string

External ID, provided by the external login provider.

provider
ExternalLoginProvider

ExternalLoginProvider

Type
Values
Description
integer (int32)
0, 5, 6

An external login provider.

  • 0 = Unknown
  • 5 = FifaGG
  • 6 = Steam

User

A user on Challengermode.

Field
Type
Description
urn
string

Object's reference URN.

id
string (uuid)
sub
string (uuid)

Subject ID.

username
string
biography
string
connectedAccounts
array of ExternalLogin

List of external accounts that the user has connected to their Challengermode account.

picture
string
overviewUrl
string

URL to the user on the Challengermode website.

dateCreated
string

UserStats

Challengermode stats for a user.

Field
Type
Description
userId
string (uuid)
matchesPlayed
integer (int32)

Total number of competitive matches played. This is helpful to infer overall commitment.

winRate
number (double)

Ratio of number of played games to number of won games.

placementRate
number (double)

Average placement in multi-team games.

playRate
number (double)

The ratio of number of games signed up for to number of games played. This is helpful to infer reliability.

General

ErrorCode

Type
Values
Description
integer (int32)
0, 401, 404, 408, 500, 10001, 10002, 10003, 10004, 10005, 10006, 10007, 10008, 10009, 10010, 10011, 10012, 10017, 10018, 10019, 10020, 10022, 10023, 10024, 11000, 11001, 11002, 11003, 11004, 11005, 11006, 11007, 11008, 11009, 11010, 11012, 11013, 12001, 13001, 13002, 13003, 13004, 16000, 16010, 110011, 1049006, 1049007, 1049008

Numeric error code used to identify the error.

  • 0 = Unknown - Internal server error.
  • 401 = Unauthorized - Request is unauthorized.
  • 404 = NotFound - Resource not found.
  • 408 = RequestTimeout - Request timed out.
  • 500 = InternalServiceError - Service unavailable.
  • 10001 = MissingApiVersion - API version not specified.
  • 10002 = InvalidApiVersion - Invalid API version specified.
  • 10003 = InvalidApiName - API name is missing.
  • 10004 = AppNotApproved - Operation requires your application to be Approved.
  • 10005 = InvalidTimeZoneId - Invalid time zone ID.
  • 10006 = AppDeactivated - Application is deactivated.
  • 10007 = InvalidGameState - Game state validation failed.
  • 10008 = TokenExpired - Token has expired.
  • 10009 = BadArguments - One or more of the arguments has wrong format.
  • 10010 = FeatureNotEnabled - Feature is not enabled for this game integration.
  • 10011 = RequiredParamterNullOrEmpty - A parameter is missing or empty in the request.
  • 10012 = ValidationError - Some validation checks failed.
  • 10017 = GameAccountAlreadyLinked - Another game account is already linked for this game and user.
  • 10018 = TournamentStateDisallowsAction - The tournament state disallows the action to be performed.
  • 10019 = TeamSizeNotCorrect - The tournament team size does not match the team passed in.
  • 10020 = ActionNotAllowed - The action is not allowed.
  • 10022 = TournamentIpRestricted - The tournament is IP restricted and needs to be joined from Challengermode.com.
  • 10023 = TournamentRequiresReservation - The tournament is not open for everyone and requires an invitation.
  • 10024 = TournamentTierRestricted - The tournament is tier restricted.
  • 11000 = OAuthUnsupportedGrantType - An unsupported grant type was used.
  • 11001 = OAuthTokenExchangeError - An error occurred during token exchange.
  • 11002 = OAuthAssertionMissing - The token exchange request is missing required assertion parameter.
  • 11003 = OAuthClientNotFound - Specified OAuth client could not be found.
  • 11004 = OAuthAssertionGrantProviderNotAuthorized - Client is not authorized to use assertion grant flow using the specificed provider.
  • 11005 = OAuthAssertionValidationFailed - Assertion grant is invalid.
  • 11006 = OAuthUserCodeMissing - Usercode argument missing.
  • 11007 = OAuthUserCodeWrong - Could not find any session corresponding to the provided user code.
  • 11008 = EmailInvalid - The email address is invalid.
  • 11009 = EmailClaimed - The email is already used by another user.
  • 11010 = CreateUsernameFailed - Challengermode was unable to generate a unique username based on the provided preferred username. Provide either another preferred username, or provide none to let Challengermode generate a unique username.
  • 11012 = CountryInvalid - The provided country code was either 1) not a valid country code according to the ISO 3166-1 alpha-2 format, or 2) a country which challengermode doesn't support.
  • 11013 = PlayerInOtherTeam - The player is already in another team.
  • 12001 = CompetitionStateInvalid - The competition state doesn't allow action.
  • 13001 = InvalidTeamSize - Invalid team size.
  • 13002 = RestrictionNotMet - One or more team members does not match all the restrictions for this competition.
  • 13003 = RegistrationClosed - The current state of the cup does not allow anyone to join.
  • 13004 = TooFewTeams - Action requires more teams to join the competition.
  • 16000 = NoRunningLadder - This ladder is not open for joining.
  • 16010 = AlreadyJoinedLadder - This game account has already joined this ladder.
  • 110011 = UserBanned - User is banned.
  • 1049006 = GameIntegrationNotConfigured - The game integration is not correctly configured.
  • 1049007 = GameAccountNotLinked - No game account is linked for this game and user.
  • 1049008 = InvalidGameSettings - Indicates that provided game settings are not compatible with the game's associated game settings json schema configured on Challengermode.

ProblemDetails

Field
Type
Description
Type
string
Title
string
Status
string
Detail
string
Instance
string

Country

Field
Type
Description
code
string

ISO 3166-1 alpha-2 country code

blocked
boolean

Denotes if the country has been blocked.