List All Clients

Scopes
read:client
offset
integer
min0
max
99999999999999

Page number of records you wish to skip before selecting records. Final skipped records count would be limit * offset.

limit
integer
min-1
max
500

Limit the number of results returned

sort_by
string

Properties that should be ordered by with their order type. To define order append it to the field with dot. For example: sort_by=email.asc or sort_by=email.desc

q
string

Additional query in PlusAuth Query Language format.

GET
/clients
1
2
3
Loading...
Response:
200
Loading...

Response Body Schema

results
array<object>
results.
client_id
string
REQUIRED

Unique client identifier.

results.
client_name
string
REQUIRED

Client name for displaying purposes.

results.
client_secret
string
REQUIRED

Unique client identifier.

results.
description
string

Additional description for the client

results.
first_party
boolean

Is client first party

results.
grant_types
array<string>
REQUIRED
results.
logo_uri
string
results.
logout_uris
array<string>
REQUIRED
results.
oidc_conformant
boolean
results.
redirect_uris
array<string>
REQUIRED
results.
response_types
array<string>
REQUIRED
results.
token_endpoint_auth_method
string
REQUIRED
results.
type
string
REQUIRED

Available Values:webserver-to-serversingle-page-applicationfinancialnative

results.
connectors
object
REQUIRED
results.connectors.
saml
object
results.connectors.saml.
consumer_service
string
REQUIRED

Your SAML SP's assertion consumer endpoint.

results.connectors.saml.
enabled
boolean
results.connectors.saml.
entity_id
string
REQUIRED
results.connectors.saml.
metadata_url
string

Your SAML SP's metadata URL.

results.connectors.saml.
relay_state
string

Application specific resource in an IDP initiated Single Sign-On scenario. In most instances this is blank.

results.connectors.saml.
request_binding
string
REQUIRED

Available Values:HTTP-POSTHTTP-Redirect

results.connectors.saml.
sign_assertions
boolean
results.connectors.saml.
sign_out_enabled
boolean
results.connectors.saml.
sign_out_url
string
results.connectors.saml.
signature_algorithm
string

Available Values:sha512sha256sha1

results.connectors.saml.
signed_requests
boolean
results.connectors.saml.
signing_certificate
string
results.connectors.saml.
mappings
object
REQUIRED
results.connectors.
wsfed
object
results.connectors.wsfed.
callback_url
string
REQUIRED

Your WS Fed application's callback uri.

results.connectors.wsfed.
enabled
boolean
results.connectors.wsfed.
realm
string
REQUIRED

Application identifier (wtrealm parameter)

results.connectors.wsfed.
validity
number
min60

Validity time in seconds

results.
extra_metadata
object
REQUIRED
results.
jwks
object
results.jwks.
keys
array<object>
REQUIRED
total
integer