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

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

List all identity providers.

Responses

Response body

object

count

integer

items

array of objects

items

object

uuid

name

string

required

length between 2 and 2042

Identity provider name, must be unique

token_type

string

required

Token type. Only "JWT" is supported.

JWT

jwt_issuer

string

required

length ≤ 2042

JWT issuer

jwt_audience

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.

jwt_subject_type

string

required

JWT subject claim format

plain dn

jwt_subject_dn_username_attribute

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

object

field_name

string

required

Name of JWT token claim

type

string

required

Type of the custom attribute validation. "string_pattern" compares a claim value to a glob pattern. "numeric_range" checks that the claim value is within an expected numeric range. "ip_range" checks that claim value is an IP address within an IP range. "ip_client" check that claim value matches the IP address from which the token login REST API request is made.

string_pattern numeric_range ip_range ip_client

expected_value

string

Expected claim value as glob pattern when type is "string_pattern"

start

string

Start value. If type is numeric_range then start must be an integer or a float value in string format. If type is ip_range then start must be a valid IPv4 or IPv6 address.

end

string

End value. If type is numeric_range then the type of the value must match start and the value must not be smaller than start. If type is ip_range then the IP version must match start and the value must not be smaller than start.

public_key_method

string

Method for obtaining the token verification public key

static x5u x5u-publickey

public_keys

array of objects

public_keys

object

key_id

string

required

Key ID

comment

string

Comment

public_key

string

required

Public key in PKIX PEM format

x5u_trust_anchor

string

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

x5u_tls_trust_anchor

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.

x5u_prefix

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

enabled

boolean

Enable/Disable Identity Provider

users_directory

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.

author

uuid

Identity Provider Author

created

date-time

Creation time

updated

date-time

Time of the last update

updated_by

string

ID of the user who last updated the identity provider

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://example.com/role-store/api/v1/identity-providers?offset=0&limit=50' \
3
     --header 'Authorization: Bearer a-proper-token-goes-here' \
4
     --header 'accept: application/json'

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

application/json

200Successful response, returns an array of identity providers.

401Unauthorized request, OAuth2 authorization missing or invalid

403Unauthorized request, OAuth2 authorization OK but scope insufficient

404Resource not found

500Internal server error