Skip to main content
Kinetic Community

Users

Operation List

GET /users Retrieve Users
POST /users Create User
GET /users/{username} Retrieve User
PUT /users/{username} Update User
DELETE /users/{username} Delete User

Resource Schema

Available Includes

  • details
  • attributes
  • space

Operation

Retrieve Users

GET /users

Lists information about all Users in the space.

Request

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "users": [
    {
      "displayName": "Joe User",
      "email": "joe.user@company.com",
      "enabled": true,
      "spaceAdmin": true,
      "username": "joeuser",
      "attributes": []
    }
  ]
}

Create User

POST /users

Creates a new user for the Space.

The current user must have Space management privileges to perform this action.

Request

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "displayName": "Joe User",
  "email": "joe.user@company.com",
  "enabled": true,
  "spaceAdmin": true,
  "username": "joeuser",
  "attributes": []
}

Response

Body
{
  "user": {
    "displayName": "Joe User",
    "email": "joe.user@company.com",
    "enabled": true,
    "spaceAdmin": true,
    "username": "joeuser",
    "attributes": []
  }
}

Retrieve User

GET /users/{username}

Retrieves the User identified by the {username} parameter.

Request

Path Parameters
username

The name of the user to retrieve.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "user": {
    "displayName": "Joe User",
    "email": "joe.user@company.com",
    "enabled": true,
    "spaceAdmin": true,
    "username": "joeuser",
    "attributes": []
  }
}

Update User

PUT /users/{username}

Updates the User specified by the {username} parameter with the property values sent in the request body.

NOTE All properties in the request body are optional, and only the properties supplied will be updated.

The current user must have Space management privileges to perform this action.

Request

Path Parameters
Username

The username of the user to update.

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "displayName": "Joe User",
  "email": "joe.user@company.com",
  "enabled": true,
  "password": "asdfasdf",
  "spaceAdmin": true,
  "username": "joeuser",
  "attributes": []
}

Response

Body
{
  "user": {
    "displayName": "Joe User",
    "email": "joe.user@company.com",
    "enabled": true,
    "spaceAdmin": true,
    "username": "joeuser",
    "attributes": []
  }
}

Delete User

DELETE /users/{username}

Deletes the User specified by the {username} parameter.

The current user must have Space management privileges to perform this action.

Request

Path Parameters
username

The username of the user to delete.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "user": {
    "displayName": "Joe User",
    "email": "joe.user@company.com",
    "enabled": true,
    "spaceAdmin": true,
    "username": "joeuser",
    "attributes": []
  }
}

 

Related