Get an invitation link

GET /api/2.0/portal/users/invite/{employeeType}

Request

Returns an invitation link for joining the portal.

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Path

employeeTypeone ofrequired

Employee type (All, RoomAdmin, User, DocSpaceAdmin)

.enum of string

[All - All, RoomAdmin - Room admin, User - User, DocSpaceAdmin - DocSpace admin, Collaborator - Collaborator]

Can be one of: All, RoomAdmin, User, DocSpaceAdmin, Collaborator.

.enum of integer

[0 - All, 1 - Room admin, 2 - User, 3 - DocSpace admin, 4 - Collaborator]

Can be one of: 0, 1, 2, 3, 4.

Examples

GET /api/2.0/portal/users/invite/%7BemployeeType%7D HTTP/1.1
Accept: application/json
Host: example.com

curl --request GET \
  --url https://example.com/api/2.0/portal/users/invite/%7BemployeeType%7D \
  --header 'Accept: application/json'

Responses

200

Invitation link

401

Unauthorized

403

Forbidden