Elements Manual
Elements 3 Manual
Elements 3 Manual
  • Welcome 👋
  • QUICK START
    • Elements in Five Minutes or Less
    • Accessing the Web UI (CRM)
    • Creating A User
  • General
    • General Concepts
    • N-Tier Architecture
    • Security Model
  • Core Features
    • Core API Overview
    • Sessions
    • Applications
    • Users and Profiles
    • Digital Goods
    • Progress and Missions
    • Leaderboards
    • Matchmaking
    • Followers
    • Friends
    • Reward Issuance
    • Save Data
    • Schemas and Metadata Specifications
    • Queries
      • Base Query Syntax
      • Boolean Queries
      • Object Graph Navigation
      • Advanced Operators
        • .ref
        • .name
    • Custom Code
      • Element Structure
      • RESTful APIs
      • Websockets
    • Auth Schemes
      • OIDC
      • OAuth2
  • Web 3
    • Omni Chain Support
    • Vaults
    • Wallets
    • Smart Contracts
      • Smart Contracts: Ethereum
      • Smart Contracts: Flow
      • Smart Contracts: Solana
      • Smart Contracts: Neo
  • CONFIGURATION
    • Direct Database Access and Batch Configuration
    • Batch Samples
      • Item Upload Bash Script Sample
      • Mission Upload Bash Script Sample
  • RESTful APIs
    • Swagger and Swagger UI
    • API Specification
      • /application
      • /application/configuration
      • /auth
      • /auth_scheme
        • /custom
        • /oauth2
        • /oidc
      • /blockchain
      • /followee
      • /follower
      • /friend
      • /google
      • /index
      • /inventory
      • /item
      • /large_object
      • /leaderboard
      • /rank
      • /score
      • /match
      • /mission
      • /progress
      • /reward_issuance
      • /schedule
      • /notification
      • /profile
      • /save_data
      • /metadata_spec
      • /mock_session
      • /session
      • /health
      • /version
      • /signup
      • /user
    • Javadocs
  • Releases
    • 3.1 Release Notes
Powered by GitBook
On this page
  1. RESTful APIs
  2. API Specification
  3. /auth_scheme

/oauth2

Previous/customNext/oidc

Last updated 1 month ago

Gets a specific Auth Scheme

get

Gets a specific Auth Scheme by the oAuth2AuthSchemeId.

Authorizations
Path parameters
oAuth2AuthSchemeIdanyRequired
Responses
400Error
application/json
401Error
application/json
403Error
application/json
404Error
application/json
409Error
application/json
500Error
application/json
501Error
application/json
503Error
application/json
default
default response
application/json
get
GET /api/rest/auth_scheme/oauth2/{oAuth2AuthSchemeId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*
{
  "code": "text",
  "message": "text"
}

Deletes an Auth Scheme

delete

Deletes an Auth Scheme with the specified id.

Authorizations
Path parameters
oAuth2AuthSchemeIdanyRequired
Responses
400Error
application/json
401Error
application/json
403Error
application/json
404Error
application/json
409Error
application/json
500Error
application/json
501Error
application/json
503Error
application/json
default
default response
application/json
delete
DELETE /api/rest/auth_scheme/oauth2/{oAuth2AuthSchemeId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*
{
  "code": "text",
  "message": "text"
}
  • GETLists all auth schemes in the system
  • POSTCreates a new Auth Scheme
  • GETGets a specific Auth Scheme
  • PUTUpdates an Auth Scheme
  • DELETEDeletes an Auth Scheme

Lists all auth schemes in the system

get

Requires SUPERUSER access. Gets a pagination of Auth Schemes for the given query.

Authorizations
Query parameters
offsetanyOptionalDefault: 0
countanyOptionalDefault: 20
tagsanyOptional
Responses
400Error
application/json
401Error
application/json
403Error
application/json
404Error
application/json
409Error
application/json
500Error
application/json
501Error
application/json
503Error
application/json
default
default response
application/json
get
GET /api/rest/auth_scheme/oauth2 HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*
{
  "code": "text",
  "message": "text"
}

Creates a new Auth Scheme

post

Creates a new Auth Scheme, from the data in the given auth scheme request

Authorizations
Body

Represents a request to update an Auth Scheme for an Application.

idanyRequired

The unique ID of the auth scheme.

nameanyRequired

A unique name used to identify the scheme within the instance of Elements. If using the same OAuth2 provider (e.g. Steam), it is recommended to suffix the name for each application when using multitenancy, e.g. steam_game1, steam_game2, etc.

validationUrlanyRequired

The URL to send the user token validation request to.

headersanyOptional

The headers required for the validation request.

paramsanyOptional

The query parameters required for the validation request.

responseIdMappinganyOptional

Determines how to map the user id in the response. For example "response.params.steamid"

Responses
400Error
application/json
401Error
application/json
403Error
application/json
404Error
application/json
409Error
application/json
500Error
application/json
501Error
application/json
503Error
application/json
default
default response
application/json
post
POST /api/rest/auth_scheme/oauth2 HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 180

{
  "id": null,
  "name": null,
  "validationUrl": null,
  "headers": [
    {
      "key": null,
      "value": null,
      "fromClient": null
    }
  ],
  "params": [
    {
      "key": null,
      "value": null,
      "fromClient": null
    }
  ],
  "responseIdMapping": null
}
{
  "code": "text",
  "message": "text"
}

Updates an Auth Scheme

put

Updates an Auth Scheme with the specified data in the auth scheme request.

Authorizations
Path parameters
oAuth2AuthSchemeIdanyRequired
Body

Represents a request to update an Auth Scheme for an Application.

idanyRequired

The unique ID of the auth scheme.

nameanyRequired

A unique name used to identify the scheme within the instance of Elements. If using the same OAuth2 provider (e.g. Steam), it is recommended to suffix the name for each application when using multitenancy, e.g. steam_game1, steam_game2, etc.

validationUrlanyRequired

The URL to send the user token validation request to.

headersanyOptional

The headers required for the validation request.

paramsanyOptional

The query parameters required for the validation request.

responseIdMappinganyOptional

Determines how to map the user id in the response. For example "response.params.steamid"

Responses
400Error
application/json
401Error
application/json
403Error
application/json
404Error
application/json
409Error
application/json
500Error
application/json
501Error
application/json
503Error
application/json
default
default response
application/json
put
PUT /api/rest/auth_scheme/oauth2/{oAuth2AuthSchemeId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 180

{
  "id": null,
  "name": null,
  "validationUrl": null,
  "headers": [
    {
      "key": null,
      "value": null,
      "fromClient": null
    }
  ],
  "params": [
    {
      "key": null,
      "value": null,
      "fromClient": null
    }
  ],
  "responseIdMapping": null
}
{
  "code": "text",
  "message": "text"
}