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

Update SAML server configuration

put
http://127.0.0.1:8080/gmsRemoteAuth/SAML

Updates an existing SAML identity provider configuration by ID. The server name must be unique and alphanumeric. If idpX509cert is not provided in the request, the existing certificate is retained.

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

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

Body Params

SAML server configuration object with updated IdP and SP settings

Request payload for updating an existing SAML server configuration. The idpX509cert is optional - if not provided, the existing certificate is retained.

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

Unique alphanumeric name for the SAML server. Must contain only letters and numbers (a-z, A-Z, 0-9).

uri
required

Identity Provider issuer URL. Identifies the IdP in SAML assertions.

string
required

Identity Provider Entity ID. Unique identifier for the IdP, often same as issuer.

uri
required

IdP SSO URL where authentication requests are sent.

string

IdP X.509 certificate in PEM format. Optional for update - if omitted, existing certificate is preserved.

string

Service Provider Entity ID. Unique identifier for the Orchestrator application.

uri

SP Assertion Consumer Service URL. Endpoint that receives SAML assertions.

uri

IdP Single Logout Service URL for SP-initiated logout. Optional.

uri

SP Single Logout Service URL for IdP-initiated logout. Optional.

string

SP X.509 certificate in PEM format for signing requests. Optional.

string

SAML attribute containing the username. Maps IdP user to Orchestrator.

string

SAML attribute containing user roles for RBAC mapping. Optional.

string

SAML attribute for appliance access group assignment. Optional.

string

Default role assigned when no role mapping exists. Optional.

boolean
Defaults to false

When true, sends signed AuthnRequest to IdP. Default: false.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized - authentication required or session expired.

403

Forbidden - user lacks required READ_WRITE role.

Updated about 13 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 13 hours ago

Did this page help you?