Skip to content
Internal API Catalog
/
HPE GreenLake for Workspace Management API
/
Workspace Management

HPE GreenLake for Workspace Management API (1.0.0)

With the HPE GreenLake for Workspace Management APIs you can view workspace information and create, update, or delete managed service provider tenants.

Download OpenAPI description
index.json
index.yaml
Overview
License

HPE License

Languages
Servers
Mock server

https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/workspace/public/openapi/workspace-management-v1/

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

Workspace Management

Workspace management operations for HPE GreenLake.

Operations

Get workspace information

Request

Retrieve basic workspace information for a provided workspace identifier.

Security
BearerAuth
Path
workspaceIdstring(uuid)(Workspace ID)required

The unique identifier of the workspace.

Example: 7600415a-8876-5722-9f3c-b0fd11112283
curl -i -X GET \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/workspace/public/openapi/workspace-management-v1/workspaces/v1/workspaces/7600415a-8876-5722-9f3c-b0fd11112283 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
idstring(uuid)(Resource unique ID)required

Resource unique identification

typestring(Type of data)required

Type of data

workspaceNamestring(Company name)required

Company name of the workspace.

generationinteger(Generation)

Resource history of updates

Default 0
createdAtstring(date-time)(Resource created time)

The time the resource was created.

updatedAtstring(date-time)(Resource update time)

The time the resource was last updated.

createdBystring(email)(User email)

Email address of the user that created the account.

resourceUristring(Resource Uri)

Full path of the resource

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "string",
  "generation": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "workspaceName": "string",
  "createdBy": "user@example.com",
  "resourceUri": "string"
}

Get detailed workspace information

Request

Retrieve detailed workspace information.

Security
BearerAuth
Path
workspaceIdstring(uuid)(Workspace ID)required

The unique identifier of the workspace.

Example: 7600415a-8876-5722-9f3c-b0fd11112283
curl -i -X GET \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/workspace/public/openapi/workspace-management-v1/workspaces/v1/workspaces/7600415a-8876-5722-9f3c-b0fd11112283/contact \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
addressobject(Address)

Company address.

phoneNumberstring(Phone number)

The phone number associated with this workspace.

emailstring(email)(Workspace Email)

The primary email address associated with the workspace.

resourceUristring(Resource Uri)

Full path of the resource

Response
application/json
{
  "address": {
    "streetAddress": "string",
    "streetAddressComplement": "string",
    "city": "string",
    "stateOrRegion": "string",
    "zip": "string",
    "countryCode": "string"
  },
  "phoneNumber": "string",
  "email": "user@example.com",
  "resourceUri": "string"
}

Get list of MSP Tenants

Request

Retrieve a list of managed service provider (MSP) tenants.

Security
BearerAuth
Query
filterstring(Filter)

Filter data using a subset of OData 4.0 and return only the subset of resources that match the filter.

Get list of MSP Tenants API can be filtered by:

  • id
  • createdAt
  • updatedAt
  • workspaceName
  • createdBy
  • inventoryOwnership
Default ""
Examples:

Returns a tenant with a specific ID.

filter=id eq '7600415a-8876-5722-9f3c-b0fd11112283'

Returns tenants created after 2020-09-21T14:19:09.769747

filter=createdAt gt '2020-09-21T14:19:09.769747'

Returns tenants updated after 2020-09-21T14:19:09.769747

filter=updatedAt gt '2020-09-21T14:19:09.769747'

Returns the tenant with the specified workspace name.

filter=workspaceName eq 'workspace example'

Returns the tenants created by the specified user

filter=createdBy eq 'user@example.com'

Returns the tenants with the specified inventoryOwnership

filter=inventoryOwnership eq 'MSP_OWNED_INVENTORY'
offsetinteger(Pagination offset)>= 0

Specify pagination offset. An offset argument defines how many pages to skip before returning results.

Default 0
limitinteger(Pagination limit)[ 1 .. 300 ]

