Role

Role #

Package : spaceone.api.identity.v2



Role #

Role Methods:

MethodRequestResponse
createCreateRoleRequestRoleInfo
updateUpdateRoleRequestRoleInfo
enableRoleRequestRoleInfo
disableRoleRequestRoleInfo
deleteRoleRequestEmpty
getRoleRequestRoleInfo
listRoleSearchQueryRolesInfo
list_basic_roleRoleSearchQueryRolesInfo
statRoleStatQueryStruct

create #

POST /identity/v2/role/create

CreateRoleRequest

  • name (string) Required

  • role_type (RoleType) Required

  • permissions (string) Repeated

  • page_access (string) Repeated

  • tags (Struct)

{
 "name": "Cloudforet User",
 "role_type": "WORKSPACE_MEMBER",
 "page_access": [
   "dashboards:restricted.*",
   "project:writable.*",
   "asset_inventory:writable.*",
   "cost_explorer:readonly.*",
   "alert_manager:restricted.*"
 ]
}

RoleInfo

  • role_id (string) Required

  • name (string) Required

  • role_type (RoleType) Required

  • permissions (string) Repeated Required

  • page_access (string) Repeated Required

  • tags (Struct) Required

  • is_managed (bool) Required

  • state (State) Required

  • domain_id (string) Required

  • created_at (string) Required

  • updated_at (string) Required

{
 "created_at": "2024-11-14T02:44:56.211Z",
 "domain_id": "domain-a1b2c3d4e5f6",
 "name": "Cloudforet User",
 "page_access": [
   "dashboards:restricted.*",
   "project:writable.*",
   "asset_inventory:writable.*",
   "cost_explorer:readonly.*",
   "alert_manager:restricted.*"
 ],
 "role_id": "role-5ce484d4b750",
 "role_type": "WORKSPACE_MEMBER",
 "state": "ENABLED",
 "updated_at": "2024-11-14T02:44:56.211Z"
}

update #

POST /identity/v2/role/update

UpdateRoleRequest

  • role_id (string) Required

  • name (string)

  • permissions (ListValue)

  • page_access (ListValue)

  • tags (Struct)

{
 "name": "Cloudforet User",
 "role_type": "WORKSPACE_MEMBER",
 "page_access": [
   "dashboards:restricted.*",
   "project:writable.*",
   "asset_inventory:writable.*",
   "cost_explorer:readonly.*",
   "alert_manager:restricted.*"
 ]
}

RoleInfo

  • role_id (string) Required

  • name (string) Required

  • role_type (RoleType) Required

  • permissions (string) Repeated Required

  • page_access (string) Repeated Required

  • tags (Struct) Required

  • is_managed (bool) Required

  • state (State) Required

  • domain_id (string) Required

  • created_at (string) Required

  • updated_at (string) Required

{
 "created_at": "2024-11-14T02:44:56.211Z",
 "domain_id": "domain-a1b2c3d4e5f6",
 "name": "Cloudforet User",
 "page_access": [
   "dashboards:restricted.*",
   "project:writable.*",
   "asset_inventory:writable.*",
   "cost_explorer:readonly.*",
   "alert_manager:restricted.*"
 ],
 "role_id": "role-5ce484d4b750",
 "role_type": "WORKSPACE_MEMBER",
 "state": "ENABLED",
 "updated_at": "2024-11-14T02:44:56.211Z"
}

enable #

POST /identity/v2/role/enable

RoleRequest

  • role_id (string) Required
{
 "role_id": "role-a1b2c3d4e5f6"
}

RoleInfo

  • role_id (string) Required

  • name (string) Required

  • role_type (RoleType) Required

  • permissions (string) Repeated Required

  • page_access (string) Repeated Required

  • tags (Struct) Required

  • is_managed (bool) Required

  • state (State) Required

  • domain_id (string) Required

  • created_at (string) Required

  • updated_at (string) Required

