Jump to

• Request
• Response
• Examples

Create a workspace client

post

/admin/workspaceClients

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

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
• fusion-client-id: object fusion-client-id
  This is the client ID that comes from the token, created by the Fusion token mapper in FA Topology Manager
• global-oidc-server-data: object global-oidc-server-data
  Additional Properties Allowed: additionalProperties

  The required secret information to request access tokens with the identity of the workspace client. The object is keyed by the name of the global OIDCServer entry. This configuration is mainly used for inbound token translation from a non-Industries Framework to a Industries Framework token as done by TokenMapper.
• 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
• workspace-oidc-server-data: object workspace-oidc-server-data
  Additional Properties Allowed: additionalProperties

  the required secret information to request access tokens with the identity of the workspace client. The object is keyed by the name of the OIDCServer entry in the workspace

{
    "properties":{
        "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"
                        ]
                    }
                ]
            }
        },
        "fusion-client-id":{
            "description":"This is the client ID that comes from the token, created by the Fusion token mapper in FA Topology Manager\n",
            "type":"object",
            "properties":{
                "client-id":{
                    "type":"string"
                }
            }
        },
        "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
        },
        "workspace-oidc-server-data":{
            "type":"object",
            "description":"the required secret information to request access tokens with the identity of the workspace client. The\nobject is keyed by the name of the OIDCServer entry in the workspace\n",
            "additionalProperties":{
                "type":"object",
                "properties":{
                    "description":{
                        "description":"meant to capture record level documentation\n",
                        "type":"string"
                    },
                    "client-id":{
                        "type":"string",
                        "description":"reference to the secret that contains the OAuth 2 client ID\n"
                    },
                    "client-secret":{
                        "type":"string",
                        "description":"reference to the secret that contains the OAuth 2 client secret\n"
                    },
                    "signing-key":{
                        "type":"string",
                        "description":"reference to the secret that contains the RFC7523 request signing key\n"
                    }
                },
                "anyOf":[
                    {
                        "required":[
                            "client-id",
                            "client-secret",
                            "signing-key"
                        ]
                    }
                ]
            }
        },
        "global-oidc-server-data":{
            "description":"The required secret information to request access tokens with the identity of the workspace client. The object is keyed by the name of the global OIDCServer entry. This configuration is mainly used for inbound token translation from a non-Industries Framework to a Industries Framework token as done by TokenMapper.",
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "properties":{
                    "description":{
                        "description":"meant to capture record level documentation\n",
                        "type":"string"
                    },
                    "client-id":{
                        "type":"string",
                        "description":"reference to the secret that contains the OAuth 2 client ID\n"
                    },
                    "client-secret":{
                        "type":"string",
                        "description":"reference to the secret that contains the OAuth 2 client secret. Only needed in case of a Fusion app as\nclient\n"
                    },
                    "signing-key":{
                        "type":"string",
                        "description":"reference to the secret that contains the RFC7523 request signing key. Only needed in case of a Fusion\napp as client\n"
                    }
                },
                "anyOf":[
                    {
                        "required":[
                            "client-id"
                        ]
                    }
                ]
            }
        }
    },
    "oneOf":[
        {
            "required":[
                "global-oidc-server-data"
            ]
        }
    ]
}

Match One Schema

Show Source

{
    "properties":{
        "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"
                        ]
                    }
                ]
            }
        },
        "fusion-client-id":{
            "description":"This is the client ID that comes from the token, created by the Fusion token mapper in FA Topology Manager\n",
            "type":"object",
            "properties":{
                "client-id":{
                    "type":"string"
                }
            }
        },
        "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
        },
        "workspace-oidc-server-data":{
            "type":"object",
            "description":"the required secret information to request access tokens with the identity of the workspace client. The\nobject is keyed by the name of the OIDCServer entry in the workspace\n",
            "additionalProperties":{
                "type":"object",
                "properties":{
                    "description":{
                        "description":"meant to capture record level documentation\n",
                        "type":"string"
                    },
                    "client-id":{
                        "type":"string",
                        "description":"reference to the secret that contains the OAuth 2 client ID\n"
                    },
                    "client-secret":{
                        "type":"string",
                        "description":"reference to the secret that contains the OAuth 2 client secret\n"
                    },
                    "signing-key":{
                        "type":"string",
                        "description":"reference to the secret that contains the RFC7523 request signing key\n"
                    }
                },
                "anyOf":[
                    {
                        "required":[
                            "client-id",
                            "client-secret",
                            "signing-key"
                        ]
                    }
                ]
            }
        },
        "global-oidc-server-data":{
            "description":"The required secret information to request access tokens with the identity of the workspace client. The object is keyed by the name of the global OIDCServer entry. This configuration is mainly used for inbound token translation from a non-Industries Framework to a Industries Framework token as done by TokenMapper.",
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "properties":{
                    "description":{
                        "description":"meant to capture record level documentation\n",
                        "type":"string"
                    },
                    "client-id":{
                        "type":"string",
                        "description":"reference to the secret that contains the OAuth 2 client ID\n"
                    },
                    "client-secret":{
                        "type":"string",
                        "description":"reference to the secret that contains the OAuth 2 client secret. Only needed in case of a Fusion app as\nclient\n"
                    },
                    "signing-key":{
                        "type":"string",
                        "description":"reference to the secret that contains the RFC7523 request signing key. Only needed in case of a Fusion\napp as client\n"
                    }
                },
                "anyOf":[
                    {
                        "required":[
                            "client-id"
                        ]
                    }
                ]
            }
        }
    },
    "oneOf":[
        {
            "required":[
                "global-oidc-server-data"
            ]
        }
    ]
}

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 : fusion-client-id