Specify the maximum number of entries per page. NOTE: The maximum value accepted is 300.

Default 300
curl -i -X GET \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/workspace/public/openapi/workspace-management-v1/workspaces/v1/msp-tenants \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
offsetinteger(Offset)required

Specifies the offset of the returned page

countinteger(Count)required

The number of returned items

totalinteger(Total)required

The total number of items in the result set

itemsArray of objects(List of Workspaces)required

List of Workspaces

items[].​idstring(uuid)(Resource unique ID)required

Resource unique identification

items[].​typestring(Type of data)required

Type of data

items[].​workspaceNamestring(Company name)required

Company name of the workspace.

items[].​generationinteger(Generation)

Resource history of updates

Default 0
items[].​createdAtstring(date-time)(Resource created time)

The time the resource was created.

items[].​updatedAtstring(date-time)(Resource update time)

The time the resource was last updated.

items[].​createdBystring(email)(User email)

Email address of the user that created the account.

items[].​resourceUristring(Resource Uri)

Full path of the resource

items[].​inventoryOwnershipstring(Devices and Subscriptions Ownership)

Devices and Subscriptions Ownership for this tenant.

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

Create MSP customer workspace

Request

Create an MSP customer workspace.

Security
BearerAuth
Bodyapplication/jsonrequired
workspaceNamestring(Tenant workspace Name)required

Name of the tenant.

addressobject(Address)

Company Address.

phoneNumberstring(Phone number)

The phone number associated with this workspace.

emailstring(email)(Workspace Email)

The primary email address associated with the workspace.

resourceUristring(Resource Uri)

Full path of the resource

descriptionstring(Tenant Description)

A description of the tenant.

inventoryOwnershipstring(Devices and Subscriptions Ownership)

Devices and Subscriptions Ownership for this tenant. If not specified, the tenant is created with the default value of "MSP_OWNED_INVENTORY".

Enum"MSP_OWNED_INVENTORY""CUSTOMER_OWNED_INVENTORY"
curl -i -X POST \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/workspace/public/openapi/workspace-management-v1/workspaces/v1/msp-tenants \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "workspaceName": "string"
  }'

Responses

Successful Response

Headers
Locationstring(Location)

Endpoint to get the invited user resource

Bodyapplication/json
messagestring(Message)required

Message

Response
application/json
{
  "message": "string"
}

Update managed service tenant

Request

Update an existing tenant in the currently logged in managed service provider (MSP) workspace.

Security
BearerAuth
Path
tenantIdstring(uuid)(Tenant ID)required

The unique ID of the tenant.

Bodyapplication/jsonrequired
workspaceNamestring(Tenant workspace Name)required

Name of the tenant.

addressobject(Address)

Company Address.

phoneNumberstring(Phone number)

The phone number associated with this workspace.

emailstring(email)(Workspace Email)

The primary email address associated with the workspace.

resourceUristring(Resource Uri)

Full path of the resource

descriptionstring(Tenant Description)

A description of the tenant.

inventoryOwnershipstring(Devices and Subscriptions Ownership)

Devices and Subscriptions Ownership for this tenant. If not specified, the tenant is created with the default value of "MSP_OWNED_INVENTORY".

Enum"MSP_OWNED_INVENTORY""CUSTOMER_OWNED_INVENTORY"
curl -i -X PUT \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/workspace/public/openapi/workspace-management-v1/workspaces/v1/msp-tenants/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "workspaceName": "string"
  }'

Responses

Successful Response

Bodyapplication/json
messagestring(Message)required

Message

Response
application/json
{
  "message": "string"
}

Delete a managed service tenant

Request

Delete a tenant in the currently logged in managed service provider's (MSP) workspace.

Security
BearerAuth
Path
tenantIdstring(uuid)(Tenant ID)required

The workspace ID for the tenant you want to delete.

curl -i -X DELETE \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/workspace/public/openapi/workspace-management-v1/workspaces/v1/msp-tenants/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Response
No content