GuidesAPI Reference
API Reference

Create a SAML identity provider

post
https://Use API Lookup for a base URL/realms//samlIdentityProviders

Create an identity provider

  • Supports the creation of SAML identity providers.
  • Addition of identity providers will not enable them by default, it needs to be enabled explicitly.


Access Control:

  • The calling principal must have "manageSamlIdentityProviders" action permission for the resource "{realm}" in the "account" service.
  • The calling principal MUST NOT include a project scope.
Path Params
string
required

HRN identifying the Realm. You can also use the shorthand "me" to refer to the Realm HRN indicated by your access token context.

Query Params
boolean

If set to true, only metadata content will be validated and SAML identity provider creation will be skipped. By default, false.

Body Params
string
required

IdP's display name.

string
required

Identity provider (okta/entra/generic).

string
required

Base-64 encoded metadata xml content.

string

Path to the IdP metadata file (file path or URL).

string

Issuer Id provided for the IdP. This will be extracted from the metadata if not provided.

string

Login url for the IdP. This will be extracted from the metadata if not provided.

Headers
string

Correlates HTTP requests between a client and server. If not present in the incoming request, it will be generated. This header and value will be included in all loglines including access logs. It will also be propagated to downstream services and returned in the response.

string

The unique for the request, used to track this request within the service. X-Request-ID value is NOT propagated to the downstream services.

Responses

Updated last month

Language
Credentials
Bearer
JWT
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated last month