Skip to content
Developers
No results found.

List Clients

Scopes
read:client

Query Parameters

fields
string | array<string>

Include only defined fields. You can pass this parameter multiple times or you can include all values separated by commas.

Examples: "id,created_at" 

limit
integer
min-1
max
500

Limit the number of results returned

Examples: 5 

offset
integer
min0
max
99999999999999

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

q
string

Additional query in PlusAuth Query Language format.

sort_by
string | array<string>

Properties that should be ordered by, with their ordering type. To define order type append it to the field with dot. You can pass this parameter multiple times or you can include all values separated by commas.

Examples: "id.asc,created_at.desc" "email.asc" 

GET
/clients
cURL
cURLC#DartGoJavaJavaScriptPHPPythonRubyRustSwift
1
2
3
Loading...
Response
200
Paginated list of clients
Loading...

Response Body Schema

total
integer
Required
results
array<object>
results.
client_id
string
Required
length
0-256

Unique client identifier.

results.
client_name
string
Required
length
1-64

Client name for displaying purposes.

results.
client_secret
string
Required
length
0-256

Unique client identifier.

results.
grant_types
array<string>
Required
results.
logout_uris
array<string>
Required
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.
description
string
length
1-256

Additional description for the client

results.
first_party
boolean

Is client first party

Default Value: true

results.
logo_uri
string
length
1-1024
results.
oidc_conformant
boolean
results.
advanced
object
Required
results.advanced.
pkce_required
boolean

Default Value: true

results.advanced.
devices
object
results.advanced.devices.
android
object
results.advanced.devices.android.
package_name
string
length
0-256
results.advanced.devices.android.
sha256_cert_fingerprints
array<string>
results.advanced.devices.
ios
object
results.advanced.devices.ios.
bundle_identifier
string
length
0-256
results.advanced.devices.ios.
team_id
string
length
0-256
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.
entity_id
string
Required
results.connectors.saml.
request_binding
string
Required

Available Values: HTTP-POSTHTTP-Redirect

results.connectors.saml.
enabled
boolean
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.
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.
realm
string
Required

Application identifier (wtrealm parameter)

results.connectors.wsfed.
audiences
array<string>
results.connectors.wsfed.
enabled
boolean
results.connectors.wsfed.
validity
integer
min60

Validity time in seconds

results.
extra_metadata
object
Required
results.
jwks
object
results.jwks.
keys
array<object>