Skip to main content

Update the status of a given Federation configuration

PUT 
/organisations/:OrganisationId/authorisationservers/:AuthorisationServerId/federation/:FederationConfigId

updates a specific federation configuration

Request​

Path Parameters

    OrganisationId OrganisationIdrequired

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

    The organisation ID

    AuthorisationServerId AuthorisationServerIdrequired

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

    The authorisation server Id

    FederationConfigId FederationConfigIdrequired

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

    The federation configuration 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 create a Federation configuration for an Auth server

    ConfigJson ConfigJson (string)

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

    JSON containing all Federation Configurations

    Status PolicyApprovalStatusEnum (string)

    Possible values: Value must match regular expression ^[^<>]*$, [active, assignable, pending, rejected]

    The status of the policy

Responses​

Single federation object

Response Headers

  • x-fapi-interaction-id

    string

Schema

    FederationConfigId FederationConfigId (string)

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

    Unique Federation Configuration Id

    AuthorisationServerId AuthorisationServerId (string)

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

    ConfigJson ConfigJson (string)

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

    JSON containing all Federation Configurations

    Version FederationVersion (integer)

    Version number of the Federation configuration

    Status PolicyApprovalStatusEnum (string)

    Possible values: Value must match regular expression ^[^<>]*$, [active, assignable, pending, rejected]

    The status of the policy

Loading...