GuidesAPI Reference
API Reference

Enable identity provider

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

Enables a SAML identity provider for a realm. If there is any other enabled SAML identity provider, it will be disabled. The realm's login method will be changed to 'saml'. 'password' logins can also be allowed, if the 'allowPasswordLogin' parameter was provided.


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.

string
required

HRN for the specific SAML IdP configuration with a realm

Query Params
boolean

Flag indicating if password login should be allowed after enabling identity provider for the realm. If omitted, the value is defaulted to false.

true - both 'password' and 'saml' login methods are allowed false - 'saml' is the only allowed login method for the realm

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