Sign in
Invitations

Invite User to Organization

Invite a new user to your Organization.

This sends an email to someone inviting them to join your m3ter Organization.

post/organizations/{orgId}/invitations

Path parameters

orgIdstring required

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

Request body

m3terUserboolean
versioninteger
firstNamestring required
lastNamestring required
contactNumberstring
emailstring email required
permissionPolicyIdsstring[]

The IDs of the permission policies the invited user has been assigned. This controls the access rights and privileges that this user will have when working in the m3ter Organization.

dtEndAccessstring date-time

The date when access will end for the user (in ISO-8601 format). Leave blank for no end date, which gives the user permanent access.

dtExpirystring date-time

The date when the invite expires (in ISO-8601 format). After this date the invited user can no longer accept the invite. By default, any invite is valid for 30 days from the date the invite is sent.

Response

Returns the Invitation

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.
emailstring required

The email address of the invitee. The invitation will be sent to this email address.

permissionPolicyIdsstring[] required

The IDs of the permission policies the invited user has been assigned. This controls the access rights and privileges that this user will have when working in the m3ter Organization.

firstNamestring required

The first name of the invitee.

lastNamestring required

The surname of the invitee.

dtEndAccessstring date-time required

The date that access will end for the user (in ISO-8601 format). If this is blank, there is no end date meaning that the user has permanent access.

dtExpirystring date-time required

The date when the invite expires (in ISO-8601 format). After this date the invited user can no longer accept the invite. By default, any invite is valid for 30 days from the date the invite is sent.

invitingPrincipalIdstring required

The UUID of the user who sent the invite.

acceptedboolean required

Boolean indicating whether the user has accepted the invitation.

  • TRUE - the invite has been accepted.
  • FALSE - the invite has not yet been accepted.
dtCreatedstring date-time

The DateTime when the invitation was created (in ISO-8601 format).

dtLastModifiedstring date-time

The DateTime when the invitation was last modified (in ISO-8601 format).

createdBystring

The UUID of the user who created the invitation.

lastModifiedBystring

The UUID of the user who last modified the invitation.

Changes

Changed in 2 of the 10 revisions of this API.1042

  • ac93d1a9e6d91041See the full diff
    • ▲

      removed the required property accepted from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property dtEndAccess from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property dtExpiry from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property email from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property firstName from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property invitingPrincipalId from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property lastName from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property permissionPolicyIds from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property version from the response with the 200 status

      response-required-property-removed

    • ●

      removed the optional property createdBy from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property dtCreated from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property dtLastModified from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property lastModifiedBy from the response with the 200 status

      response-optional-property-removed

    • ○

      added AbstractResponse subschema #2 to the response body allOf list for the response status 200

      response-body-all-of-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9433593378b51See the full diff
    • ○

      api operation id InviteUserToOrg removed and replaced with CreateOrgUserInvitation

      api-operation-id-removed

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog