Skip to content
/Groups

Workspace Groups Management API (1.0.0-beta)

CRUD operations for Workspace Groups Management

Download OpenAPI description
external-groups-v1beta1.json
external-groups-v1beta1.yaml
Overview
License

HPE End User License Agreement

Languages
Servers

https://global.api.greenlake.hpe.com/

Mock server

https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/authorization/public/openapi/groups-v1beta1/external-groups-v1beta1/

Groups

Operations

Create a workspace group

Request

Creates a group for various group types

Security
bearerAuth
Bodyapplication/jsonrequired

Create workspace group object

namestring<= 64 charactersrequired

Name of the group

Example: "Demo Group"
groupTypestringrequired

Type of the group

Value"TenantGroup"
Example: "TenantGroup"
descriptionstring or null<= 256 characters

Description of the group

Example: "Sales admin group"
curl -i -X POST \
  https://global.api.greenlake.hpe.com/workspaces/v1beta1/groups \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Demo Group",
    "groupType": "TenantGroup"
  }'

Responses

Group successfully created

Headers
Locationstring

URL of the created group

Bodyapplication/json
idstring(uuid)read-onlyrequired

HPE GreenLake group ID resource identifier randomly generated by the system

Example: "93313ca9-6a6a-48d3-8f91-da639c0b5173"
typestringread-onlyrequired
Example: "/workspaces/group"
namestringrequired

unique name for the tenant group

Example: "Demo Group"
grnstringrequired
Example: "grn:glp/workspaces/05f0523cfd0347fc981b9c4333a37b60/regions/default/providers/msp/tenant-groups/93313ca9-6a6a-48d3-8f91-da639c0b5173"
groupTypestringrequired

Type of the group

Example: "TenantGroup"
generationinteger(Number of times the resource updated)required

Number of times the resource updated

createdAtstringread-onlyrequired
Example: "2024-01-08 22:59:17.424801 +0000 UTC"
updatedAtstringread-onlyrequired
Example: "2024-01-08 23:00:22.320646 +0000 UTC"
descriptionstring

Description for the tenant group

Example: "Sales admin Group"
Response
application/json
{
  "id": "93313ca9-6a6a-48d3-8f91-da639c0b5173",
  "type": "/workspaces/group",
  "name": "Demo Group",
  "grn": "grn:glp/workspaces/05f0523cfd0347fc981b9c4333a37b60/regions/default/providers/msp/tenant-groups/93313ca9-6a6a-48d3-8f91-da639c0b5173",
  "groupType": "TenantGroup",
  "description": "Sales admin Group",
  "generation": 0,
  "createdAt": "2024-01-08 22:59:17.424801 +0000 UTC",
  "updatedAt": "2024-01-08 23:00:22.320646 +0000 UTC"
}

List of Paginated workspace groups

Request

Get the paginated list of Groups associated to the workspace

Security
bearerAuth
Query
offsetinteger>= 0

The starting offset from which to begin retrieving items

Default 0
limitinteger[ 1 .. 2000 ]

Specifies the number of query results to be returned in a query response page

Default 2000
curl -i -X GET \
  https://global.api.greenlake.hpe.com/workspaces/v1beta1/groups \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Return list of workspace groups

Bodyapplication/json
itemsArray of objects(SCIMGroupWithWorkspaceCountV2)required

list of group objects

items[].​idstring(uuid)read-onlyrequired

HPE GreenLake group ID resource identifier randomly generated by the system

Example: "93313ca9-6a6a-48d3-8f91-da639c0b5173"
items[].​typestringread-onlyrequired
Example: "/workspaces/group"
items[].​namestringrequired

Unique name for the workspace group

Example: "Demo Group"
items[].​grnstringrequired
Example: "grn:glp/workspaces/05f0523cfd0347fc981b9c4333a37b60/regions/default/providers/msp/tenant-groups/93313ca9-6a6a-48d3-8f91-da639c0b5173"
items[].​groupTypestringrequired

Type of the group

Example: "TenantGroup"
items[].​generationinteger(Number of times the resource updated)required

Number of times the resource updated

items[].​createdAtstringread-onlyrequired
Example: "2024-01-08 22:59:17.424801 +0000 UTC"
items[].​updatedAtstringread-onlyrequired
Example: "2024-01-08 23:00:22.320646 +0000 UTC"
items[].​totalWorkspacesinteger(Total workspaces present in the group)required
Default 0
items[].​descriptionstring

Description for the group

Example: "Sales admin Group"
countinteger(Count Per Page)required
Default 200
offsetinteger(Offset)

The page that should use the offset input to retrieve the set of page results

totalinteger(Total Count)
Default 0
Response
application/json
{
  "items": [
    { … }
  ],
  "offset": 0,
  "count": 200,
  "total": 0
}

Add a workspace to the group

Request

Add workspace to a group

Security
bearerAuth
Path
groupIdstring(uuid)required

HPE GreenLake unique group ID

Example: 93313ca9-6a6a-48d3-8f91-da639c0b5173
Bodyapplication/jsonrequired

Add workspace to a group

workspaceIdstring(uuid)required

HPE GreenLake unique workspace ID

Example: "5a4af781011e423ba6bd554dc73ae5a5"
typestring

Type of the resource

Value"/workspaces/workspace"
curl -i -X POST \
  https://global.api.greenlake.hpe.com/workspaces/v1beta1/groups/93313ca9-6a6a-48d3-8f91-da639c0b5173/group-workspaces \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "workspaceId": "5a4af781011e423ba6bd554dc73ae5a5"
  }'

Responses

Workspace added to the group successfully

Headers
Locationstring

URL of the created group

Bodyapplication/json
idstring(uuid)read-onlyrequired

HPE GreenLake unique resource ID for this workspace belonging to the group

Example: "119363f3-4408-44c4-840a-99e1c9db64c1"
typestringread-onlyrequired
Example: "/workspaces/group/group-workspace"
workspaceobject(SCIMWorkspace)required

workspace resource metadata

workspace.​idstringread-onlyrequired

HPE GreenLake global ID unique resource identifier for workspace

Example: "5a4af781011e423ba6bd554dc73ae5a5"
workspace.​typestringread-onlyrequired
Example: "/workspaces/workspace"
workspace.​descriptionstringrequired

Description of the workspace

Example: "US-E Workspace"
workspace.​namestringrequired

name for the workspace

Example: "US-E workspace"
grnstringrequired
Example: "grn:glp/workspaces/05f0523cfd0347fc981b9c4333a37b60/regions/default/providers/msp/tenant-groups/93313ca9-6a6a-48d3-8f91-da639c0b5173"
generationinteger(Number of times the resource updated)required

Number of times the resource updated

createdAtstringread-onlyrequired
Example: "2024-01-08 22:59:17.424801 +0000 UTC"
updatedAtstringread-onlyrequired
Example: "2024-01-08 23:00:22.320646 +0000 UTC"
Response
application/json
{
  "id": "119363f3-4408-44c4-840a-99e1c9db64c1",
  "type": "/workspaces/group/group-workspace",
  "workspace": {
    "id": "5a4af781011e423ba6bd554dc73ae5a5",
    "type": "/workspaces/workspace",
    "description": "US-E Workspace",
    "name": "US-E workspace"
  },
  "grn": "grn:glp/workspaces/05f0523cfd0347fc981b9c4333a37b60/regions/default/providers/msp/tenant-groups/93313ca9-6a6a-48d3-8f91-da639c0b5173",
  "generation": 0,
  "createdAt": "2024-01-08 22:59:17.424801 +0000 UTC",
  "updatedAt": "2024-01-08 23:00:22.320646 +0000 UTC"
}

List of paginated workspaces associated with the group ID

Request

Get the paginated list of workspaces associated with the group ID

Security
bearerAuth
Path
groupIdstring(uuid)required

HPE GreenLake group ID

Example: 93313ca9-6a6a-48d3-8f91-da639c0b5173
Query
limitinteger[ 1 .. 500 ]

Specifies the number of query results to be returned in a query response page

Default 200
offsetinteger>= 0

The starting offset from which to begin retrieving items

Default 0
curl -i -X GET \
  https://global.api.greenlake.hpe.com/workspaces/v1beta1/groups/93313ca9-6a6a-48d3-8f91-da639c0b5173/group-workspaces \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Return list of workspaces associated with this group

Bodyapplication/json
itemsArray of objects(SCIMGroupWorkspace)required

list of member objects

items[].​idstring(uuid)read-onlyrequired

HPE GreenLake unique resource ID for this workspace belonging to the group

Example: "119363f3-4408-44c4-840a-99e1c9db64c1"
items[].​typestringread-onlyrequired
Example: "/workspaces/group/group-workspace"
items[].​workspaceobject(SCIMWorkspace)required

workspace resource metadata

items[].​workspace.​idstringread-onlyrequired

HPE GreenLake global ID unique resource identifier for workspace

Example: "5a4af781011e423ba6bd554dc73ae5a5"
items[].​workspace.​typestringread-onlyrequired
Example: "/workspaces/workspace"
items[].​workspace.​descriptionstringrequired

Description of the workspace

Example: "US-E Workspace"
items[].​workspace.​namestringrequired

name for the workspace