{
 "created_at": "2024-11-14T02:44:56.211Z",
 "domain_id": "domain-a1b2c3d4e5f6",
 "name": "Cloudforet User",
 "page_access": [
   "dashboards:restricted.*",
   "project:writable.*",
   "asset_inventory:writable.*",
   "cost_explorer:readonly.*",
   "alert_manager:restricted.*"
 ],
 "role_id": "role-5ce484d4b750",
 "role_type": "WORKSPACE_MEMBER",
 "state": "ENABLED",
 "updated_at": "2024-11-14T02:44:56.211Z"
}

disable #

POST /identity/v2/role/disable

RoleRequest

  • role_id (string) Required
{
 "role_id": "role-a1b2c3d4e5f6"
}

RoleInfo

  • role_id (string) Required

  • name (string) Required

  • role_type (RoleType) Required

  • permissions (string) Repeated Required

  • page_access (string) Repeated Required

  • tags (Struct) Required

  • is_managed (bool) Required

  • state (State) Required

  • domain_id (string) Required

  • created_at (string) Required

  • updated_at (string) Required

{
 "created_at": "2024-11-14T02:44:56.211Z",
 "domain_id": "domain-a1b2c3d4e5f6",
 "name": "Cloudforet User",
 "page_access": [
   "dashboards:restricted.*",
   "project:writable.*",
   "asset_inventory:writable.*",
   "cost_explorer:readonly.*",
   "alert_manager:restricted.*"
 ],
 "role_id": "role-5ce484d4b750",
 "role_type": "WORKSPACE_MEMBER",
 "state": "ENABLED",
 "updated_at": "2024-11-14T02:44:56.211Z"
}

delete #

POST /identity/v2/role/delete

RoleRequest

  • role_id (string) Required
{
 "role_id": "role-a1b2c3d4e5f6"
}

get #

POST /identity/v2/role/get

RoleRequest

  • role_id (string) Required
{
 "role_id": "role-a1b2c3d4e5f6"
}

RoleInfo

  • role_id (string) Required

  • name (string) Required

  • role_type (RoleType) Required

  • permissions (string) Repeated Required

  • page_access (string) Repeated Required

  • tags (Struct) Required

  • is_managed (bool) Required

  • state (State) Required

  • domain_id (string) Required

  • created_at (string) Required

  • updated_at (string) Required

{
 "created_at": "2024-11-14T02:44:56.211Z",
 "domain_id": "domain-a1b2c3d4e5f6",
 "name": "Cloudforet User",
 "page_access": [
   "dashboards:restricted.*",
   "project:writable.*",
   "asset_inventory:writable.*",
   "cost_explorer:readonly.*",
   "alert_manager:restricted.*"
 ],
 "role_id": "role-5ce484d4b750",
 "role_type": "WORKSPACE_MEMBER",
 "state": "ENABLED",
 "updated_at": "2024-11-14T02:44:56.211Z"
}

list #

POST /identity/v2/role/list

RoleSearchQuery

  • query (Query)

  • role_id (string)

  • name (string)

  • role_type (RoleType)

  • state (State)

{
 "state": "ENABLED",
 "query": {
   "page": {
     "start": 1,
     "limit": 10
   },
   "sort": [
     {
       "key": "role_type",
       "desc": true
     }
   ]
 }
}

RolesInfo

  • results (RoleInfo) Repeated Required

  • total_count (int32) Required

