Jump to

• Request
• Response

Get a workspace

get

https://{your_site_interface}/opa-hub/api/12.2.35/workspaces/{workspace-name}

This operation will get a workspace.

Request

Path Parameters

• workspace-name(required): string
  The name of the workspace

Query Parameters

• expand: string
  Comma separated list of named resources to expand, or "all" to expand all
• fields: string
  Comma separated list of fields to be returned
• links: string
  Comma separated list of links to be returned, or "none" to omit links

There's no request body for this operation.

Security

• Authorization: apiKey
  Type: apiKey

  Description: Obtain a bearer token from https://{your_site_interface}/opa-hub/api/12.2.17/auth and use it in the Authorization header as: Bearer {token}.
• oauth2_opa: oauth2
  Type: oauth2

  Description: POST the OAuth2 Client Credentials parameters to https://{your_site_interface}/opa-hub/api/12.2.17/auth and use the access token from the response in the Authorization header.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The request was successfully completed.

Body ()

Root Schema : workspace

Type: object

Show Source

• authorizationProvider: string
  The name of an authorization provider to use to secure interviews in the workspace.
• defaultChannels: array defaultChannels
  Default channels for new deployments
• description: string
  The description of the workspace
• lockChannels: boolean
  Lock channels for existing deployments
• name(required): string
  The name of the workspace
• users: array users
  The list of users that have roles in the workspace. List only contains the current user unless the caller is a Hub Administrator.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the workspace"
        },
        "description":{
            "type":"string",
            "description":"The description of the workspace"
        },
        "lockChannels":{
            "type":"boolean",
            "description":"Lock channels for existing deployments"
        },
        "defaultChannels":{
            "type":"array",
            "description":"Default channels for new deployments",
            "items":{
                "type":"string",
                "enum":[
                    "interview",
                    "webserviceAssess",
                    "webserviceInterview",
                    "embedjs"
                ]
            }
        },
        "users":{
            "type":"array",
            "description":"The list of users that have roles in the workspace. List only contains the current user unless the caller is a Hub Administrator.",
            "items":{
                "description":"An Intelligent Advisor Hub user",
                "$ref":"#/components/schemas/workspaceUser"
            }
        },
        "authorizationProvider":{
            "type":"string",
            "description":"The name of an authorization provider to use to secure interviews in the workspace.",
            "nullable":true
        }
    },
    "additionalProperties":false,
    "required":[
        "name"
    ]
}

Nested Schema : defaultChannels

Type: array

Default channels for new deployments

Show Source

• Array of: string
  Allowed Values: [ "interview", "webserviceAssess", "webserviceInterview", "embedjs" ]

{
    "type":"array",
    "description":"Default channels for new deployments",
    "items":{
        "type":"string",
        "enum":[
            "interview",
            "webserviceAssess",
            "webserviceInterview",
            "embedjs"
        ]
    }
}

Nested Schema : users

Type: array

The list of users that have roles in the workspace. List only contains the current user unless the caller is a Hub Administrator.

Show Source

• Array of: object workspaceUser

{
    "type":"array",
    "description":"The list of users that have roles in the workspace. List only contains the current user unless the caller is a Hub Administrator.",
    "items":{
        "description":"An Intelligent Advisor Hub user",
        "$ref":"#/components/schemas/workspaceUser"
    }
}

Nested Schema : workspaceUser

Type: object

Show Source

• fullName: string
  Read Only: true

  The user full name
• roles(required): array roles
  The list of roles that the user has in the workspace.
• userName(required): string
  The user

{
    "type":"object",
    "properties":{
        "userName":{
            "type":"string",
            "description":"The user"
        },
        "fullName":{
            "type":"string",
            "description":"The user full name",
            "readOnly":true
        },
        "roles":{
            "type":"array",
            "description":"The list of roles that the user has in the workspace.",
            "items":{
                "type":"string",
                "enum":[
                    "Deploy Admin",
                    "Policy Author",
                    "Determinations API",
                    "Chat Service",
                    "Viewer"
                ]
            }
        }
    },
    "additionalProperties":false,
    "required":[
        "roles",
        "userName"
    ]
}

Nested Schema : roles

Type: array

The list of roles that the user has in the workspace.

Show Source

• Array of: string
  Allowed Values: [ "Deploy Admin", "Policy Author", "Determinations API", "Chat Service", "Viewer" ]

{
    "type":"array",
    "description":"The list of roles that the user has in the workspace.",
    "items":{
        "type":"string",
        "enum":[
            "Deploy Admin",
            "Policy Author",
            "Determinations API",
            "Chat Service",
            "Viewer"
        ]
    }
}

404 Response

The requested resource does not exist.

410 Response

The requested resource is no longer available.

Back to Top