Skip to main content

Get the participant domain and roles claims and write to S3

GET 
/organisations/export/roles

triggers an open data export generating the roles endpoint

Request​

Header Parameters

    x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

Responses​

Export the roles for all the organisations

Response Headers

  • x-fapi-interaction-id

    string

Schema

  • Array [

    • OrganisationId OrganisationId (string)

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

    Unique ID associated with the organisation

    Status string

    Possible values: [Active, Pending, Withdrawn]

    Default value: Active

    Status of the directory registration of an organisation

    RegistrationNumber string

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

    Company registration number from company register i.e. Companies House registration number

    RegisteredName string

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

    ParentOrganisationReference string

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

    Parent Organisation Reference

    OrgDomainClaims

    object[]

  • Array [

    • AuthorisationDomainName string

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

    The authorisation domain name

    Status StatusEnum (string)

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

  • ]

    • OrgDomainRoleClaims

    object[]

  • Array [

    • AuthorisationDomainName string

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

    The authorisation domain name

    AuthorisationDomainRoleName AuthorisationDomainRoleName (string)

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

    The authorisation domain role name

    Status StatusEnum (string)

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

  • ]

  • ]

Loading...