{
 "results": [
   {
     "created_at": "2024-11-12T04:46:40.902Z",
     "domain_id": "domain-a1b2c3d4e5f6",
     "is_managed": true,
     "name": "Workspace Owner",
     "role_id": "managed-workspace-owner",
     "role_type": "WORKSPACE_OWNER",
     "state": "ENABLED",
     "updated_at": "2024-11-12T04:46:40.902Z"
   },
   {
     "created_at": "2024-11-14T02:47:08.065Z",
     "domain_id": "domain-a1b2c3d4e5f6",
     "name": "Cloudforet Onwer",
     "page_access": [
       "dashboards:restricted.*",
       "project:writable.*",
       "asset_inventory:writable.*",
       "cost_explorer:readonly.*",
       "alert_manager:restricted.*"
     ],
     "role_id": "role-93a6d387e7ed",
     "role_type": "WORKSPACE_OWNER",
     "state": "ENABLED",
     "updated_at": "2024-11-14T02:47:08.065Z"
   },
   {
     "created_at": "2024-11-12T04:46:40.894Z",
     "domain_id": "domain-a1b2c3d4e5f6",
     "is_managed": true,
     "name": "Workspace Member",
     "role_id": "managed-workspace-member",
     "role_type": "WORKSPACE_MEMBER",
     "state": "ENABLED",
     "updated_at": "2024-11-12T04:46:40.895Z"
   },
   {
     "created_at": "2024-11-14T02:44:56.211Z",
     "domain_id": "domain-a1b2c3d4e5f6",
     "name": "Cloudforet User",
     "page_access": [
       "dashboards:restricted.*",
       "project:writable.*",
       "asset_inventory:writable.*",
       "cost_explorer:readonly.*",
       "alert_manager:restricted.*"
     ],
     "role_id": "role-5ce484d4b750",
     "role_type": "WORKSPACE_MEMBER",
     "state": "ENABLED",
     "updated_at": "2024-11-14T02:44:56.211Z"
   },
   {
     "created_at": "2024-11-14T02:51:23.638Z",
     "domain_id": "domain-a1b2c3d4e5f6",
     "name": "Wonny Project Member",
     "page_access": [
       "dashboards:restricted.*",
       "project:writable.*",
       "asset_inventory:writable.*"
     ],
     "role_id": "role-4b8283a42890",
     "role_type": "WORKSPACE_MEMBER",
     "state": "ENABLED",
     "updated_at": "2024-11-14T02:51:23.638Z"
   },
   {
     "created_at": "2024-11-14T02:51:34.751Z",
     "domain_id": "domain-a1b2c3d4e5f6",
     "name": "SpaceONE Project Member",
     "page_access": [
       "dashboards:restricted.*",
       "project:writable.*",
       "asset_inventory:writable.*"
     ],
     "role_id": "role-3365600e3e0e",
     "role_type": "WORKSPACE_MEMBER",
     "state": "ENABLED",
     "updated_at": "2024-11-14T02:51:34.751Z"
   },
   {
     "created_at": "2024-11-12T04:46:40.885Z",
     "domain_id": "domain-a1b2c3d4e5f6",
     "is_managed": true,
     "name": "Domain Admin",
     "role_id": "managed-domain-admin",
     "role_type": "DOMAIN_ADMIN",
     "state": "ENABLED",
     "updated_at": "2024-11-12T04:46:40.885Z"
   }
 ],
 "total_count": 7
}

list_basic_role #

POST /identity/v2/role/list-basic-role

RoleSearchQuery

  • query (Query)

  • role_id (string)

  • name (string)

  • role_type (RoleType)

  • state (State)

{
 "state": "ENABLED",
 "query": {
   "page": {
     "start": 1,
     "limit": 10
   },
   "sort": [
     {
       "key": "role_type",
       "desc": true
     }
   ]
 }
}

RolesInfo

  • results (RoleInfo) Repeated Required

  • total_count (int32) Required

