Create a new OAuth server configuration

post

http://127.0.0.1:8080/gmsRemoteAuth/OAuth

Creates a new OAuth 2.0 server configuration for remote authentication. The server name must be unique and alphanumeric. The 'openid' scope is required and automatically validated.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

OAuth server configuration object containing connection and authentication details.

OAuth server configuration for creating a new OAuth provider. All required fields must be provided including the client secret.

name

string

required

^[a-zA-Z0-9]+$

Unique alphanumeric identifier for the OAuth server. Must contain only alphanumeric characters.

clientID

string

required

OAuth client identifier from OAuth provider application registration.

clientSecret

string

required

OAuth client secret from OAuth provider. Required for POST, optional for PUT.

authenticationUrl

uri

required

OAuth authorization endpoint URL for user authentication redirect.

tokenUrl

uri

required

OAuth token endpoint URL for exchanging authorization code for tokens.

authorizationScopes

string

required

Comma-separated OAuth scopes. Must include 'openid'. Duplicates are rejected.

usernameKey

string

required

ID token claim key for extracting the username.

rolesKey

string

ID token claim key for RBAC role mapping. Optional; defaults to empty string.

applianceAccessGroupKey

string

ID token claim key for appliance access group assignment. Optional.

defaultRole

string

Default role for OAuth users without specific role assignment. Optional.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized - User lacks READ_WRITE role permission.

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

200OAuth server configuration created successfully.

400Bad Request - Invalid parameters or validation failure.

500Internal Server Error - Failed to create OAuth configuration.