Get user

1 min

GET

https://api.app.kognic.com/v2/users/{userId}

Path Parameters

userIdinteger<int64>required
Format
int64

Header Parameters

acceptstring
Description
Generated from available response content types
Default
application/json
Allowed
application/jsontext/plain

Responses

200

Enveloped_User
- dataUserrequired
  - accountStatusUserAccountStatusrequired
  - accountTypeAccountTyperequired
  - emailstringrequired
  - firstNamestringrequired
  - idinteger<int64>required
    Format
    int64
  - lastNamestringrequired
  - organizationLightOrganizationrequired
    - idinteger<int64>required
      Format
      int64
    - namestringrequired
  - rolesUserRole[]
    - idstring<uuid>required
      Format
      uuid
    - namestringrequired

400

Invalid value for: path parameter userId

401Unauthorized

Unauthorized
- messagestringrequired

403Forbidden

Forbidden
- messagestringrequired

404Not found

NotFound
- messagestringrequired

python

import requests
import json

url = "https://api.app.kognic.com/v2/users/{userId}"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

{
  "data": {
    "accountStatus": "",
    "accountType": "",
    "email": "",
    "firstName": "",
    "id": "",
    "lastName": "",
    "organization": {
      "id": "",
      "name": ""
    },
    "roles": [
      {
        "id": "",
        "name": ""
      }
    ]
  }
}

400

// Invalid value for: path parameter userId

401

// Unauthorized
{
  "message": ""
}

403

// Forbidden
{
  "message": ""
}

404

// Not found
{
  "message": ""
}