Skip to main content
PUT
/
organizations
/
{orgId}
/
support
Request Support
curl --request PUT \
  --url https://api.m3ter.com/organizations/{orgId}/support \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dtEndSupportUsersAccess": "2023-11-07T05:31:56Z",
  "version": 123,
  "supportUsersPermissionPolicy": [
    {
      "effect": "<string>",
      "action": [
        "<string>"
      ],
      "resource": [
        "<string>"
      ]
    }
  ]
}
'
{
  "id": "<string>",
  "version": 123,
  "dtEndSupportUsersAccess": "2023-11-07T05:31:56Z",
  "supportUsersPermissionPolicy": [
    {
      "effect": "<string>",
      "action": [
        "<string>"
      ],
      "resource": [
        "<string>"
      ]
    }
  ]
}

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

​
orgId
string
required

UUID of the organization

Body

application/json
​
dtEndSupportUsersAccess
string<date-time>
required

The Date/Time Support access ends (in ISO-8601 format).

​
version
integer<int64>

The version number of the entity:

  • Create entity: Not valid for initial insertion of new entity - do not use for Create. 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.
​
supportUsersPermissionPolicy
object[]

The Permission Policies assigned to any support users when they access your Organization.

Response

Returns Support request details

​
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.
​
dtEndSupportUsersAccess
string<date-time>

The Date/Time Support access ends (in ISO-8601 format).

​
supportUsersPermissionPolicy
object[]

The Permission Policies assigned to any support users when they access your Organization.