Get users

HPE GreenLake for User Management API (1.0.0)

With the HPE GreenLake for Identity Management APIs you can view, update preferences, and remove users from your workspace.

Download OpenAPI description

index.json

index.yaml

Overview

License

HPE License

Servers

Mock server

https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/identity/public/openapi/identity-v1/

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

User Management

User management operations specific to HPE GreenLake.

Operations

Get users

Request

Retrieve list of users with filtering, and pagination options. All users are returned when no filters are provided. Note: User view all permission is required to invoke this API. Rate limit: 300 requests per minute per workspace, resulting in a 429 error if exceeded.

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.

Supported classes and examples include:

Types: timestamp, string
Comparison: eq, ne, gt, ge, lt
Logical Expressions: and, or, not

The Get users API can be filtered by:

id
username
userStatus
createdAt
updatedAt
lastLogin

userStatus can be one of the following:

UNVERIFIED
VERIFIED
BLOCKED
DELETE_IN_PROGRESS
DELETED
SUSPENDED

Note: The userStatus filter is case-sensitive.

Default ""

Examples:

Filter with id

Returns the user with a specific ID.

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

Filter with username

Returns the user with a specific username.

filter=username eq 'user@example.com'

Filter with userStatus

Returns users that are not unverified.

filter=userStatus ne 'UNVERIFIED'

Filter with createdAt

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

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

Filter with updatedAt

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

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

Filter with lastLogin

Returns users that logged in before 2020-09-21T14:19:09.769747

filter=lastLogin lt '2020-09-21T14:19:09.769747'

Filter with email

Returns the user with a specific email.

filter=username eq 'user@example.com'

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 .. 600 ]

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

Default 300

curl -i -X GET \
  https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/identity/public/openapi/identity-v1/identity/v1/users \
  -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 Users)required

List of users

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

Resource unique identification

items[].typestring(Type of data)required

Type of data

items[].usernamestring(email)(Email Address)required

User's Email Address

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[].userStatusany(User Status)

On-Boarding Status of a user

Enum"UNVERIFIED""VERIFIED""BLOCKED"

items[].lastLoginstring(date-time)(User Last Login time)

Time when this user had last logged in.

items[].resourceUristring(Resource Uri)

Full path of the resource

Response

application/json

{
  "offset": 0,
  "count": 0,
  "total": 0,
  "items": [
    { … }
  ]
}

Invite a user

Request

Invite a user to a workspace.

Security

BearerAuth or BearerAuth

Bodyapplication/json

emailstring(Email)

Email address of the invited user.

sendWelcomeEmailboolean(Send welcome e-mail.)

If enabled, a welcome email is sent to the invited user.

Default true

curl -i -X POST \
  https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/identity/public/openapi/identity-v1/identity/v1/users \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Successful Response

Headers

Locationstring(Location)

Endpoint to get the invited user resource

Bodyapplication/json

messagestring(Message)required

Message

Response

application/json

{
  "message": "string"
}

Get a user

Request

Retrieve a single user based on a given user ID.

Security

BearerAuth

Path

idstring(uuid)(User ID)required

The unique identifier of the user.

Example: 7600415a-8876-5722-9f3c-b0fd11112283

curl -i -X GET \
  https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/identity/public/openapi/identity-v1/identity/v1/users/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

usernamestring(email)(Email Address)required

User's Email Address

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.

userStatusany(User Status)

On-Boarding Status of a user

Enum"UNVERIFIED""VERIFIED""BLOCKED"

lastLoginstring(date-time)(User Last Login time)

Time when this user had last logged in.

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",
  "username": "user@example.com",
  "userStatus": "UNVERIFIED",
  "lastLogin": "2019-08-24T14:15:22Z",
  "resourceUri": "string"
}

Update a user

Request

Update an existing user's preferences.

Security

BearerAuth

Path

idstring(uuid)(User ID)required

The unique identifier of the user to be updated.

Example: 7600415a-8876-5722-9f3c-b0fd11112283

Bodyapplication/jsonrequired

languageany(Language)

The preferred language of the user.

Default "en"

Enum"en""de""es"

idleTimeoutinteger(Idle timeout)

The user's session idle timeout in seconds.

Default 1800

curl -i -X PUT \
  https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/identity/public/openapi/identity-v1/identity/v1/users/7600415a-8876-5722-9f3c-b0fd11112283 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Successful Response

Bodyapplication/json

messagestring(Message)required

Message

Response

application/json

{
  "message": "string"
}

Disassociate a user

Request

Delete a user from a workspace.

Security

BearerAuth

Path

idstring(uuid)(User ID)required

The unique identifier of the user to be deleted.

Example: 7600415a-8876-5722-9f3c-b0fd11112283

curl -i -X DELETE \
  https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/identity/public/openapi/identity-v1/identity/v1/users/7600415a-8876-5722-9f3c-b0fd11112283 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Response

No content

HPE GreenLake for User Management API (1.0.0)

User Management

Get users

Request

Responses

Was this helpful?

Invite a user

Request

Responses

Was this helpful?

Get a user

Request

Responses

Was this helpful?

Update a user

Request

Responses

Was this helpful?

Disassociate a user

Request

Responses

Was this helpful?