Type: object

This is the client ID that comes from the token, created by the Fusion token mapper in FA Topology Manager

Show Source

• client-id: string

{
    "description":"This is the client ID that comes from the token, created by the Fusion token mapper in FA Topology Manager\n",
    "type":"object",
    "properties":{
        "client-id":{
            "type":"string"
        }
    }
}

Nested Schema : global-oidc-server-data

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "description":"The required secret information to request access tokens with the identity of the workspace client. The object is keyed by the name of the global OIDCServer entry. This configuration is mainly used for inbound token translation from a non-Industries Framework to a Industries Framework token as done by TokenMapper.",
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "properties":{
            "description":{
                "description":"meant to capture record level documentation\n",
                "type":"string"
            },
            "client-id":{
                "type":"string",
                "description":"reference to the secret that contains the OAuth 2 client ID\n"
            },
            "client-secret":{
                "type":"string",
                "description":"reference to the secret that contains the OAuth 2 client secret. Only needed in case of a Fusion app as\nclient\n"
            },
            "signing-key":{
                "type":"string",
                "description":"reference to the secret that contains the RFC7523 request signing key. Only needed in case of a Fusion\napp as client\n"
            }
        },
        "anyOf":[
            {
                "required":[
                    "client-id"
                ]
            }
        ]
    }
}

The required secret information to request access tokens with the identity of the workspace client. The object is keyed by the name of the global OIDCServer entry. This configuration is mainly used for inbound token translation from a non-Industries Framework to a Industries Framework token as done by TokenMapper.

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 : workspace-oidc-server-data

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "description":"the required secret information to request access tokens with the identity of the workspace client. The\nobject is keyed by the name of the OIDCServer entry in the workspace\n",
    "additionalProperties":{
        "type":"object",
        "properties":{
            "description":{
                "description":"meant to capture record level documentation\n",
                "type":"string"
            },
            "client-id":{
                "type":"string",
                "description":"reference to the secret that contains the OAuth 2 client ID\n"
            },
            "client-secret":{
                "type":"string",
                "description":"reference to the secret that contains the OAuth 2 client secret\n"
            },
            "signing-key":{
                "type":"string",
                "description":"reference to the secret that contains the RFC7523 request signing key\n"
            }
        },
        "anyOf":[
            {
                "required":[
                    "client-id",
                    "client-secret",
                    "signing-key"
                ]
            }
        ]
    }
}

the required secret information to request access tokens with the identity of the workspace client. The object is keyed by the name of the OIDCServer entry in the workspace

Nested Schema : additionalProperties

Type: object

Show Source

• client-id: string
  reference to the secret that contains the OAuth 2 client ID
• client-secret: string
  reference to the secret that contains the OAuth 2 client secret. Only needed in case of a Fusion app as client
• description: string
  meant to capture record level documentation
• signing-key: string
  reference to the secret that contains the RFC7523 request signing key. Only needed in case of a Fusion app as client

{
    "type":"object",
    "properties":{
        "description":{
            "description":"meant to capture record level documentation\n",
            "type":"string"
        },
        "client-id":{
            "type":"string",
            "description":"reference to the secret that contains the OAuth 2 client ID\n"
        },
        "client-secret":{
            "type":"string",
            "description":"reference to the secret that contains the OAuth 2 client secret. Only needed in case of a Fusion app as\nclient\n"
        },
        "signing-key":{
            "type":"string",
            "description":"reference to the secret that contains the RFC7523 request signing key. Only needed in case of a Fusion\napp as client\n"
        }
    },
    "anyOf":[
        {
            "required":[
                "client-id"
            ]
        }
    ]
}

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"
            ]
        }
    ]
}

Nested Schema : additionalProperties

Type: object

Show Source

• client-id: string
  reference to the secret that contains the OAuth 2 client ID
• client-secret: string
  reference to the secret that contains the OAuth 2 client secret
• description: string
  meant to capture record level documentation
• signing-key: string
  reference to the secret that contains the RFC7523 request signing key

{
    "type":"object",
    "properties":{
        "description":{
            "description":"meant to capture record level documentation\n",
            "type":"string"
        },
        "client-id":{
            "type":"string",
            "description":"reference to the secret that contains the OAuth 2 client ID\n"
        },
        "client-secret":{
            "type":"string",
            "description":"reference to the secret that contains the OAuth 2 client secret\n"
        },
        "signing-key":{
            "type":"string",
            "description":"reference to the secret that contains the RFC7523 request signing key\n"
        }
    },
    "anyOf":[
        {
            "required":[
                "client-id",
                "client-secret",
                "signing-key"
            ]
        }
    ]
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Created

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 create a workspace client by submitting a POST request on the REST resource using cURL.

cURL Command

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

Example of Request Body

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

{
    "fusion-client-id": {
        "client-id": "fusion_client_id_1",
        "client-secret": "fusion_client_secret_1"
    },
    "workspace-oidc-server-data": {
        "buying": {
            "client-id": "csdhsdkj1wenkwqdnwcsdfsd33e",
      "client-secret": "s213q-wen23e2kwe-dsfdfdefd",
      "signing-key": "2jdpwe-dksckjdcd-1dewdecw"
        }
    },
    "global-oidc-server-data": {
        "Core": {
            "client-id": "core_client_id",
            "client-secret": "core_client_secret",
            "signing-key": "core_signing_key"
        }
    },
    "client-name": "Buying",
    "labels": [
        {
            "label-name": "wsc-label-n1",
            "label-value": "wsc-label-v1"
        },
        {
            "label-name": "wsc-label-n2",
            "label-value": "wsc-label-v2"
        }
    ],
    "client-identity-propagation-required": true
}

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