get Users

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

This operation allows to get page of User

Request

Query Parameters

limit int32
Limit of the page
Default value: 20
offset int32
Offset of the page
Default value: 0

Responses

200

ok

Response Headers

X-Total-Count

total count of users

X-Result-Count

users result count

application/json

Schema

Schema

Array [
iduuid
user uuid
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}
identityNamestring
user identity name
displayNamestring
user displayed name
emailstring
user email
firstNamestring
user first name
lastNamestring
user last name
organizations object[]
list of organization roles associated to a user
Array [
organizationIduuid
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}
organizationNamestring
organization name associated to user
roleIduuid
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}
roleNamestring
role name associated to user
]
]

Example (auto)

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "identityName": "string",
    "displayName": "string",
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "organizations": [
      {
        "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "organizationName": "string",
        "roleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "roleName": "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"
}

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 'https://api.orange.com/evolutionplatform/referentiel/api/v1//users' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>'

Request Collapse all

Base URL

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

Auth

Security Scheme

oauth2clientcredentialsapi_key

Bearer Token

Parameters

limit — query

offset — query