reserved instance

Update the name for a user - curl

Update the name assigned to an IBM® MQ as a Service user.

PATCH /v1/{service_instance_guid}/users/{user_id}

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
user_id
Required*
string

The id of the user.

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

Example: 31a413dd84346effc8895b6ba4641641
Request Body
Required*
UpdateUserBody
 User to add to the list
name
Required*
string

The new name to update the user with

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

Example request

curl -X PATCH --location --header "Authorization: Bearer ${iam_token}" --header "Accept: application/json" --header "Content-Type: application/json" --data '{ "name": "testString" }' "${base_url}/v1/${service_instance_guid}/users/${user_id}"

Response

Response Body
UserDetails

A summary of the user for use in a list of users
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.
Status code  
200 User name was updated successfully
400 Bad Request
401 Unauthorized
404 Resource not found
429 Service Is Overused
500 Internal Server Error

Response example

Status 200

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