Update User

Update User
Update a user

Update a user's metadata.

Request
URI
PATCH
https://api.example.local/v3/users/{guid}
COPY
Path Parameters
string
guid
Required

The unique identifier for the user, matching either a UAA user id or client id. A client id may not be a uuid.

Request Body

User to update

UserUpdate of type(s) application/json
Optional 
{
    "username": "string",
    "presentation_name": "string",
    "origin": "string",
    "metadata": {
        "labels": {
            "labels": "string"
        },
        "annotations": {
            "annotations": "string"
        }
    },
    "links": {
        "self": {
            "href": "string",
            "method": "string"
        }
    }
}
Authentication
This operation uses the following authentication methods.
Responses
200

User updated

Returns UserUpdateResponse of type(s) application/json 
{
    "guid": "string",
    "created_at": "string",
    "updated_at": "string",
    "username": "string",
    "presentation_name": "string",
    "origin": "string",
    "metadata": {
        "labels": {
            "labels": "string"
        },
        "annotations": {
            "annotations": "string"
        }
    },
    "links": {
        "self": {
            "href": "string",
            "method": "string"
        }
    }
}
string
guid
Optional

Unique identifier for the user, matching either a UAA user id or client id. A client id may not be a uuid.

string As date-time As date-time
created_at
Optional

The ISO8601 compatible date and time when resource was created

string As date-time As date-time
updated_at
Optional

The ISO8601 compatible date and time when resource was last updated

string
username
Optional

The username of the user

string
presentation_name
Optional

The presentation name of the user

string
origin
Optional

The origin of the user

object
metadata
Optional

Metadata is a JSON object that contains information about a resource. It includes the GUID of the resource, the time the resource was created, the time the resource was last updated, and links to the resource. Metadata is included in the response body of a request to retrieve a resource.

object
links
Optional

links


400

Bad Request

Returns BadRequest of type(s) application/json 
{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}
array of object
errors
Optional

errors


401

Unauthorized

Returns Unauthorized of type(s) application/json 
{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}
array of object
errors
Optional

errors


403

Forbidden

Returns Forbidden of type(s) application/json 
{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}
array of object
errors
Optional

errors


404

Not Found

Returns NotFound of type(s) application/json 
{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}
array of object
errors
Optional

errors


409

Conflict

Returns Conflict of type(s) application/json 
{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}
array of object
errors
Optional

errors


422

Unprocessable Entity

Returns UnprocessableEntity of type(s) application/json 
{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}
array of object
errors
Optional

errors


500

Internal Server Error

Returns 500 of type(s) application/json 
{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}
array of object
errors
Optional

errors


503

Service Unavailable

Returns ServiceUnavailable of type(s) application/json 
{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}
array of object
errors
Optional

errors


Code Samples
COPY
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}'
On This Page
Users Operations
GET
List Users
POST
Create User
GET
Get User
PATCH
Update User
DELETE
Delete User