Get all workspaces
get
https://{your_site_interface}/opa-hub/api/12.2.35/workspaces
This operation will get all workspaces.
Request
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
-
q: string
A JSON object for filtering matching property values within the collection
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.
Response
Supported Media Types
- application/json
200 Response
The request was successfully completed.
Nested Schema : workspace
Type:
Show Source
object
-
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.
Nested Schema : defaultChannels
Type:
array
Default channels for new deployments
Show Source
-
Array of:
string
Allowed Values:
[ "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
Nested Schema : workspaceUser
Type:
Show Source
object
-
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
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" ]