/oauth2
Requires SUPERUSER access. Gets a pagination of Auth Schemes for the given query.
020default response
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, from the data in the given auth scheme request
Represents a request to update an Auth Scheme for an Application.
The unique ID of the auth scheme.
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.
The URL to send the user token validation request to.
The headers required for the validation request.
The query parameters required for the validation request.
Determines how to map the user id in the response. For example "response.params.steamid"
default response
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"
}Gets a specific Auth Scheme by the oAuth2AuthSchemeId.
default response
GET /api/rest/auth_scheme/oauth2/{oAuth2AuthSchemeId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*
{
"code": "text",
"message": "text"
}Updates an Auth Scheme with the specified data in the auth scheme request.
Represents a request to update an Auth Scheme for an Application.
The unique ID of the auth scheme.
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.
The URL to send the user token validation request to.
The headers required for the validation request.
The query parameters required for the validation request.
Determines how to map the user id in the response. For example "response.params.steamid"
default response
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"
}Deletes an Auth Scheme with the specified id.
default response
DELETE /api/rest/auth_scheme/oauth2/{oAuth2AuthSchemeId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*
{
"code": "text",
"message": "text"
}Last updated