Example: "US-E workspace"
items[].​grnstringrequired
Example: "grn:glp/workspaces/05f0523cfd0347fc981b9c4333a37b60/regions/default/providers/msp/tenant-groups/93313ca9-6a6a-48d3-8f91-da639c0b5173"
items[].​generationinteger(Number of times the resource updated)required

Number of times the resource updated

items[].​createdAtstringread-onlyrequired
Example: "2024-01-08 22:59:17.424801 +0000 UTC"
items[].​updatedAtstringread-onlyrequired
Example: "2024-01-08 23:00:22.320646 +0000 UTC"
countinteger(Count Per Page)required
Default 200
totalinteger(Total Count)required
Default 0
offsetinteger(Offset)

The starting offset from which to begin retrieving items

Response
application/json
{
  "items": [
    { … }
  ],
  "offset": 0,
  "count": 200,
  "total": 0
}

Get the workspace details

Request

Get the workspace details by group ID

Security
bearerAuth
Path
groupIdstring(uuid)required

HPE GreenLake unique group ID

Example: 93313ca9-6a6a-48d3-8f91-da639c0b5173
groupWorkspaceIdstring(uuid)required

HPE GreenLake unique resource ID for this workspace belonging to the group

Example: 119363f3-4408-44c4-840a-99e1c9db64c1
curl -i -X GET \
  https://global.api.greenlake.hpe.com/workspaces/v1beta1/groups/93313ca9-6a6a-48d3-8f91-da639c0b5173/group-workspaces/119363f3-4408-44c4-840a-99e1c9db64c1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Return Group

Bodyapplication/json
idstring(uuid)read-onlyrequired

HPE GreenLake unique resource ID for this workspace belonging to the group

Example: "119363f3-4408-44c4-840a-99e1c9db64c1"
typestringread-onlyrequired
Example: "/workspaces/group/group-workspace"
workspaceobject(SCIMWorkspace)required

workspace resource metadata

workspace.​idstringread-onlyrequired

HPE GreenLake global ID unique resource identifier for workspace

Example: "5a4af781011e423ba6bd554dc73ae5a5"
workspace.​typestringread-onlyrequired
Example: "/workspaces/workspace"
workspace.​descriptionstringrequired

Description of the workspace

Example: "US-E Workspace"
workspace.​namestringrequired

name for the workspace

Example: "US-E workspace"
grnstringrequired
Example: "grn:glp/workspaces/05f0523cfd0347fc981b9c4333a37b60/regions/default/providers/msp/tenant-groups/93313ca9-6a6a-48d3-8f91-da639c0b5173"
generationinteger(Number of times the resource updated)required

Number of times the resource updated

createdAtstringread-onlyrequired
Example: "2024-01-08 22:59:17.424801 +0000 UTC"
updatedAtstringread-onlyrequired
Example: "2024-01-08 23:00:22.320646 +0000 UTC"
Response
application/json
{
  "id": "119363f3-4408-44c4-840a-99e1c9db64c1",
  "type": "/workspaces/group/group-workspace",
  "workspace": {
    "id": "5a4af781011e423ba6bd554dc73ae5a5",
    "type": "/workspaces/workspace",
    "description": "US-E Workspace",
    "name": "US-E workspace"
  },
  "grn": "grn:glp/workspaces/05f0523cfd0347fc981b9c4333a37b60/regions/default/providers/msp/tenant-groups/93313ca9-6a6a-48d3-8f91-da639c0b5173",
  "generation": 0,
  "createdAt": "2024-01-08 22:59:17.424801 +0000 UTC",
  "updatedAt": "2024-01-08 23:00:22.320646 +0000 UTC"
}

Remove a workspace from the workspace group

Request

Remove workspace from a group

Security
bearerAuth
Path
groupIdstring(uuid)required

HPE GreenLake unique group ID

Example: 93313ca9-6a6a-48d3-8f91-da639c0b5173
groupWorkspaceIdstring(uuid)required

HPE GreenLake unique resource ID for this workspace belonging to the group

Example: 119363f3-4408-44c4-840a-99e1c9db64c1
curl -i -X DELETE \
  https://global.api.greenlake.hpe.com/workspaces/v1beta1/groups/93313ca9-6a6a-48d3-8f91-da639c0b5173/group-workspaces/119363f3-4408-44c4-840a-99e1c9db64c1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Delete operation from the group performed successfully

Response
No content

Get the workspace group details

Request

Get the workspace group details by group ID

Security
bearerAuth
Path
groupIdstring(uuid)required

HPE GreenLake unique group ID

