Workspace

Workspace #

Package : spaceone.api.identity.v2



Workspace #

Workspace Methods:

MethodRequestResponse
createCreateWorkSpaceRequestWorkspaceInfo
updateUpdateWorkSpaceRequestWorkspaceInfo
change_workspace_groupChangeWorkspaceGroupRequestWorkspaceInfo
deleteWorkspaceDeleteRequestEmpty
enableWorkspaceRequestWorkspaceInfo
disableWorkspaceRequestWorkspaceInfo
add_packageWorkspacePackageRequestWorkspaceInfo
remove_packageWorkspacePackageRequestWorkspaceInfo
getWorkspaceRequestWorkspaceInfo
checkWorkspaceCheckRequestEmpty
listWorkspaceSearchQueryWorkspacesInfo
statWorkspaceStatQueryStruct

create #

POST /identity/v2/workspace/create

CreateWorkSpaceRequest

  • name (string) Required

  • tags (Struct) Required

{
 "name": "Cloudforet Workspace"
}

WorkspaceInfo

  • workspace_id (string) Required

  • name (string) Required

  • state (State) Required

  • tags (Struct) Required

  • created_by (string) Required

  • references (string) Repeated Required

  • is_managed (bool) Required

  • packages (string) Repeated Required

  • is_dormant (bool) Required

  • dormant_ttl (int32) Required

  • service_account_count (int32) Required

  • user_count (int32) Required

  • cost_info (WorkspaceCostInfo) Required

  • workspace_group_id (string) Required

  • domain_id (string) Required

  • trusted_account_id (string) Required

  • created_at (string) Required

  • last_synced_at (string) Required

  • dormant_updated_at (string) Required

  • changed_at (string) Required

{
 "workspace_id": "workspace-a1b2c3d4e5f6",
 "name": "Cloudforet Workspace",
 "state": "ENABLED",
 "created_by": "cloudforet@cloudforet.io",
 "dormant_ttl": -1,
 "cost_info": {},
 "workspace_group_id": "wg-a1b2c3d4e5f6",
 "domain_id": "domain-a1b2c3d4e5f6",
 "created_at": "2024-11-12T08:14:04.011Z"
}

update #

POST /identity/v2/workspace/update

UpdateWorkSpaceRequest

  • workspace_id (string) Required

  • name (string)

  • tags (Struct)

{
 "workspace_id": "workspace-a1b2c3d4e5f6",
 "name": "Cloudforet Workspace"
}

WorkspaceInfo

  • workspace_id (string) Required

  • name (string) Required

  • state (State) Required

  • tags (Struct) Required

  • created_by (string) Required

  • references (string) Repeated Required

  • is_managed (bool) Required

  • packages (string) Repeated Required

  • is_dormant (bool) Required

  • dormant_ttl (int32) Required

  • service_account_count (int32) Required

  • user_count (int32) Required

  • cost_info (WorkspaceCostInfo) Required

  • workspace_group_id (string) Required

  • domain_id (string) Required

  • trusted_account_id (string) Required

  • created_at (string) Required

  • last_synced_at (string) Required

  • dormant_updated_at (string) Required

  • changed_at (string) Required

{
 "workspace_id": "workspace-a1b2c3d4e5f6",
 "name": "Cloudforet Workspace",
 "state": "ENABLED",
 "created_by": "cloudforet@cloudforet.io",
 "dormant_ttl": -1,
 "cost_info": {},
 "workspace_group_id": "wg-a1b2c3d4e5f6",
 "domain_id": "domain-a1b2c3d4e5f6",
 "created_at": "2024-11-12T08:14:04.011Z"
}

change_workspace_group #

POST /identity/v2/workspace/change-workspace-group

ChangeWorkspaceGroupRequest

  • workspace_id (string) Required

  • workspace_group_id (string)

{
 "workspace_id": "workspace-a1b2c3d4e5f6",
 "workspace_group_id": "wg-a1b2c3d4e5f6"
}

