reserved instanceIBM Cloud

Get a list of users for an instance - go

Get a list of users for an instance.

(mqcloud *MqcloudV1) ListUsers(listUsersOptions *ListUsersOptions) (result *UserDetailsCollection, response *core.DetailedResponse, err error)
(mqcloud *MqcloudV1) ListUsersWithContext(ctx context.Context, listUsersOptions *ListUsersOptions) (result *UserDetailsCollection, response *core.DetailedResponse, err error)

Request

Instantiate the ListUsersOptions struct and set the fields to provide parameter values for the ListUsers method.

parameter WithContext method only
ctx
Context
 A context.Context instance that you can use to specify a timeout for the operation or to cancel an in-flight request.
ListQueueManagersOptions The ListQueueManagers options
ServiceInstanceGuid
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
offset
int64
 Pagination offset.

Possible values: 0 ≤ value ≤ 99999

Default: 0
limit
int64

The numbers of resources to return.

Possible values: 0 ≤ value ≤ 100

Default: 25

Example: 10

Example request

listUsersOptions := &mqcloudv1.ListUsersOptions{
  ServiceInstanceGuid: core.StringPtr("a2b4d4bc-dadb-4637-bcec-9b7d1e723af8"),
  Limit: core.Int64Ptr(int64(10)),
}

pager, err := mqcloudService.NewUsersPager(listUsersOptions)
if err != nil {
  panic(err)
}

var allResults []mqcloudv1.UserDetails
for pager.HasNext() {
  nextPage, err := pager.GetNext()
  if err != nil {
    panic(err)
  }
  allResults = append(allResults, nextPage...)
}
b, _ := json.MarshalIndent(allResults, "", "  ")
fmt.Println(string(b))

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.
Next
Always included*
 Link to next page of results.
 
  • Href
    string

    The URL of the page the link goes to.
Previous
Always included*
 Link to previous 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

  • IamServiceID
    Always included*
    string

    The IAM ID of the user

    Possible values: 5 ≤ length ≤ 50

  • Href
    Always included*
    string

    The URL for the user details.
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 example

{
  "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"
      ]
    }
  ]
}