{
 "results": [
   {
     "created_at": "2024-11-12T04:46:40.902Z",
     "domain_id": "domain-a1b2c3d4e5f6",
     "is_managed": true,
     "name": "Workspace Owner",
     "role_id": "managed-workspace-owner",
     "role_type": "WORKSPACE_OWNER",
     "state": "ENABLED",
     "updated_at": "2024-11-12T04:46:40.902Z"
   },
   {
     "created_at": "2024-11-14T02:47:08.065Z",
     "domain_id": "domain-a1b2c3d4e5f6",
     "name": "Cloudforet Onwer",
     "page_access": [
       "dashboards:restricted.*",
       "project:writable.*",
       "asset_inventory:writable.*",
       "cost_explorer:readonly.*",
       "alert_manager:restricted.*"
     ],
     "role_id": "role-93a6d387e7ed",
     "role_type": "WORKSPACE_OWNER",
     "state": "ENABLED",
     "updated_at": "2024-11-14T02:47:08.065Z"
   },
   {
     "created_at": "2024-11-12T04:46:40.894Z",
     "domain_id": "domain-a1b2c3d4e5f6",
     "is_managed": true,
     "name": "Workspace Member",
     "role_id": "managed-workspace-member",
     "role_type": "WORKSPACE_MEMBER",
     "state": "ENABLED",
     "updated_at": "2024-11-12T04:46:40.895Z"
   },
   {
     "created_at": "2024-11-14T02:44:56.211Z",
     "domain_id": "domain-a1b2c3d4e5f6",
     "name": "Cloudforet User",
     "page_access": [
       "dashboards:restricted.*",
       "project:writable.*",
       "asset_inventory:writable.*",
       "cost_explorer:readonly.*",
       "alert_manager:restricted.*"
     ],
     "role_id": "role-5ce484d4b750",
     "role_type": "WORKSPACE_MEMBER",
     "state": "ENABLED",
     "updated_at": "2024-11-14T02:44:56.211Z"
   },
   {
     "created_at": "2024-11-14T02:51:23.638Z",
     "domain_id": "domain-a1b2c3d4e5f6",
     "name": "Wonny Project Member",
     "page_access": [
       "dashboards:restricted.*",
       "project:writable.*",
       "asset_inventory:writable.*"
     ],
     "role_id": "role-4b8283a42890",
     "role_type": "WORKSPACE_MEMBER",
     "state": "ENABLED",
     "updated_at": "2024-11-14T02:51:23.638Z"
   },
   {
     "created_at": "2024-11-14T02:51:34.751Z",
     "domain_id": "domain-a1b2c3d4e5f6",
     "name": "SpaceONE Project Member",
     "page_access": [
       "dashboards:restricted.*",
       "project:writable.*",
       "asset_inventory:writable.*"
     ],
     "role_id": "role-3365600e3e0e",
     "role_type": "WORKSPACE_MEMBER",
     "state": "ENABLED",
     "updated_at": "2024-11-14T02:51:34.751Z"
   },
   {
     "created_at": "2024-11-12T04:46:40.885Z",
     "domain_id": "domain-a1b2c3d4e5f6",
     "is_managed": true,
     "name": "Domain Admin",
     "role_id": "managed-domain-admin",
     "role_type": "DOMAIN_ADMIN",
     "state": "ENABLED",
     "updated_at": "2024-11-12T04:46:40.885Z"
   }
 ],
 "total_count": 7
}

stat #

POST /identity/v2/role/stat



Message #

CreateRoleRequest #

  • name (string) Required

  • role_type (RoleType) Required

  • permissions (string) Repeated

  • page_access (string) Repeated

  • tags (Struct)


RoleInfo #

  • role_id (string) Required

  • name (string) Required

  • role_type (RoleType) Required

  • permissions (string) Repeated Required

  • page_access (string) Repeated Required

  • tags (Struct) Required

  • is_managed (bool) Required

  • state (State) Required

  • domain_id (string) Required

  • created_at (string) Required

  • updated_at (string) Required


RoleRequest #

  • role_id (string) Required


RoleSearchQuery #

  • query (Query)

  • role_id (string)

  • name (string)

  • role_type (RoleType)

  • state (State)


RoleStatQuery #

  • query (StatisticsQuery) Required


RolesInfo #

  • results (RoleInfo) Repeated Required

  • total_count (int32) Required


UpdateRoleRequest #

  • role_id (string) Required

  • name (string)

  • permissions (ListValue)

  • page_access (ListValue)

  • tags (Struct)


Calendar December 4, 2024
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.