Approve user invitation

2 minute read

PUT https://www.digicert.com/services/v2/user/invite/{{invitation_id}}/status

Use this endpoint to approve a user invitation and assign container (division) access and access roles to the user. To get the invitation ID, use the List user invitations endpoint.

Example requests and responses

curl --request PUT \
  --url 'https://www.digicert.com/services/v2/user/invite/{{invitation_id}}/status' \
  --header 'Content-Type: application/json' \
  --header 'X-DC-DEVKEY: {{api_key}}' \
  --data-raw '{
  "status": "approved",
  "processor_comment": "Some Comment",
  "requested_user": {
    "container_id_assignments": [
      "92231",
      "378222"
    ],
    "access_roles": [
      {
        "id": "1"
      }
    ]
  }
}'

200 OK

// empty

Filters and URL query parameters

This endpoint does not support filters or URL query parameters.

Path parameters

Name	Req/Opt	Type	Description
invitation_id	required	int	Invitation ID. Get this value from the `invites[].id` response parameter returned by the List user invitations endpoint.

Request parameters

Name	Req/Opt	Type	Description
status	required	string	New status for the invitation. For this workflow, use `approved`.
processor_comment	optional	string	Comment recorded with the invitation approval.
requested_user	required	object	Container assignments and access roles to apply to the approved user.
.. container_id_assignments	required	array of strings	List of container (division) IDs to assign to the user. A user with container assignments can access only the assigned containers. Pass an empty array to give the user access to all containers in the account. For more information, see Update container assignments.
.. access_roles	required	array of objects	Access roles to assign to the user.
.. .. id	required	string	Access role ID. Allowed values: `1`: Administrator - Full administrative access, including managing divisions, users, and user access. `2`: Limited user - Can place and manage only their own orders. `3`: Finance manager - Can manage finances and place and manage orders. `4`: Manager - Can manage finances, create and approve requests, manage orders and domains, and view and edit users. `5`: Standard user - Can place and manage orders; changes require approval by a manager or administrator. See Glossary - Access roles.