Skip to main content

Creates a new binding between an IDP and a Group

POST 
/references/users/groups/:groupID/idp-binding

'Creates a new mapping between a given IDP Configuration and a user group. No group may have the same IDP Configuration mapped to it multiple times.'

Request​

Path Parameters

    groupID uuidrequired

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 create a binding between an IDP and user group

    SsoConfigurationID uuidrequired

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

    ExternalID ExternalID (string)required

    Possible values: <= 64 characters

    Identifier for a user group used to identify it for permission management purposes

Responses​

A mapping between an IDP Configuration and a User Group

Response Headers

  • x-fapi-interaction-id

    string

Schema

    SsoConfigurationID uuidrequired

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

    ExternalID ExternalID (string)required

    Possible values: <= 64 characters

    Identifier for a user group used to identify it for permission management purposes

    ID uuid

    Unique identifier of the given mapping between an IDP Configuration and User Group

    OrganisationID OrganisationId (string)

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

    Unique ID associated with the organisation

    ServerID uuid

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

    DisplayName SsoConfigurationDisplayName (string)

    Possible values: <= 64 characters

    Display name for the SSO configuration

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