Users

For conceptual information about user and role management, refer to the User Management Concepts guide. For complete technical specifications, see the Users REST API documentation.

The following API calls require the calling user to have the SUPERVISOR or ADMINISTRATOR role.

Create user

To create a new user, send a POST request to the /api/users endpoint.

POST https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/users

{
    "firstname": "Donna",
    "lastname": "Sheridan-Carmichael",
    "username": "dsheridan",
    "password": "fsdf6556",
    "roles": [
        {
            "name": "FULFILLER",
            "facilities": [
                "0AMSoRCbm7kSM3LJPoeH"
            ]
        }
    ]
}

A successful request returns a 201 Created response with the newly created user object.

{
    "id": "x5jrZrDHvYYs6HpaDICKYG4QuIk2",
    "username": "dsheridan",
    "firstname": "Donna",
    "lastname": "Sheridan-Carmichael",
    "customClaims": {
        "roles": [
            {
                "name": "FULFILLER",
                "facilities": [
                    "0T1vKaEar0nuG58CxzA5"
                ]
            }
        ]
    },
    "created": "2020-09-25T10:06:35.000Z",
    "lastModified": "2020-09-25T10:06:35.009Z",
    "version": 1
}

Modify user

To modify an existing user, for example to assign a new role, send a PATCH request to the user's endpoint with a ModifyUser action.

PATCH https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/users/x5jrZrDHvYYs6HpaDICKYG4QuIk2

{
    "actions": [
        {
            "action": "ModifyUser",
            "roles": [
                {
                    "name": "SUPERVISOR",
                    "facilities": [
                        "0T1vKaEar0nuG58CxzA5"
                    ]
                }
            ]
        }
    ],
    "version": 1
}

A successful request returns a 200 OK response with the updated user object.

{
    "id": "x5jrZrDHvYYs6HpaDICKYG4QuIk2",
    "username": "dsheridan",
    "firstname": "Donna",
    "lastname": "Sheridan-Carmichael",
    "customClaims": {
        "roles": [
            {
                "name": "SUPERVISOR",
                "facilities": [
                    "0T1vKaEar0nuG58CxzA5"
                ]
            }
        ]
    },
    "created": "2020-09-25T10:06:35.000Z",
    "lastModified": "2030-10-01T09:12:22.000Z",
    "version": 2
}

Delete user

When a user is deleted, all currently active JSON Web Tokens (JWTs) for that user are invalidated.

DELETE https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/users/x5jrZrDHvYYs6HpaDICKYG4QuIk2