Jump to

• Request
• Response

Update a domain's IDCS application details

patch

/fscmRestApi/resources/11.13.18.05/publicSectorIdcsApplicationDetails/{IntegrationId}

Request

Path Parameters

• IntegrationId(required): string
  The primary key column that uniquely identifies an integration application.

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ClientID: string
  Maximum Length: 80

  A transient attribute that uniquely identifies the client application. Managed directly using credential store API's.
• ClientSecret: string
  Maximum Length: 80

  A transient attribute that must be provided like a password to connect to the application. Managed directly using credential store API's.
• Description: string
  Maximum Length: 1000

  Description of the feature for which IDCS is configured. Populated by seed data.
• IntegrationApp: string
  Maximum Length: 100

  Integration application name for the identity domain as seen in Topology Manager for accessing the IDCS URL. Populated by seed data.
• Name: string
  Maximum Length: 100

  Name of the feature for which IDCS is configured. Populated by seed data.

{
    "type":"object",
    "properties":{
        "ClientID":{
            "maxLength":"80",
            "type":"string",
            "description":"A transient attribute that uniquely identifies the client application. Managed directly using credential store API's.",
            "nullable":true,
            "x-queryable":false
        },
        "Description":{
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the feature for which IDCS is configured. Populated by seed data.",
            "nullable":false
        },
        "ClientSecret":{
            "maxLength":"80",
            "type":"string",
            "description":"A transient attribute that must be provided like a password to connect to the application. Managed directly using credential store API's.",
            "nullable":true,
            "x-queryable":false
        },
        "IntegrationApp":{
            "maxLength":"100",
            "type":"string",
            "description":"Integration application name for the identity domain as seen in Topology Manager for accessing the IDCS URL. Populated by seed data.",
            "nullable":false
        },
        "Name":{
            "maxLength":"100",
            "type":"string",
            "description":"Name of the feature for which IDCS is configured. Populated by seed data.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : publicSectorIdcsApplicationDetails-item-response

Type: object

Show Source

• ClientID: string
  Maximum Length: 80

  A transient attribute that uniquely identifies the client application. Managed directly using credential store API's.
• ClientSecret: string
  Maximum Length: 80

  A transient attribute that must be provided like a password to connect to the application. Managed directly using credential store API's.
• Description: string
  Maximum Length: 1000

  Description of the feature for which IDCS is configured. Populated by seed data.
• IntegrationApp: string
  Maximum Length: 100

  Integration application name for the identity domain as seen in Topology Manager for accessing the IDCS URL. Populated by seed data.
• IntegrationId: string
  Maximum Length: 30

  The primary key column that uniquely identifies an integration application.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Maximum Length: 100

  Name of the feature for which IDCS is configured. Populated by seed data.

{
    "type":"object",
    "properties":{
        "Description":{
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the feature for which IDCS is configured. Populated by seed data.",
            "nullable":false,
            "x-queryable":true
        },
        "ClientSecret":{
            "maxLength":"80",
            "type":"string",
            "description":"A transient attribute that must be provided like a password to connect to the application. Managed directly using credential store API's.",
            "nullable":true,
            "x-queryable":false
        },
        "IntegrationApp":{
            "maxLength":"100",
            "type":"string",
            "description":"Integration application name for the identity domain as seen in Topology Manager for accessing the IDCS URL. Populated by seed data.",
            "nullable":false,
            "x-queryable":true
        },
        "ClientID":{
            "maxLength":"80",
            "type":"string",
            "description":"A transient attribute that uniquely identifies the client application. Managed directly using credential store API's.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "IntegrationId":{
            "maxLength":"30",
            "type":"string",
            "description":"The primary key column that uniquely identifies an integration application.",
            "nullable":false,
            "x-queryable":true
        },
        "Name":{
            "maxLength":"100",
            "type":"string",
            "description":"Name of the feature for which IDCS is configured. Populated by seed data.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top