Jump to

• Request
• Response
• Examples

Get a workspace

get

/admin/workspaces/{id}

Request

Path Parameters

• id(required): string
  The id of the workspace

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Workspace

Type: object

Show Source

• backup-schedule: string
  Minimum Length: 1

  the backup schedule of the workspace
• description: string
  meant to capture record level documentation
• enabled-features: array enabled-features
  the names of the enabled feature flags
• id: string
• path-parameter: string
  Minimum Length: 1

  the name of the path parameter appearing on external service URLs. Example https://api-gw/apis/01/... - here "01" is the path-parameter
• user-mapping: object user-mapping
  when present, this contains 2 mapping schemes for mapping the username in the inbound token to the corresponding username to assert when obtaining the outbound token. One scheme is to map user when the outbound target is Industries IDP and another when the outbound target is an external IDP (that is, other than the Industries one). Both schemes must be present as these are complementary (one mapping being the reverse of the other).
• workspace-name: string
  Minimum Length: 1

  the user-facing name of the workspace
• workspace-type: string
  Allowed Values: [ "Production", "Test" ]

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "description":{
            "description":"meant to capture record level documentation\n",
            "type":"string"
        },
        "workspace-name":{
            "description":"the user-facing name of the workspace\n",
            "type":"string",
            "nullable":false,
            "minLength":1
        },
        "path-parameter":{
            "description":"the name of the path parameter appearing on external service URLs. Example\nhttps://api-gw/apis/01/... - here \"01\" is the path-parameter\n",
            "type":"string",
            "nullable":false,
            "minLength":1
        },
        "workspace-type":{
            "type":"string",
            "nullable":false,
            "enum":[
                "Production",
                "Test"
            ]
        },
        "backup-schedule":{
            "description":"the backup schedule of the workspace\n",
            "type":"string",
            "nullable":false,
            "minLength":1
        },
        "user-mapping":{
            "description":"when present, this contains 2 mapping schemes for mapping the username in the inbound token\nto the corresponding username to assert when obtaining the outbound token. One scheme is to\nmap user when the outbound target is Industries IDP and another when the outbound target is\nan external IDP (that is, other than the Industries one). Both schemes must be present as\nthese are complementary (one mapping being the reverse of the other).\n",
            "type":"object",
            "properties":{
                "target-industries-idp-scheme":{
                    "type":"object",
                    "properties":{
                        "source-user-expression":{
                            "description":"regular expression to match the inbound username against and contains subgroup matchers\n(in parentheses).\n",
                            "type":"string"
                        },
                        "target-user-expression":{
                            "description":"expression for outbound username with placeholders to be replaced with the subgroups\nmatched in inbound username using source-user-expression. A simple example below.\nsource-user-expression - (.+)\ntarget-user-expression - corporate_$1\ninbound username - john.doe (regular expression match puts group 1 as 'john.doe')\noutbound username - corporate_john.doe (placeholder $1 replaced with group 1 value)\n",
                            "type":"string"
                        }
                    },
                    "oneOf":[
                        {
                            "required":[
                                "source-user-expression",
                                "target-user-expression"
                            ]
                        }
                    ]
                },
                "target-external-idp-scheme":{
                    "type":"object",
                    "properties":{
                        "source-user-expression":{
                            "description":"regular expression to match the inbound username against and contains subgroup matchers\n(in parentheses).\n",
                            "type":"string"
                        },
                        "target-user-expression":{
                            "description":"expression for outbound username with placeholders to be replaced with the subgroups\nmatched in inbound username using source-user-expression. A simple example below.\nsource-user-expression - (.+)\ntarget-user-expression - corporate_$1\ninbound username - john.doe (regular expression match puts group 1 as 'john.doe')\noutbound username - corporate_john.doe (placeholder $1 replaced with group 1 value)\n",
                            "type":"string"
                        }
                    },
                    "oneOf":[
                        {
                            "required":[
                                "source-user-expression",
                                "target-user-expression"
                            ]
                        }
                    ]
                }
            }
        },
        "enabled-features":{
            "description":"the names of the enabled feature flags\n",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : enabled-features

Type: array

the names of the enabled feature flags

Show Source

• Array of: string

{
    "description":"the names of the enabled feature flags\n",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : user-mapping

Type: object

when present, this contains 2 mapping schemes for mapping the username in the inbound token to the corresponding username to assert when obtaining the outbound token. One scheme is to map user when the outbound target is Industries IDP and another when the outbound target is an external IDP (that is, other than the Industries one). Both schemes must be present as these are complementary (one mapping being the reverse of the other).

Show Source

• target-external-idp-scheme: object target-external-idp-scheme
• target-industries-idp-scheme: object target-industries-idp-scheme

{
    "description":"when present, this contains 2 mapping schemes for mapping the username in the inbound token\nto the corresponding username to assert when obtaining the outbound token. One scheme is to\nmap user when the outbound target is Industries IDP and another when the outbound target is\nan external IDP (that is, other than the Industries one). Both schemes must be present as\nthese are complementary (one mapping being the reverse of the other).\n",
    "type":"object",
    "properties":{
        "target-industries-idp-scheme":{
            "type":"object",
            "properties":{
                "source-user-expression":{
                    "description":"regular expression to match the inbound username against and contains subgroup matchers\n(in parentheses).\n",
                    "type":"string"
                },
                "target-user-expression":{
                    "description":"expression for outbound username with placeholders to be replaced with the subgroups\nmatched in inbound username using source-user-expression. A simple example below.\nsource-user-expression - (.+)\ntarget-user-expression - corporate_$1\ninbound username - john.doe (regular expression match puts group 1 as 'john.doe')\noutbound username - corporate_john.doe (placeholder $1 replaced with group 1 value)\n",
                    "type":"string"
                }
            },
            "oneOf":[
                {
                    "required":[
                        "source-user-expression",
                        "target-user-expression"
                    ]
                }
            ]
        },
        "target-external-idp-scheme":{
            "type":"object",
            "properties":{
                "source-user-expression":{
                    "description":"regular expression to match the inbound username against and contains subgroup matchers\n(in parentheses).\n",
                    "type":"string"
                },
                "target-user-expression":{
                    "description":"expression for outbound username with placeholders to be replaced with the subgroups\nmatched in inbound username using source-user-expression. A simple example below.\nsource-user-expression - (.+)\ntarget-user-expression - corporate_$1\ninbound username - john.doe (regular expression match puts group 1 as 'john.doe')\noutbound username - corporate_john.doe (placeholder $1 replaced with group 1 value)\n",
                    "type":"string"
                }
            },
            "oneOf":[
                {
                    "required":[
                        "source-user-expression",
                        "target-user-expression"
                    ]
                }
            ]
        }
    }
}

Nested Schema : target-external-idp-scheme

Type: object

Show Source

• source-user-expression: string
  regular expression to match the inbound username against and contains subgroup matchers (in parentheses).
• target-user-expression: string
  expression for outbound username with placeholders to be replaced with the subgroups matched in inbound username using source-user-expression. A simple example below. source-user-expression - (.+) target-user-expression - corporate_$1 inbound username - john.doe (regular expression match puts group 1 as 'john.doe') outbound username - corporate_john.doe (placeholder $1 replaced with group 1 value)

{
    "type":"object",
    "properties":{
        "source-user-expression":{
            "description":"regular expression to match the inbound username against and contains subgroup matchers\n(in parentheses).\n",
            "type":"string"
        },
        "target-user-expression":{
            "description":"expression for outbound username with placeholders to be replaced with the subgroups\nmatched in inbound username using source-user-expression. A simple example below.\nsource-user-expression - (.+)\ntarget-user-expression - corporate_$1\ninbound username - john.doe (regular expression match puts group 1 as 'john.doe')\noutbound username - corporate_john.doe (placeholder $1 replaced with group 1 value)\n",
            "type":"string"
        }
    },
    "oneOf":[
        {
            "required":[
                "source-user-expression",
                "target-user-expression"
            ]
        }
    ]
}

Match One Schema

Show Source

{
    "type":"object",
    "properties":{
        "source-user-expression":{
            "description":"regular expression to match the inbound username against and contains subgroup matchers\n(in parentheses).\n",
            "type":"string"
        },
        "target-user-expression":{
            "description":"expression for outbound username with placeholders to be replaced with the subgroups\nmatched in inbound username using source-user-expression. A simple example below.\nsource-user-expression - (.+)\ntarget-user-expression - corporate_$1\ninbound username - john.doe (regular expression match puts group 1 as 'john.doe')\noutbound username - corporate_john.doe (placeholder $1 replaced with group 1 value)\n",
            "type":"string"
        }
    },
    "oneOf":[
        {
            "required":[
                "source-user-expression",
                "target-user-expression"
            ]
        }
    ]
}

Nested Schema : target-industries-idp-scheme

Type: object

Show Source

• source-user-expression: string
  regular expression to match the inbound username against and contains subgroup matchers (in parentheses).
• target-user-expression: string
  expression for outbound username with placeholders to be replaced with the subgroups matched in inbound username using source-user-expression. A simple example below. source-user-expression - (.+) target-user-expression - corporate_$1 inbound username - john.doe (regular expression match puts group 1 as 'john.doe') outbound username - corporate_john.doe (placeholder $1 replaced with group 1 value)

{
    "type":"object",
    "properties":{
        "source-user-expression":{
            "description":"regular expression to match the inbound username against and contains subgroup matchers\n(in parentheses).\n",
            "type":"string"
        },
        "target-user-expression":{
            "description":"expression for outbound username with placeholders to be replaced with the subgroups\nmatched in inbound username using source-user-expression. A simple example below.\nsource-user-expression - (.+)\ntarget-user-expression - corporate_$1\ninbound username - john.doe (regular expression match puts group 1 as 'john.doe')\noutbound username - corporate_john.doe (placeholder $1 replaced with group 1 value)\n",
            "type":"string"
        }
    },
    "oneOf":[
        {
            "required":[
                "source-user-expression",
                "target-user-expression"
            ]
        }
    ]
}

Match One Schema

Show Source

{
    "type":"object",
    "properties":{
        "source-user-expression":{
            "description":"regular expression to match the inbound username against and contains subgroup matchers\n(in parentheses).\n",
            "type":"string"
        },
        "target-user-expression":{
            "description":"expression for outbound username with placeholders to be replaced with the subgroups\nmatched in inbound username using source-user-expression. A simple example below.\nsource-user-expression - (.+)\ntarget-user-expression - corporate_$1\ninbound username - john.doe (regular expression match puts group 1 as 'john.doe')\noutbound username - corporate_john.doe (placeholder $1 replaced with group 1 value)\n",
            "type":"string"
        }
    },
    "oneOf":[
        {
            "required":[
                "source-user-expression",
                "target-user-expression"
            ]
        }
    ]
}

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

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

cURL Command

curl -H 'Authorization: Bearer <Token>' -X GET https://{FABRIC_HOST}/admin/workspaces/{id} -H "Content-Type: application/json" | json_pp

Example of Response Body

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

{
    "workspace-name": "Production",
    "path-parameter": "01",
    "workspace-type": "Production",
    "enabled-features": [
        "self-registration"
    ],
    "user-mapping": {
        "target-industries-idp-scheme": {
            "source-user-expression": "corporate_$1",
            "target-user-expression": "corporate_$1"
        },
        "target-external-idp-scheme": {
            "source-user-expression": "(.+)",
            "target-user-expression": "corporate_$1"
        }
    },
    "id": "dx-prod"
}

Back to Top