Patch Users

PATCH 
/users/:identityName

This operation allows to update a User

Request

Path Parameters

identityName stringrequired

identity name

application/json

Body

user to patch

identityName string

user identity name

displayName string

user displayed name

organizations

object[]

list of organization roles associated to a user

Array [

organizationId uuidrequired

Possible values: Value must match regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

organization UUID associated to user

roleId uuidrequired

Possible values: Value must match regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

role UUID associated to user

]

email string

user email

firstName string

user first name

lastName string

user last name

Responses

200

ok

application/json

Schema

Schema

identityName stringrequired

Possible values: Value must match regular expression \S

user identity name

displayName stringrequired

Possible values: Value must match regular expression \S

user displayed name

organizations

object[]

required

Possible values: >= 1

list of organization roles associated to a user

Array [

organizationId uuidrequired

Possible values: Value must match regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

organization UUID associated to user

roleId uuidrequired

Possible values: Value must match regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

role UUID associated to user

]

email stringrequired

Possible values: Value must match regular expression \S

user email

firstName stringrequired

Possible values: Value must match regular expression \S

user first name

lastName stringrequired

Possible values: Value must match regular expression \S

user last name

Example (from schema)

{
  "identityName": "string",
  "displayName": "string",
  "organizations": [
    {
      "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "roleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "email": "string",
  "firstName": "string",
  "lastName": "string"
}

400

bad request

application/json

Schema

Schema

code int32

bad request code

message string

bad request message

status int32

bad request status

title string

bad request title

violations

object[]

bad request violations

Array [

field string

violated field name

message string

error message

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "status": 0,
  "title": "string",
  "violations": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

401

unauthorized access

application/json

Schema

Schema

code int32

error code

message string

error message

description string

error description

Example (from schema)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

403

forbidden access

application/json

Schema

Schema

code int32

error code

message string

error message

description string

error description

Example (from schema)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

404

not found

application/json

Schema

Schema

code int32

error code

message string

error message

description string

error description

Example (from schema)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

500

internal error

application/json

Schema

Schema

code int32

error code

message string

error message

description string

error description

Example (from schema)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

Loading...