Skip to main content
PUT
/
organizations
/
{orgId}
/
users
/
{id}
Update OrgUser
curl --request PUT \
  --url https://api.m3ter.com/organizations/{orgId}/users/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "version": 123,
  "permissionPolicy": [
    {
      "action": [],
      "resource": [
        "<string>"
      ]
    }
  ],
  "dtEndAccess": "2023-11-07T05:31:56Z"
}
'
{
  "id": "<string>",
  "version": 123,
  "firstName": "<string>",
  "lastName": "<string>",
  "contactNumber": "<string>",
  "email": "<string>",
  "organizations": [
    "<string>"
  ],
  "firstAcceptedTermsAndConditions": "2023-11-07T05:31:56Z",
  "lastAcceptedTermsAndConditions": "2023-11-07T05:31:56Z",
  "supportUser": true,
  "dtCreated": "2023-11-07T05:31:56Z",
  "dtLastModified": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "lastModifiedBy": "<string>",
  "permissionPolicy": [
    {
      "action": [],
      "resource": [
        "<string>"
      ]
    }
  ],
  "dtEndAccess": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow.

The authorizationCode flow controls access for human users via the m3ter Console application.

Path Parameters

​
id
string
required

The unique identifier (UUID) of the OrgUser to update.

Note: The orgId path parameter is also required.

Body

application/json
​
version
integer<int64>

The version number of the entity:

  • Newly created entity: On initial Create, version is set at 1 and listed in the response.
  • Update Entity: On Update, version is required and must match the existing version because a check is performed to ensure sequential versioning is preserved. Version is incremented by 1 and listed in the response.
​
permissionPolicy
object[]

An array of permission statements for the user. Each permission statement defines a specific permission for the user.

See Understanding, Creating, and Managing Permission Policies for more information.

​
dtEndAccess
string<date-time>

The date and time (in ISO 8601 format) when the user's access will end. Use this to set or update the expiration of the user's access.

Response

Returns the updated OrgUser

​
id
string
required

The UUID of the entity.

​
version
integer<int64>

The version number:

  • Create: On initial Create to insert a new entity, the version is set at 1 in the response.
  • Update: On successful Update, the version is incremented by 1 in the response.
​
firstName
string

The first name of the user.

​
lastName
string

The surname of the user.

​
contactNumber
string

The user's contact telephone number.

​
email
string

The email address for this user.

​
organizations
string[]

An array listing the Organizations where this user has access.

​
firstAcceptedTermsAndConditions
string<date-time>

The date and time (in ISO 8601 format) when this user first accepted the the m3ter terms and conditions.

​
lastAcceptedTermsAndConditions
string<date-time>

The date and time (in ISO 8601 format) when this user last accepted the the m3ter terms and conditions.

​
supportUser
boolean

Indicates whether this is a m3ter Support user.

​
dtCreated
string<date-time>

The date and time (in ISO-8601 format) when the user was created.

​
dtLastModified
string<date-time>

The date and time (in ISO-8601 format) when the user was last modified.

​
createdBy
string

The user who created this user.

​
lastModifiedBy
string

The unique identifier (UUID) of the user who last modified this user record.

​
permissionPolicy
object[]

An array of permission statements for the user. Each permission statement defines a specific permission for the user.

​
dtEndAccess
string<date-time>

The date and time (in ISO 8601 format) when the user's access will end. Used to set or update the date and time a user's access expires.