Returns the authorizations for which the specified user is the principal user
Returns the user authorizations for which the user specified by userId is the principal user.
To call this endpoint, you must be an account administrator or you must be the specified principal user.
Authorization
OAuth2 OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.
In: header
Path Parameters
The external account number (int) or account ID GUID.
The ID of the principal user.
Query Parameters
When true, return only active authorizations. The default value is true.
The maximum number of results to return.
Filters returned user records by full email address or a substring of email address.
When true, returns active and scheduled authorizations of closed users. The default value is true. This value is only applied when active_only is false.
Filters results by authorization permission. Valid values:
SendManageSign
The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image.
Filters results based on a full or partial user name.
Note: When you enter a partial user name, you do not use a wildcard character.
Response Body
application/json
application/json
curl -X GET "https://example.com/v2.1/accounts/string/users/string/authorizations"{ "authorizations": [ { "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" } ], "endPosition": "string", "nextUri": "string", "previousUri": "string", "resultSetSize": "string", "startPosition": "string", "totalSetSize": "string"}Updates the start or end date for a user authorization PUT
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.
Create or update multiple user authorizations POST
Create or update multiple user authorizations in a single request. The body of the request is a list of userAuthorizationSomething objects. To create a new authorization, specify the `agentUser` and `permission` fields, with the optional `startDate` and `endDate` fields. To update an existing authorization, specify the `authorizationId` field and the `startDate` and/or `endDate` fields. For example, to create a new authorization and update the end date of an existing authorization, your request body might look like this: ``` { "authorizations": [ { "agentUser": { "userId": "1470ff66-xxxx-xxxx-xxxx-8c46f140da37", "accountId": "230546a7-xxxx-xxxx-xxxx-af205d5494ad" }, "permission": "manage" }, { "authorizationId": "b73ac983-xxxx-xxxx-xxxx-b3c0ea5b09d3", "endDate": "2023-05-09T21:36:27.0000000+00:00" } ] } ``` The principal user is specified by the `userId` path parameter. To call this endpoint, you must be an account administrator or the principal user. **Note:** To create an authorization with signing permission, the `AllowDelegationSigning` setting must be enabled on the account. If you share signing access, the agent user will receive an email notification. Each principal user can only share signing permission with one agent user.