WorkspaceInfo

  • workspace_id (string) Required

  • name (string) Required

  • state (State) Required

  • tags (Struct) Required

  • created_by (string) Required

  • references (string) Repeated Required

  • is_managed (bool) Required

  • packages (string) Repeated Required

  • is_dormant (bool) Required

  • dormant_ttl (int32) Required

  • service_account_count (int32) Required

  • user_count (int32) Required

  • cost_info (WorkspaceCostInfo) Required

  • workspace_group_id (string) Required

  • domain_id (string) Required

  • trusted_account_id (string) Required

  • created_at (string) Required

  • last_synced_at (string) Required

  • dormant_updated_at (string) Required

  • changed_at (string) Required

{
 "workspace_id": "workspace-a1b2c3d4e5f6",
 "name": "Cloudforet Workspace",
 "state": "ENABLED",
 "created_by": "cloudforet@cloudforet.io",
 "dormant_ttl": -1,
 "cost_info": {},
 "workspace_group_id": "wg-a1b2c3d4e5f6",
 "domain_id": "domain-a1b2c3d4e5f6",
 "created_at": "2024-11-12T08:14:04.011Z"
}

delete #

POST /identity/v2/workspace/delete

WorkspaceDeleteRequest

  • workspace_id (string) Required

  • force (bool) Required

{
 "workspace_id": "workspace-a1b2c3d4e5f6",
 "force": true
}

enable #

POST /identity/v2/workspace/enable

WorkspaceRequest

  • workspace_id (string) Required
{
 "workspace_id": "workspace-a1b2c3d4e5f6"
}

WorkspaceInfo

  • workspace_id (string) Required

  • name (string) Required

  • state (State) Required

  • tags (Struct) Required

  • created_by (string) Required

  • references (string) Repeated Required

  • is_managed (bool) Required

  • packages (string) Repeated Required

  • is_dormant (bool) Required

  • dormant_ttl (int32) Required

  • service_account_count (int32) Required

  • user_count (int32) Required

  • cost_info (WorkspaceCostInfo) Required

  • workspace_group_id (string) Required

  • domain_id (string) Required

  • trusted_account_id (string) Required

  • created_at (string) Required

  • last_synced_at (string) Required

  • dormant_updated_at (string) Required

  • changed_at (string) Required

{
 "workspace_id": "workspace-a1b2c3d4e5f6",
 "name": "Cloudforet Workspace",
 "state": "ENABLED",
 "created_by": "cloudforet@cloudforet.io",
 "dormant_ttl": -1,
 "cost_info": {},
 "workspace_group_id": "wg-a1b2c3d4e5f6",
 "domain_id": "domain-a1b2c3d4e5f6",
 "created_at": "2024-11-12T08:14:04.011Z"
}

disable #

POST /identity/v2/workspace/disable

WorkspaceRequest

  • workspace_id (string) Required
{
 "workspace_id": "workspace-a1b2c3d4e5f6"
}

WorkspaceInfo

  • workspace_id (string) Required

  • name (string) Required

  • state (State) Required

  • tags (Struct) Required

  • created_by (string) Required

  • references (string) Repeated Required

  • is_managed (bool) Required

  • packages (string) Repeated Required

  • is_dormant (bool) Required

  • dormant_ttl (int32) Required

  • service_account_count (int32) Required

  • user_count (int32) Required

  • cost_info (WorkspaceCostInfo) Required

  • workspace_group_id (string) Required

  • domain_id (string) Required

  • trusted_account_id (string) Required

  • created_at (string) Required

  • last_synced_at (string) Required

  • dormant_updated_at (string) Required

  • changed_at (string) Required

{
 "workspace_id": "workspace-a1b2c3d4e5f6",
 "name": "Cloudforet Workspace",
 "state": "ENABLED",
 "created_by": "cloudforet@cloudforet.io",
 "dormant_ttl": -1,
 "cost_info": {},
 "workspace_group_id": "wg-a1b2c3d4e5f6",
 "domain_id": "domain-a1b2c3d4e5f6",
 "created_at": "2024-11-12T08:14:04.011Z"
}