Example: 93313ca9-6a6a-48d3-8f91-da639c0b5173
curl -i -X GET \
  https://global.api.greenlake.hpe.com/workspaces/v1beta1/groups/93313ca9-6a6a-48d3-8f91-da639c0b5173 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Return Group

Bodyapplication/json
idstring(uuid)read-onlyrequired

HPE GreenLake group ID resource identifier randomly generated by the system

Example: "93313ca9-6a6a-48d3-8f91-da639c0b5173"
typestringread-onlyrequired
Example: "/workspaces/group"
namestringrequired

unique name for the tenant group

Example: "Demo Group"
grnstringrequired
Example: "grn:glp/workspaces/05f0523cfd0347fc981b9c4333a37b60/regions/default/providers/msp/tenant-groups/93313ca9-6a6a-48d3-8f91-da639c0b5173"
groupTypestringrequired

Type of the group

Example: "TenantGroup"
generationinteger(Number of times the resource updated)required

Number of times the resource updated

createdAtstringread-onlyrequired
Example: "2024-01-08 22:59:17.424801 +0000 UTC"
updatedAtstringread-onlyrequired
Example: "2024-01-08 23:00:22.320646 +0000 UTC"
descriptionstring

Description for the tenant group

Example: "Sales admin Group"
Response
application/json
{
  "id": "93313ca9-6a6a-48d3-8f91-da639c0b5173",
  "type": "/workspaces/group",
  "name": "Demo Group",
  "grn": "grn:glp/workspaces/05f0523cfd0347fc981b9c4333a37b60/regions/default/providers/msp/tenant-groups/93313ca9-6a6a-48d3-8f91-da639c0b5173",
  "groupType": "TenantGroup",
  "description": "Sales admin Group",
  "generation": 0,
  "createdAt": "2024-01-08 22:59:17.424801 +0000 UTC",
  "updatedAt": "2024-01-08 23:00:22.320646 +0000 UTC"
}

Update workspace group details

Request

Updates group details name and description

Security
bearerAuth
Path
groupIdstring(uuid)required

HPE GreenLake unique group ID

Example: 93313ca9-6a6a-48d3-8f91-da639c0b5173
Bodyapplication/jsonrequired

Update Group object

namestring<= 64 charactersrequired

Name of the group

Example: "Demo Group"
descriptionstring or null<= 256 characters

Description of the group

Example: "Sales admin group"
curl -i -X PUT \
  https://global.api.greenlake.hpe.com/workspaces/v1beta1/groups/93313ca9-6a6a-48d3-8f91-da639c0b5173 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Demo Group"
  }'

Responses

Group sucessfully updated

Headers
Locationstring

URL of the created group

Bodyapplication/json
idstring(uuid)read-onlyrequired

HPE GreenLake group ID resource identifier randomly generated by the system

Example: "93313ca9-6a6a-48d3-8f91-da639c0b5173"
typestringread-onlyrequired
Example: "/workspaces/group"
namestringrequired

unique name for the tenant group

Example: "Demo Group"
grnstringrequired
Example: "grn:glp/workspaces/05f0523cfd0347fc981b9c4333a37b60/regions/default/providers/msp/tenant-groups/93313ca9-6a6a-48d3-8f91-da639c0b5173"
groupTypestringrequired

Type of the group

Example: "TenantGroup"
generationinteger(Number of times the resource updated)required

Number of times the resource updated

createdAtstringread-onlyrequired
Example: "2024-01-08 22:59:17.424801 +0000 UTC"
updatedAtstringread-onlyrequired
Example: "2024-01-08 23:00:22.320646 +0000 UTC"
descriptionstring

Description for the tenant group

Example: "Sales admin Group"
Response
application/json
{
  "id": "93313ca9-6a6a-48d3-8f91-da639c0b5173",
  "type": "/workspaces/group",
  "name": "Demo Group",
  "grn": "grn:glp/workspaces/05f0523cfd0347fc981b9c4333a37b60/regions/default/providers/msp/tenant-groups/93313ca9-6a6a-48d3-8f91-da639c0b5173",
  "groupType": "TenantGroup",
  "description": "Sales admin Group",
  "generation": 0,
  "createdAt": "2024-01-08 22:59:17.424801 +0000 UTC",
  "updatedAt": "2024-01-08 23:00:22.320646 +0000 UTC"
}

Delete the workspace group

Request

Delete the existing workspace group from the account

Security
bearerAuth
Path
groupIdstring(uuid)required

HPE GreenLake group ID

Example: 93313ca9-6a6a-48d3-8f91-da639c0b5173
curl -i -X DELETE \
  https://global.api.greenlake.hpe.com/workspaces/v1beta1/groups/93313ca9-6a6a-48d3-8f91-da639c0b5173 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Group deleted successfully

Response
No content