API Reference
Log In
API Reference
These docs are for v31. Click to read the latest docs for v33.

/role-store/api/v1/identity-providers

post
https://example.com/role-store/api/v1/identity-providers

Create a new Identity Provider.

Body Params
uuid
string
required
length between 2 and 2042

Identity provider name, must be unique

string
enum
required

Token type. Only "JWT" is supported.

Allowed:
string
required
length ≤ 2042

JWT issuer

string
length ≤ 2042

Expected JWT audience. JWT aud claim must either have a single matching value or it must be have an array of values of which at least one value must match.

string
enum
required

JWT subject claim format

Allowed:
string

If jwt_subject_type is "dn" then jwt_subject_dn_username_attribute specifies the name of the attribute to be used as username when resolving the user

custom_attributes
array of objects
custom_attributes
string
enum

Method for obtaining the token verification public key

Allowed:
public_keys
array of objects
public_keys
string

Trust anchor for verifying X.509 certificates fetched from x5u urls. Required if public_key_method is "x5u"

string

Trust anchor for TLS server certificates used when fetching X.509 certificates or public keys from x5u urls. If not specified then system trust anchors will be used.

uri

The url in the token's x5u claim must start with the x5u_prefix or it will be rejected. x5u_prefix must be a valid https url. Required if public_key_method is "x5u-publickey".

boolean

Enable/Disable Identity Provider

uuid
required

ID of the PrivX user directory from which the users are resolved by token's sub claim. OIDC user directories are not supported.

uuid

Identity Provider Author

date-time

Creation time

date-time

Time of the last update

string

ID of the user who last updated the identity provider

Headers
string
required
Defaults to Bearer a-proper-token-goes-here

OAuth2 token

Responses

Updated over 2 years ago

Language
Credentials
OAuth2
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated over 2 years ago