Update a user partially
PATCH /users/{user_id}
Updates the specified user with partial information.
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
user_id |
string |
path |
True |
ID of the user
|
Request Body
Replaces the specified attributes in the request body with the values provided.
Name | Type | Required | Description |
---|---|---|---|
aadId |
string |
False |
User AAD ID |
auth0Id |
string |
False |
User auth0 ID |
description |
string |
False |
JSON string containing the description of the user. Defined values are: * Minimum length: 1 * Maximum length: 300 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. |
id |
string |
False |
Globally unique identifier of the resource. Defined values are:
|
isSystem |
string |
False |
Specifies if an object is system generated. Defined values are:
|
legacyId |
string |
False |
Unique identifier as understood by the Accounts (tenancy) service. |
metadata |
False |
Metadata associated with the resource |
|
name |
string |
False |
User name |
ownerOrganizationId |
string |
False |
JSON string containing the ID of the organization. |
tags |
array[tags] |
False |
JSON array of tags (name/value pairs) representing metadata for the user. |
type |
string |
True |
Media type of the resource. Defined values are:
|
version |
string |
True |
Version of the resource. Defined values are:
|
Example request
{
"description": "Adding user to NetApp Sales Territory",
"id": "666a3f38-d4fa-5b62-a391-a69029758d32",
"name": "user-1",
"tags": [
{
"internal:bxp:organizationId": "777a3f38-d4fa-5b62-a391-a69029758d32"
}
],
"type": "application/vnd.netapp.bxp.user",
"version": "1.0"
}
Response
Status: 204, Indicates if the user was updated.
Error
Status: 400, Bad request
Name | Type | Required | Description |
---|---|---|---|
correlationId |
string |
False |
Internal UUID representing the request or related trace ID |
detail |
string |
False |
Details about the problem |
invalidParams |
array[invalidParams] |
False |
List of invalid parameters |
status |
string |
True |
HTTP error code related to the problem |
title |
string |
True |
Title description of the problem |
type |
string |
True |
Content-type of this object |
Example error response
{
"detail": "The supplied query parameters are invalid.",
"status": "400",
"title": "Invalid query parameters",
"type": "https://bluexp.netapp.io/problems/1"
}
Error
Status: 401, Unauthorized
Name | Type | Required | Description |
---|---|---|---|
correlationId |
string |
False |
Internal UUID representing the request or related trace ID |
detail |
string |
False |
Details about the problem |
invalidParams |
array[invalidParams] |
False |
List of invalid parameters |
status |
string |
True |
HTTP error code related to the problem |
title |
string |
True |
Title description of the problem |
type |
string |
True |
Content-type of this object |
Example error response
{
"detail": "The request is missing the required bearer token.",
"status": "401",
"title": "Missing bearer token",
"type": "https://bluexp.netapp.io/problems/1"
}
Error
Status: 403, Forbidden
Name | Type | Required | Description |
---|---|---|---|
correlationId |
string |
False |
Internal UUID representing the request or related trace ID |
detail |
string |
False |
Details about the problem |
invalidParams |
array[invalidParams] |
False |
List of invalid parameters |
status |
string |
True |
HTTP error code related to the problem |
title |
string |
True |
Title description of the problem |
type |
string |
True |
Content-type of this object |
Example error response
{
"detail": "The requested operation isn't permitted.",
"status": "403",
"title": "Operation not permitted",
"type": "https://bluexp.netapp.io/problems/11"
}
Error
Status: 404, Not found
Name | Type | Required | Description |
---|---|---|---|
correlationId |
string |
False |
Internal UUID representing the request or related trace ID |
detail |
string |
False |
Details about the problem |
invalidParams |
array[invalidParams] |
False |
List of invalid parameters |
status |
string |
True |
HTTP error code related to the problem |
title |
string |
True |
Title description of the problem |
type |
string |
True |
Content-type of this object |
Example error response
{
"detail": "The collection specified in the request URI wasn't found.",
"status": "404",
"title": "Collection not found",
"type": "https://bluexp.netapp.io/problems/2"
}
Error
Status: 409, Conflict
Name | Type | Required | Description |
---|---|---|---|
correlationId |
string |
False |
Internal UUID representing the request or related trace ID |
detail |
string |
False |
Details about the problem |
invalidParams |
array[invalidParams] |
False |
List of invalid parameters |
status |
string |
True |
HTTP error code related to the problem |
title |
string |
True |
Title description of the problem |
type |
string |
True |
Content-type of this object |
Example error response
{
"detail": "The request body JSON contains a field that conflicts with an idempotent value.",
"status": "409",
"title": "JSON resource conflict",
"type": "https://bluexp.netapp.io/problems/10"
}
Definitions
See Definitions
type_bxp_label
Name/value pair
Name | Type | Required | Description |
---|---|---|---|
name |
string |
True |
|
value |
string |
True |
type_bxp_metadata
Metadata associated with the resource
Name | Type | Required | Description |
---|---|---|---|
createdBy |
string |
False |
UUID of the user who created the resource. |
creationTimestamp |
string |
False |
Resource creation date |
labels |
array[type_bxp_label] |
False |
Array of name/value pairs representing additional information for the resource. |
modificationTimestamp |
string |
False |
Resource modification date. |
modifiedBy |
string |
False |
UUID of the user who modified the resource. |
invalidParams
Name | Type | Required | Description |
---|---|---|---|
name |
string |
True |
Name of the invalid parameter |
reason |
string |
True |
Reason why the parameter is invalid |