reserved instance

Get a list of users for an instance - curl

Get a list of users for an instance.

GET /v1/{service_instance_guid}/users

Request

Custom Headers  
Accept-Language
string

The acceptable list of languages supported in the client.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression [a-zA-Z0-9\-;,\s.]*

Example: en-US,en;q=0.5
Path Parameters  
service_instance_guid
Required*
string

The GUID that uniquely identifies the IBM® MQ as a Service instance.

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Example: a2b4d4bc-dadb-4637-bcec-9b7d1e723af8
Query parameters  
offset
integer
 Pagination offset.

Possible values: 0 ≤ value ≤ 99999

Default: 0
limit
integer

The numbers of resources to return.

Possible values: 0 ≤ value ≤ 100

Default: 25

Example request

curl -X GET --location --header "Authorization: Bearer ${iam_token}" --header "Accept: application/json" "${base_url}/v1/${service_instance_guid}/users"

Response

Response Body
UserDetailsCollection

A list of user summaries
offset
Always included*
integer
 Pagination offset.
limit
Always included*
integer

Results per page, same for all collections.

Possible values: value ≤ 50
first
Always included*
 Link to first page of results.
 
  • href
    string

    The URL of the page the link goes to.
users
Always included*

List of users.

Possible values: 0 ≤ number of items ≤ 50
 
  • id
    Always included*
    string

    The ID of the user which was allocated on creation, and can be used for delete calls.

  • name
    Always included*
    string

    The shortname of the user that will be used as the IBM MQ administrator in interactions with a queue manager for this service instance.

    Possible values: 1 ≤ length ≤ 12, Value must match regular expression ^[a-z][-a-z0-9]*$

  • email
    Always included*
    string

    The email of the user.

    Possible values: 5 ≤ length ≤ 253

  • iam_service_id
    Always included*
    string

    The IAM ID of the user

    Possible values: 5 ≤ length ≤ 50

  • roles
    Always included*
    string[]

    A list of roles the user has

    Possible values: 0 ≤ number of items ≤ 200

  • iam_managed
    Always included*
    boolean

    Indicates whether the user is managed by IAM

  • href
    Always included*
    string

    The URL for the user details.
next
Always included*
 Link to next page of results.
previous
Always included*
 Link to previous page of results.
Status code  
200 Summary of the returned users
301 URI has permanently Moved
400 Bad Request
401 Unauthorized
404 Resource not found
429 Service Is Overused
500 Internal Server Error

Example response

Success 200

{
  "offset": 25,
  "limit": 25,
  "first": {
    "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/users?limit=25"
  },
  "next": {
    "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/users?offset=50&limit=25"
  },
  "previous": {
    "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/users?offset=25&limit=25"
  },
  "users": [
    {
      "id": "31a413dd84346effc8895b6ba4641641",
      "name": "testuser",
      "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/users/31a413dd84346effc8895b6ba4641641",
      "email": "testuser@ibm.com",
      "iam_service_id": "IBMid-2700640RCGN",
      "iam_managed": true,
      "roles": [
        "writer"
      ]
    }
  ]
}