Login

POST
/api/v1/users

Request Parameters

Name Type Description Required
email string Email address for the user. Yes
firstName string First name for the user
lastName string Last name for the user Yes
username string Username for the user Yes
title string Job title for the user
PhoneNumber string Phone number for the user
language string Two digit language code (e.g. en)
GroupIds [] string Assign the user to existing groups.
roleIds [] string Assign the user to existing roles. Media Viewer is the default role.

Example Request

{
  "email": "mark@gmail.com",
  "firstName": "Mark",
  "lastName": "Anthony",
  "title": "Mark",
  "PhoneNumber": "(887) 455-5858",
  "username": "markanthony",
  "language": "en",
  "GroupIds": [
    "4f492be4-1b36-49ea-8000-4ea52ae6c7fe"
  ],
  "roleIds": [
    "9f793be4-1b39-49ea-8406-6ea12ae3c7gd"
  ]

}

Example Response

{
  "userId": "string"
}

Response Codes

Code Description
200 ok
401 Unauthorized error
500 Internal server error

Delete

NOTE: As of Rev v7.12, this API is available.

DELETE
/api/v1/users/{userId}

Request Parameters

Name Type Description Required
userId path GUID for the user. Yes

Response Codes

Code Description
200 ok
401 Unauthorized error
500 Internal server error

Get User Roles

GET
/api/v1/users/roles

Request Parameters

Name Type Description Required
none

Example Response

[
{
  "id": "5562b7bf-f205-4614-8891-143e42618b3b",
  "name": "Account Admin",
  "description": ""
},
{
  "id": "92d56ab9-a001-4e91-bbea-65361f2cb581",
  "name": "Media Admin",
  "description": ""
},
{
  "id": "154f1e93-36eb-4edc-9c4b-473ce706d8d7",
  "name": "Media Viewer",
  "description": ""
},
{
  "id": "4e5b96e9-1824-4432-ac8c-33c89037eca6",
  "name": "Event Admin",
  "description": ""
},
{
  "id": "c4f681aa-826d-47a7-b73a-c413796fa92a",
  "name": "Media Contributor",
  "description": ""
} ]

Response Codes

Code Description
200 ok
401 Unauthorized error
500 Internal server error