Users

Create a user

Add a user to the organization.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.

To use this endpoint, select Write Users under the Setup & Administration category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>

post/users

Request

  • Base URL
    https://api.samsara.com
  • Auth
    HTTP bearer

Request body

authType'default' | 'saml' required

The authentication type the user uses to authenticate. To use SAML this organization must have a configured SAML integration. Valid values: default, saml.

emailstring required

The email address of this user.

expireAtstring

For users with temporary access, this is the expiration datetime in RFC3339 format

namestring required

The first and last name of the user.

Example request

{
  "email": "user@company.com",
  "expireAt": "2025-08-13T19:08:25Z",
  "name": "Bob Smith",
  "roles": [
    {
      "roleId": "8a9371af-82d1-4158-bf91-4ecc8d3a114c",
      "tagId": "3914"
    }
  ]
}

Response

Newly created user object with ID.

Example response

{
  "data": {
    "email": "user@company.com",
    "id": "123",
    "name": "Bob Smith",
    "roles": [
      {
        "expireAt": "2025-08-13T19:08:25Z",
        "role": {
          "id": "8a9371af-82d1-4158-bf91-4ecc8d3a114c",
          "name": "Full Admin"
        },
        "tag": {
          "id": "3914",
          "name": "East Coast",
          "parentTagId": "4815"
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.