Skip to main content

Creates an instance of sso configuration for a given authorisation server.

POST 
/organisations/:OrganisationId/authorisationservers/:AuthorisationServerId/sso-configuration

'Creates an instance of sso configuration for a given authorisation server. When combined with an approved SSO Configuration Version the subject authorisation server is able to act as an SSO provider to the platform'

Request​

Path Parameters

    OrganisationId OrganisationIdrequired

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

    The organisation ID

    AuthorisationServerId uuidrequired

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

    The authorisation server Id

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.

Body

Request object to configure a subject authorisation server with sso functionality

    DisplayName SsoConfigurationDisplayName (string)required

    Possible values: <= 64 characters

    Display name for the SSO configuration

    Contacts email[]required

    Possible values: >= 1, <= 10

    List of email addresses to act as points of contact for ecosystem administrators

    RedirectUriSuffix SsoConfigurationRedirectUriSuffix (string)

    Possible values: non-empty and <= 40 characters

    DNS text record value for the SSO configuration

Responses​

A single sso configuration option for a given authorisation server

Response Headers

  • x-fapi-interaction-id

    string

Schema

    DisplayName SsoConfigurationDisplayName (string)required

    Possible values: <= 64 characters

    Display name for the SSO configuration

    Contacts email[]required

    Possible values: >= 1, <= 10

    List of email addresses to act as points of contact for ecosystem administrators

    ID uuid

    Unique identifier of the given OpenID Connect Provider's SSO Configuration

    ServerID uuid

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

    RedirectUri uri

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

    An RFC-compliant redirect URI. Must use the http scheme and must be a valid absolute uri

    TextRecord string

    Possible values: <= 255 characters

    DNS text record value for the SSO configuration

    Status StatusEnum (string)

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

    CreatedAt date-time
    UpdatedAt date-time
Loading...