Skip to main content

Get metadata associated with an authorisation domain role

GET 
/references/authorisationdomainroles/:AuthorisationDomainRoleName/metadata

get all metadata associated with an authorisation domain role

Request​

Path Parameters

    AuthorisationDomainRoleName AuthorisationDomainRoleNamerequired

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

    Authorisation Domain Role Name. Eg:TPP

Query Parameters

    type string

    Get all of a specific type of metadata

    page integer

    The page number to return of the result set

    size integer

    The size of the pages to return

    sort string

    The field name to sort

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​

List of all metadata associated with an object

Response Headers

  • x-fapi-interaction-id

    string

Schema

  • Array [

    • MetadataId MetadataId (string)

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

    Unique Metadata Id

    DomainRoleName AuthorisationDomainRoleName (string)

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

    The authorisation domain role name

    Type string

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

    The type of metadata i.e. scope, grant_type...

    Name string

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

    The name of the metadata object

    Status StatusEnum (string)

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

  • ]

Loading...