Skip to main content

Update a federation

PUT 
/references/federations/:FederationId

update a federation

Request​

Path Parameters

    FederationId uuidrequired

    Possible values: <= 36 characters

    The federation id

Body

required

Properties to create/update federation

    Name FederationName (string)required

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

    The name of the federation

    Description FederationDescription (string)

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

    The description of the federation

    OrganizationName FederationOrganizationName (string)

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

    The organization name of the federation

    Contacts FederationContact (string)[]

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

    The contacts of the federation

    LogoUri FederationLogoUri (string)

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

    The logo uri of the federation

    PolicyUri FederationPolicyUri (string)

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

    The policy uri of the federation

    HomepageUri FederationHomepageUri (string)

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

    The homepage uri of the federation

    Status StatusEnum (string)

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

    RemoteTrustAnchor uri

    Possible values: <= 255 characters

    The uri for a remote trust anchor

Responses​

Details of the federation item

Response Headers

  • x-fapi-interaction-id

    string

Schema

    ReferenceID uuid

    Possible values: <= 36 characters

    The ID of the federation

    Name FederationName (string)

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

    The name of the federation

    Description FederationDescription (string)

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

    The description of the federation

    FederationFetchEndpoint uri

    Possible values: <= 255 characters

    The fetch endpoint of the federation

    FederationListEndpoint uri

    Possible values: <= 255 characters

    The list endpoint of the federation

    FederationResolveEndpoint uri

    Possible values: <= 255 characters

    The resolve endpoint of the federation

    FederationTrustMarkStatusEndpoint uri

    Possible values: <= 255 characters

    The trust mark status endpoint of the federation

    FederationTrustMarkListEndpoint uri

    Possible values: <= 255 characters

    The trust mark list endpoint of the federation

    OrganizationName FederationOrganizationName (string)

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

    The organization name of the federation

    Contacts FederationContact (string)[]

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

    The contacts of the federation

    LogoUri FederationLogoUri (string)

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

    The logo uri of the federation

    PolicyUri FederationPolicyUri (string)

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

    The policy uri of the federation

    HomepageUri FederationHomepageUri (string)

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

    The homepage uri of the federation

    CreatedAt date-time
    Status StatusEnum (string)

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

    RemoteTrustAnchor uri

    Possible values: <= 255 characters

    The uri for a remote trust anchor

Loading...