add_package #

POST /identity/v2/workspace/add-package

WorkspacePackageRequest

  • workspace_id (string) Required

  • package_id (string) Required

{
 "workspace_id": "workspace-a1b2c3d4e5f6",
 "package_id": "package-a1b2c3d4e5f6"
}

WorkspaceInfo

  • workspace_id (string) Required

  • name (string) Required

  • state (State) Required

  • tags (Struct) Required

  • created_by (string) Required

  • references (string) Repeated Required

  • is_managed (bool) Required

  • packages (string) Repeated Required

  • is_dormant (bool) Required

  • dormant_ttl (int32) Required

  • service_account_count (int32) Required

  • user_count (int32) Required

  • cost_info (WorkspaceCostInfo) Required

  • workspace_group_id (string) Required

  • domain_id (string) Required

  • trusted_account_id (string) Required

  • created_at (string) Required

  • last_synced_at (string) Required

  • dormant_updated_at (string) Required

  • changed_at (string) Required

{
 "workspace_id": "workspace-a1b2c3d4e5f6",
 "name": "Cloudforet Workspace",
 "state": "ENABLED",
 "created_by": "cloudforet@cloudforet.io",
 "dormant_ttl": -1,
 "cost_info": {},
 "workspace_group_id": "wg-a1b2c3d4e5f6",
 "domain_id": "domain-a1b2c3d4e5f6",
 "created_at": "2024-11-12T08:14:04.011Z"
}

remove_package #

POST /identity/v2/workspace/remove-package

WorkspacePackageRequest

  • workspace_id (string) Required

  • package_id (string) Required

{
 "workspace_id": "workspace-a1b2c3d4e5f6",
 "package_id": "package-a1b2c3d4e5f6"
}

WorkspaceInfo

  • workspace_id (string) Required

  • name (string) Required

  • state (State) Required

  • tags (Struct) Required

  • created_by (string) Required

  • references (string) Repeated Required

  • is_managed (bool) Required

  • packages (string) Repeated Required

  • is_dormant (bool) Required

  • dormant_ttl (int32) Required

  • service_account_count (int32) Required

  • user_count (int32) Required

  • cost_info (WorkspaceCostInfo) Required

  • workspace_group_id (string) Required

  • domain_id (string) Required

  • trusted_account_id (string) Required

  • created_at (string) Required

  • last_synced_at (string) Required

  • dormant_updated_at (string) Required

  • changed_at (string) Required

{
 "workspace_id": "workspace-a1b2c3d4e5f6",
 "name": "Cloudforet Workspace",
 "state": "ENABLED",
 "created_by": "cloudforet@cloudforet.io",
 "dormant_ttl": -1,
 "cost_info": {},
 "workspace_group_id": "wg-a1b2c3d4e5f6",
 "domain_id": "domain-a1b2c3d4e5f6",
 "created_at": "2024-11-12T08:14:04.011Z"
}

get #

POST /identity/v2/workspace/get

WorkspaceRequest

  • workspace_id (string) Required
{
 "workspace_id": "workspace-a1b2c3d4e5f6"
}

WorkspaceInfo

  • workspace_id (string) Required

  • name (string) Required

  • state (State) Required

  • tags (Struct) Required

  • created_by (string) Required

  • references (string) Repeated Required

  • is_managed (bool) Required

  • packages (string) Repeated Required

  • is_dormant (bool) Required

  • dormant_ttl (int32) Required

  • service_account_count (int32) Required

  • user_count (int32) Required

  • cost_info (WorkspaceCostInfo) Required

  • workspace_group_id (string) Required

  • domain_id (string) Required

  • trusted_account_id (string) Required

  • created_at (string) Required

  • last_synced_at (string) Required

  • dormant_updated_at (string) Required

  • changed_at (string) Required

