GuidesAPI Reference
API Reference

Add a new trusted OpenID Connect Identity Provider to a Realm

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

Add a new trusted Identity Provider to a Realm.
Currently, only OAuth 2.0/OpenID Connect Providers can be used.

NOTE: You can create a maximum of 5 Identity Providers in a Realm.


Access Control:

  • The calling principal must have either "manageIdentityProviders" 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.

Body Params
string
required

Unique identifier the Identity Provider within a Realm

string

User-friendly name for the Identity Provider

string

Detailed text description of the Identity Provider

issuers
array of objects
issuers
string
enum
Defaults to device

Always "device" for now. Reserved for future use, new account types may be added in the future.

Allowed:
boolean

Defines if the Identity Provider is enabled

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

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.

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