Authorizations

Updates the start or end date for a user authorization

PUT
/v2.1/accounts/{accountId}/users/{userId}/authorization/{authorizationId}

Updates the start and/or end date for a given user authorization. Specify the user authorization and principal user with the path parameters.

To call this endpoint, you must be an account administrator or you must be the principal user for the specified authorization.

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

The external account number (int) or account ID GUID.

authorizationId*string

The ID of the user authorization.

userId*string

The ID of the principal user.

Request Body

application/json

The request object to update a user authorization.

endDate?string

The end date for the user authorization. The default value is the max UTC value: 9999-12-31T23:59:59.0000000+00:00.

startDate?string

The start date for the user authorization. The default value is the current date and time.

Response Body

application/json

application/json

curl -X PUT "https://example.com/v2.1/accounts/string/users/string/authorization/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "agentUser": {    "accountId": "string",    "email": "string",    "name": "string",    "userId": "string"  },  "authorizationId": "string",  "created": "string",  "createdBy": "string",  "endDate": "string",  "modified": "string",  "modifiedBy": "string",  "permission": "string",  "principalUser": {    "accountId": "string",    "email": "string",    "name": "string",    "userId": "string"  },  "startDate": "string",  "taskSource": "string",  "taskType": "string"}