Skip to main content

List OAuth Clients

GET 

/oauth-clients

This gets a list of OAuth clients.

Request

Query Parameters

    filters string

    Filter results using the standard syntax described in V3 API Standard Collection Parameters

    Filtering is supported for the following fields and operators:

    lastUsed: le, isnull

    Example: lastUsed le 2023-02-05T10:59:27.214Z

Responses

List of OAuth clients.

Schema

  • Array [

  • id stringrequired

    ID of the OAuth client

    businessName stringnullablerequired

    The name of the business the API Client should belong to

    homepageUrl stringnullablerequired

    The homepage URL associated with the owner of the API Client

    name stringrequired

    A human-readable name for the API Client

    description stringnullablerequired

    A description of the API Client

    accessTokenValiditySeconds int32required

    The number of seconds an access token generated for this API Client is valid for

    refreshTokenValiditySeconds int32required

    The number of seconds a refresh token generated for this API Client is valid for

    redirectUris string[]nullablerequired

    A list of the approved redirect URIs used with the authorization_code flow

    grantTypes GrantType (string)[]required

    Possible values: [CLIENT_CREDENTIALS, AUTHORIZATION_CODE, REFRESH_TOKEN]

    A list of OAuth 2.0 grant types this API Client can be used with

    accessType AccessType (string)required

    Possible values: [ONLINE, OFFLINE]

    The access type (online or offline) of this API Client

    type ClientType (string)required

    Possible values: [CONFIDENTIAL, PUBLIC]

    The type of the API Client (public or confidential)

    internal booleanrequired

    An indicator of whether the API Client can be used for requests internal to IDN

    enabled booleanrequired

    An indicator of whether the API Client is enabled for use

    strongAuthSupported booleanrequired

    An indicator of whether the API Client supports strong authentication

    claimsSupported booleanrequired

    An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow

    created date-timerequired

    The date and time, down to the millisecond, when the API Client was created

    modified date-timerequired

    The date and time, down to the millisecond, when the API Client was last updated

    secret stringnullable
    metadata stringnullable
    lastUsed date-timenullable

    The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed.

    scope string[]nullablerequired

    Scopes of the API Client.

  • ]

Loading...