Sign in

v10

latestOpenAPI 3.0.1raw.githubusercontent.com2025-12-033223581.2 MB
OrgUsers

Update OrgUser

Update the OrgUser with the given UUID.

Updates the details for a specific user within an Organization using their unique identifier (UUID). Use this endpoint when you need to modify user information such as their permission policy.

put/organizations/{orgId}/users/{id}

Path parameters

idstring required

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

Note: The orgId path parameter is also required.

orgIdstring required

UUID of the organization. The Organization represents your company as a direct customer of the m3ter service.

Request body

versioninteger

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.
dtEndAccessstring 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

idstring required

The UUID of the entity.

versioninteger

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.
firstNamestring

The first name of the user.

lastNamestring

The surname of the user.

contactNumberstring

The user's contact telephone number.

emailstring

The email address for this user.

organizationsstring[]

An array listing the Organizations where this user has access.

firstAcceptedTermsAndConditionsstring date-time

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

lastAcceptedTermsAndConditionsstring date-time

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

supportUserboolean

Indicates whether this is a m3ter Support user.

dtCreatedstring date-time

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

dtLastModifiedstring date-time

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

createdBystring

The user who created this user.

lastModifiedBystring

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

dtEndAccessstring 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.