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
Root Schema : schema
Type:
Show Source
object
-
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.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : publicSectorIdcsApplicationDetails-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.