{
 "workspace_id": "workspace-a1b2c3d4e5f6",
 "name": "Cloudforet Workspace",
 "state": "ENABLED",
 "created_by": "cloudforet@cloudforet.io",
 "dormant_ttl": -1,
 "cost_info": {},
 "workspace_group_id": "wg-a1b2c3d4e5f6",
 "domain_id": "domain-a1b2c3d4e5f6",
 "created_at": "2024-11-12T08:14:04.011Z"
}

check #


list #

POST /identity/v2/workspace/list

WorkspaceSearchQuery

  • query (Query)

  • workspace_id (string)

  • name (string)

  • state (State)

  • created_by (string)

  • is_managed (bool)

  • is_dormant (bool)

  • workspace_group_id (string)

{
 "query": {
   "page": {
     "start": 1,
     "limit": 10
   }
 }
}

WorkspacesInfo

  • results (WorkspaceInfo) Repeated Required

  • total_count (int32) Required

{
 "results": [
 {
   "workspace_id": "workspace-a1b2c3d4e5f6",
   "name": "Cloudforet Workspace",
   "state": "ENABLED",
   "created_by": "wonny@cloudforet.io",
   "dormant_ttl": -1,
   "service_account_count": 0,
   "user_count": 0,
   "cost_info": {},
   "domain_id": "domain-a1b2c3d4e5f6",
   "created_at": "2024-11-12T08:25:08.762Z"
 },
 {
   "workspace_id": "workspace-g7h8i9j1k2l3",
   "name": "Wonny Workspace",
   "state": "ENABLED",
   "created_by": "cloudforet@cloudforet.io",
   "dormant_ttl": 0,
   "service_account_count": 0,
   "user_count": 0,
   "cost_info": {},
   "workspace_group_id": "wg-a1b2c3d4e5f6",
   "domain_id": "domain-g7h8i9j1k2l3",
   "created_at": "2024-11-12T08:14:04.011Z",
   "changed_at": "2024-11-12T08:43:39.945Z"
 }
 ],
 "total_count": 2
}

stat #

POST /identity/v2/workspace/stat



Message #

ChangeWorkspaceGroupRequest #

  • workspace_id (string) Required

  • workspace_group_id (string)


CreateWorkSpaceRequest #

  • name (string) Required

  • tags (Struct) Required


UpdateWorkSpaceRequest #

  • workspace_id (string) Required

  • name (string)

  • tags (Struct)


WorkspaceCheckRequest #

  • workspace_id (string) Required

  • domain_id (string) Required


WorkspaceCostInfo #

  • day (float) Required

  • month (float) Required


WorkspaceDeleteRequest #

  • workspace_id (string) Required

  • force (bool) Required


WorkspaceInfo #

  • workspace_id (string) Required

  • name (string) Required

  • state (State) Required

  • tags (Struct) Required

  • created_by (string) Required

  • references (string) Repeated Required

  • is_managed (bool) Required

  • packages (string) Repeated Required

  • is_dormant (bool) Required

  • dormant_ttl (int32) Required

  • service_account_count (int32) Required

  • user_count (int32) Required

  • cost_info (WorkspaceCostInfo) Required

  • workspace_group_id (string) Required

  • domain_id (string) Required

  • trusted_account_id (string) Required

  • created_at (string) Required

  • last_synced_at (string) Required

  • dormant_updated_at (string) Required

  • changed_at (string) Required


WorkspacePackageRequest #

  • workspace_id (string) Required

  • package_id (string) Required


WorkspaceRequest #

  • workspace_id (string) Required


WorkspaceSearchQuery #

  • query (Query)

  • workspace_id (string)

  • name (string)

  • state (State)

  • created_by (string)

  • is_managed (bool)

  • is_dormant (bool)

  • workspace_group_id (string)


WorkspaceStatQuery #

  • query (StatisticsQuery) Required


WorkspacesInfo #

  • results (WorkspaceInfo) Repeated Required

  • total_count (int32) Required


Calendar January 24, 2025
Edit Edit this page

Documentation Distributed under CC BY 4.0

Copyright © Cloudforet a Series of LF Projects, LLC. For website terms of use, trademark policy and other project policies please see https://lfprojects.org.