HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. gmsRemoteAuth

Update an existing OAuth server configuration

put
http://127.0.0.1:8080/gmsRemoteAuth/OAuth

Updates an OAuth 2.0 server configuration identified by its ID. The client secret is optional; if not provided, the existing secret is preserved. The server name must be alphanumeric and the 'openid' scope is required.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32
required
≥ 1

Unique identifier of the OAuth server configuration to update. Must reference an existing OAuth server.

Body Params

OAuth server configuration object with updated values. Client secret is optional for updates.

OAuth server configuration for updating an existing OAuth provider. The client secret is optional; if omitted, the existing secret is preserved.

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

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

string
required

OAuth client identifier from OAuth provider application registration.

string

OAuth client secret. Optional for updates; if empty or omitted, the existing secret is preserved.

uri
required

OAuth authorization endpoint URL for user authentication redirect.

uri
required

OAuth token endpoint URL for exchanging authorization code for tokens.

string
required

Comma-separated OAuth scopes. Must include 'openid'. Duplicates are rejected and scopes are normalized to lowercase.

string
required

ID token claim key for extracting the username.

string

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

string

ID token claim key for appliance access group assignment. Optional; defaults to empty string.

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.

Updated about 12 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json

Updated about 12 hours ago

Did this page help you?