Create a new SAML server configuration

post

http://127.0.0.1:8080/gmsRemoteAuth/SAML

Creates a new SAML identity provider configuration for SSO authentication. The server name must be unique and alphanumeric. Required fields include IdP metadata and X.509 certificate.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

SAML server configuration object containing IdP and SP settings

Request payload for creating a new SAML server configuration. Contains IdP metadata and optional SP settings.

name

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).

issuer

uri

required

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

idpEntityId

string

required

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

idpSingleSignOnServiceUrl

uri

required

IdP SSO URL where authentication requests are sent.

idpX509cert

string

required

IdP X.509 certificate in PEM format for validating SAML response signatures.

spEntityId

string

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

spAssertionConsumerServiceUrl

uri

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

idpSingleLogoutServiceUrl

uri

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

spSingleLogoutServiceUrl

uri

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

spX509cert

string

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

usernameAttr

string

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

rolesAttr

string

SAML attribute containing user roles for RBAC mapping. Optional.

applianceAccessGroupAttr

string

SAML attribute for appliance access group assignment. Optional.

defaultRole

string

Default role assigned when no role mapping exists. Optional.

authn_Request

boolean

Defaults to false

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

Responses

401

Unauthorized - authentication required or session expired

403

Forbidden - user lacks required READ_WRITE role

Language

Loading…

Response

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

application/json

200SAML configuration created successfully. Returns the new server ID.

400Bad request - validation failed

500Internal server error - failed to create SAML configuration