Patch Users

PATCH 
https://api.orange.com/evolutionplatform/referentiel/api/v1//users/:identityName

This operation allows to update a User

Request

Path Parameters

identityName stringrequired

identity name

application/json

Body

user to patch

identityNamestring

user identity name

displayNamestring

user displayed name

organizations object[]

list of organization roles associated to a user

Array [

organizationIduuidrequired

organization UUID associated to user

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}

roleIduuidrequired

role UUID associated to user

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}

]

emailstring

user email

firstNamestring

user first name

lastNamestring

user last name

Responses

200

ok

application/json

Schema

Schema

identityNamestringrequired

user identity name

Possible values: Value must match regular expression \S

displayNamestringrequired

user displayed name

Possible values: Value must match regular expression \S

organizations object[]required

list of organization roles associated to a user

Possible values: >= 1

Array [

organizationIduuidrequired

organization UUID associated to user

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}

roleIduuidrequired

role UUID associated to user

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}

]

emailstringrequired

user email

Possible values: Value must match regular expression \S

firstNamestringrequired

user first name

Possible values: Value must match regular expression \S

lastNamestringrequired

user last name

Possible values: Value must match regular expression \S

Example (auto)

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

codeint32
bad request code
messagestring
bad request message
statusint32
bad request status
titlestring
bad request title
violations object[]
bad request violations
Array [
fieldstring
violated field name
messagestring
error message
]

Example (auto)

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

401

unauthorized access

application/json

Schema

Schema

codeint32

error code

messagestring

error message

descriptionstring

error description

Example (auto)

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

403

forbidden access

application/json

Schema

Schema

codeint32

error code

messagestring

error message

descriptionstring

error description

Example (auto)

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

404

not found

application/json

Schema

Schema

codeint32

error code

messagestring

error message

descriptionstring

error description

Example (auto)

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

500

internal error

application/json

Schema

Schema

codeint32

error code

messagestring

error message

descriptionstring

error description

Example (auto)

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

Authorization: oauth2

name: oauth2clientcredentialstype: oauth2flows: {
  "clientCredentials": {
    "tokenUrl": "https://api.orange.com/oauth/v3/token",
    "scopes": {}
  }
}

• curl
• python
• go
• nodejs
• php
• java

• CURL

curl -L -X PATCH 'https://api.orange.com/evolutionplatform/referentiel/api/v1//users/:identityName' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>' \
-d '{
  "identityName": "string",
  "displayName": "string",
  "organizations": [
    {
      "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "roleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "email": "string",
  "firstName": "string",
  "lastName": "string"
}'

Request Collapse all

Base URL

https://api.orange.com/evolutionplatform/referentiel/api/v1/

Auth

Security Scheme

oauth2clientcredentialsapi_key

Bearer Token

Parameters

identityName — pathrequired

Body

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