Jump to

• Request
• Response
• Examples

Update a workspace client

patch

/admin/workspaceClients/{id}

Request

Path Parameters

• id(required): string
  The id of the WorkspaceClient to be updated

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: array

Show Source

• Array of: object PatchDocument
  A JSONPatch document as defined by RFC 6902

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PatchDocument"
    }
}

Nested Schema : PatchDocument

Type: object

A JSONPatch document as defined by RFC 6902

Show Source

• from: string
  A string containing a JSON Pointer value.
• op(required): string
  Allowed Values: [ "add", "remove", "replace", "move", "copy", "test" ]

  The operation to be performed
• path(required): string
  A JSON-Pointer
• value: object value
  The value to be used within the operations.

{
    "description":"A JSONPatch document as defined by RFC 6902",
    "required":[
        "op",
        "path"
    ],
    "properties":{
        "op":{
            "type":"string",
            "description":"The operation to be performed",
            "enum":[
                "add",
                "remove",
                "replace",
                "move",
                "copy",
                "test"
            ]
        },
        "path":{
            "type":"string",
            "description":"A JSON-Pointer"
        },
        "value":{
            "type":"object",
            "description":"The value to be used within the operations."
        },
        "from":{
            "type":"string",
            "description":"A string containing a JSON Pointer value."
        }
    }
}

Nested Schema : value

Type: object

The value to be used within the operations.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : WorkspaceClient

Type: object

Show Source

• client-identity-propagation-required: boolean
  Default Value: false

  If set to false, then Routing will fall back to Industries Framework credentials for token issuance if no client app key credentials are set. TICs can also require that the original client's identity in scope of the target OIDC server is mandatory.
• client-name: string
  This is the name of the client application as it is shown in the configuration UX
• description: string
  meant to capture record level documentation
• fixed-users-for-user-assertion-by-tic: object fixed-users-for-user-assertion-by-tic
  Additional Properties Allowed: true

  the fixed user name to put into user assertion tokens instead the name that might come from an inbound user token. Also used for the translation case of client token to user assertion
• id: string
• labels: array labels
  Minimum Number of Items: 1

  Used in routing with workspace-routing-criteria
• supported-outbound-token-scopes: array supported-outbound-token-scopes
  Minimum Number of Items: 1

  List of allowed scopes that this Workspace Client can request when generating outbound token

{
    "properties":{
        "id":{
            "type":"string"
        },
        "description":{
            "description":"meant to capture record level documentation\n",
            "type":"string"
        },
        "client-name":{
            "description":"This is the name of the client application as it is shown in the configuration UX\n",
            "type":"string"
        },
        "supported-outbound-token-scopes":{
            "description":"List of allowed scopes that this Workspace Client can request when generating outbound token\n",
            "type":"array",
            "minItems":1,
            "items":{
                "type":"string",
                "nullable":false
            }
        },
        "labels":{
            "description":"Used in routing with workspace-routing-criteria\n",
            "type":"array",
            "minItems":1,
            "items":{
                "type":"object",
                "properties":{
                    "description":{
                        "description":"meant to capture record level documentation\n",
                        "type":"string"
                    },
                    "label-name":{
                        "type":"string"
                    },
                    "label-value":{
                        "type":"string",
                        "minLength":1
                    }
                },
                "oneOf":[
                    {
                        "required":[
                            "label-name"
                        ]
                    }
                ]
            }
        },
        "client-identity-propagation-required":{
            "description":"If set to false, then Routing will fall back to Industries Framework credentials for token issuance if no client app key credentials are set. TICs can also require that the original client's identity in scope of the target OIDC server is mandatory.",
            "type":"boolean",
            "default":false
        },
        "fixed-users-for-user-assertion-by-tic":{
            "type":"object",
            "additionalProperties":true,
            "description":"the fixed user name to put into user assertion tokens instead the name that might come from an\ninbound user token. Also used for the translation case of client token to user assertion\n",
            "maxLength":80
        }
    }
}

Nested Schema : fixed-users-for-user-assertion-by-tic

Type: object

Maximum Length: 80

Additional Properties Allowed: true

the fixed user name to put into user assertion tokens instead the name that might come from an inbound user token. Also used for the translation case of client token to user assertion

Nested Schema : labels

Type: array

Minimum Number of Items: 1

Used in routing with workspace-routing-criteria

Show Source

• Array of: object items

{
    "description":"Used in routing with workspace-routing-criteria\n",
    "type":"array",
    "minItems":1,
    "items":{
        "type":"object",
        "properties":{
            "description":{
                "description":"meant to capture record level documentation\n",
                "type":"string"
            },
            "label-name":{
                "type":"string"
            },
            "label-value":{
                "type":"string",
                "minLength":1
            }
        },
        "oneOf":[
            {
                "required":[
                    "label-name"
                ]
            }
        ]
    }
}

Nested Schema : supported-outbound-token-scopes

Type: array

Minimum Number of Items: 1

List of allowed scopes that this Workspace Client can request when generating outbound token

Show Source

• Array of: string

{
    "description":"List of allowed scopes that this Workspace Client can request when generating outbound token\n",
    "type":"array",
    "minItems":1,
    "items":{
        "type":"string",
        "nullable":false
    }
}

Nested Schema : items

Type: object

Show Source

• description: string
  meant to capture record level documentation
• label-name: string
• label-value: string
  Minimum Length: 1

{
    "type":"object",
    "properties":{
        "description":{
            "description":"meant to capture record level documentation\n",
            "type":"string"
        },
        "label-name":{
            "type":"string"
        },
        "label-value":{
            "type":"string",
            "minLength":1
        }
    },
    "oneOf":[
        {
            "required":[
                "label-name"
            ]
        }
    ]
}

Match One Schema

Show Source

{
    "type":"object",
    "properties":{
        "description":{
            "description":"meant to capture record level documentation\n",
            "type":"string"
        },
        "label-name":{
            "type":"string"
        },
        "label-value":{
            "type":"string",
            "minLength":1
        }
    },
    "oneOf":[
        {
            "required":[
                "label-name"
            ]
        }
    ]
}

400 Response

Bad Request

Body ()

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

Show Source

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

401 Response

Unauthorized

Body ()

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

Show Source

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

403 Response

Forbidden

Body ()

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

Show Source

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

404 Response

Not Found

Body ()

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

Show Source

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

409 Response

Conflict

Body ()

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

Show Source

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

Show Source

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error code extension

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

Back to Top

Examples

The following example shows how to update a workspace client by submitting a PATCH request on the REST resource using cURL.

cURL Command

curl -H 'Authorization: Bearer <Token>' -X PATCH https://{FABRIC_HOST}/admin/workspaceClients/{id} -H "Content-Type: application/json" -D @update_workspaceclient.json | json_pp

Example of Request Body

The following shows an example of the request body in JSON format.

[
    {
        "op": "add",
        "path": "labels/1",
        "value": {
            "label-name": "wsc-label-n2",
            "label-value": "wsc-label-v2"
        }
    }
]

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "client-name": "Buying",
    "labels": [
        {
            "label-name": "wsc-label-n1",
            "label-value": "wsc-label-v1"
        },
        {
            "label-name": "wsc-label-n2",
            "label-value": "wsc-label-v2"
        }
    ],
    "fusion-client-id": {},
    "client-identity-propagation-required": true,
    "id": "buyingpbgsp"
}

Back to Top