Skip to main content

Get all registered clients

GET 
/clients

get all ecosystem clients

Request​

Query Parameters

    page integer

    The page number to return of the result set

    size integer

    The size of the pages to return

    startDate date-time

    Optional start of date range to constrain the set of results returned. This will restrict the clients returned to those whose metadata was most recently modified after the specified startDate. The date must be supplied in RFC3339 format. If not supplied, the startDate used will be the epoch.

    Example: 2022-05-12T23:20:50Z
    endDate date-time

    Optional end of date range to constrain the set of results returned. This will restrict the clients returned to those whose metadata was most recently modified before the specified sendDate. The date must be supplied in RFC3339 format. If not supplied, the endDate used will be the current date and time.

    Example: 2022-05-15T23:20:50Z
    role string

    A role name, clients that have this role (whether active or inactive) will be returned. Clients with this role in an Inactive state will be returned but will not show the role in their roles array

    Example: RP-ROLE
    status string

    Return clients with a matching status. Available values are Active, Inactive and Suspended

    Example: Active
    name string

    Search the available clients based on a name match. Match is partial so a search for 'abc' will return clients 'abc','abc1', '1abc' and '1abc2'

    Example: A Client

Header Parameters

    x-fapi-auth-date string

    Possible values: Value must match regular expression ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$

    The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

    x-fapi-customer-ip-address string

    The PSU's IP address if the PSU is currently logged in with the TPP.

    x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    x-customer-user-agent string

    Indicates the user-agent that the PSU is using.

Responses​

All clients

Response Headers

  • x-fapi-interaction-id

    string

Schema

    content

    object[]

    The list of Registered Clients

  • Array [

    • redirect_uris uri[]

    Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

    The Software Statement redirect compliant URI

    post_logout_redirect_uris uri[]

    Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

    The Software Statement redirect compliant URI

    token_endpoint_auth_method TokenEndpointAuthMethod (string)

    Possible values: non-empty and <= 60 characters, [private_key_jwt, tls_client_auth, client_secret_basic]

    Default value: private_key_jwt

    Token endpoint authentication method

    use_mtls_endpoint_aliases MtlsEndpointAliases (boolean)

    Default value: true

    Is the client required to use endpoints defined in the Authorisation Server Discovery Document, or if non MTLS endpoints can be used

    grant_types string[]

    Possible values: non-empty and <= 40 characters

    authorization_details_types string[]

    Possible values: Value must match regular expression ^[^<>]*$

    Defines whether or not a client is allowed to send RAR requests with authorization_details of specific types

    response_types string[]

    Possible values: non-empty and <= 40 characters

    List of response types

    client_name ClientName (string)

    Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

    Software Statement client name

    client_uri uri

    Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

    The Software Statement client compliant URI

    homepage_uri uri

    Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

    The URI for the website with details about the application and its services

    logo_uri uri

    Possible values: Value must match regular expression ^(http://|https://).*.(svg|png|jpg|jpeg)$|(data:image/[a-zA-Z0-9;+=-]+,[A-Za-z0-9+/]*={0,2})$

    A compliant URI

    scope string

    Possible values: <= 255 characters

    String containing a space-separated list of scope values

    tos_uri uri

    Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

    The Software Statement terms of service compliant URI

    policy_uri uri

    Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

    A compliant URI string that points to a human-readable privacy policy document

    jwks_uri uri

    Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

    A compliant URI string referencing the client's JSON Web Key (JWK) Set

    software_id SoftwareStatementId (string)

    Possible values: <= 40 characters, Value must match regular expression ^[^<>]*$

    Unique Software Statement Id

    software_version SoftwareVersion (number)deprecated

    Possible values: <= 40 characters

    Software Statement version as provided by the organisation's software team

    client_id ClientId (string)

    Possible values: <= 255 characters, Value must match regular expression ^[^<>]*$

    Software Statement client Id

    claims string[]

    Possible values: <= 255 characters

    claims_in_verified_claims string[]

    Possible values: <= 255 characters

    roles string[]

    Possible values: <= 255 characters

    subject_type string
    sector_identifier_uri uri

    Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

    A compliant URI string referencing the client's sector identifier

    application_type string

    Possible values: [web]

    Default value: web

    OIDC application type response

    client_description string

    Possible values: <= 255 characters

    Client description

    status string

    Possible values: [Active, Suspended, Inactive]

    Default value: Active

    Is this client Active/Suspended/Inactive

    organisation_id OrganisationId (string)

    Possible values: non-empty and <= 40 characters, Value must match regular expression ^[^<>]*$

    Unique ID associated with the organisation

    org_id OrganisationId (string)

    Possible values: non-empty and <= 40 characters, Value must match regular expression ^[^<>]*$

    Unique ID associated with the organisation

    last_updated date-time

    JSONDatetime of last updated timestamp

    openid_federation_enabled OpenidFederationEnabled (boolean)

    Is this software statement enabled for federation

    openid_federation_entity_management_type OpenidFederationEntityManagementType (string)

    Possible values: [openid_entity_federation_managed, openid_entity_self_managed]

    The type of federation management that applies to this software statement

  • ]

    • totalPages integer
    totalSize integer

    pageable

    object

    number integer

    Page number

    sort

    object

    sorted boolean

    orderBy

    object[]

  • Array [

    • property string

    Name of the property used for sorting

    direction string

    Possible values: [ASC, DESC]

    Direction of sort, i.e. ascending or descending

    ignoreCase boolean

    Was the case ignored

    ascending boolean

    Whether ascending

  • ]

    • size integer

    Size of the page

    offset integer

    Offset

    sorted boolean

    Is the page sorted

    unpaged boolean

    Is this an unpaged response

    numberOfElements integer
    size integer
    offset integer
    empty boolean
    pageNumber integer
Loading...