Skip to content
CM Box Docs

Users

These API’s are for creating, accessing, and maintaining security users inside of CM Box.

GET /api/security/users

Retrieves a list of users

Params

none

Response

name - name of the user
id - ID of the user
searchId - id used for other APIs in searching users

Example Response

{
    "name": "Example User 1",
    "id": "user1@fishbowlsolutions.com",
    "searchId": "user1\\@fishbowlsolutions\\.com",
    "repos": [],
    "roles": [],
    "groups": [],
    "type": "user",
    "description": "",
    "_key": "fb:middleware:security:users:user1\\@fishbowlsolutions\\.com"
},
{
    "name": "Example User 2",
    "id": "user2@fishbowlsolutions.com",
    "searchId": "user2\\@fishbowlsolutions\\.com",
    "repos": [
        {
            "CACHE_ROOT": "test",
            "id": "8cd4a8ba-0956-428f-af9e-17ff46ac2cb9",
            "permission": "maintainers"
        }
    ],
    "roles": [
        "admin"
    ],
    "groups": [],
    "type": "user",
    "description": "",
    "_key": "fb:middleware:security:users:user2\\@fishbowlsolutions\\.com"
},

GET /api/security/users/:user_id

Retrieves the user based on the specified user id

Params

user_id - ID of the user

Response

name - name of the user
id - ID of the user
searchId - id used for other APIs in searching users

Example Response

{
    "name": "Example User 1",
    "id": "user1@fishbowlsolutions.com",
    "searchId": "user1\\@fishbowlsolutions\\.com",
    "repos": [],
    "roles": [],
    "groups": [],
    "type": "user",
    "description": "",
    "_key": "fb:middleware:security:users:user1\\@fishbowlsolutions\\.com"
},

POST /api/security/users/:user_id

Creates a new user

Params

user_id - ID of the new user to add

Request

id - the desired id for the new user
name - name of the new user
description (optional) - description of the new user

Response

200 - OK on success

PUT /api/security/users/:user_id

Used to update a given users roles or groups

Params

user_id:  ID of the user you wish to update

Request

DELETE /api/security/users/:user_id

Used to delete a given user based on the user id

Params

user_id: ID of the user you wish to delete

Response

200 - OK on success