Create a join link for a project
Mints a link granting `role` on `projectId`. Defaults to the safest useful setting — `reviewer`, the non-billable role that only counts against the seat cap — so an omitted `role` cannot silently hand out creator access. The caller's grant authority is checked in the service: requesting a role above it is refused rather than downgraded.
Mints a link granting role on projectId. Defaults to the safest
useful setting — reviewer, the non-billable role that only counts
against the seat cap — so an omitted role cannot silently hand out
creator access. The caller's grant authority is checked in the service:
requesting a role above it is refused rather than downgraded.
Authorization
bearerAuth In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/join-links" \ -H "Content-Type: application/json" \ -d '{ "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8" }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "token": "string", "label": "string", "ownerResourceType": "project", "ownerResourceId": "7d5ad1db-89f9-42df-868c-86a72347ae1c", "role": "reviewer", "additionalRoles": [ "string" ], "mode": "auto", "allowedEmailDomains": [ "string" ], "status": "active", "expiresAt": "2019-08-24T14:15:22Z", "maxUses": 0, "useCount": 0, "creatorId": "688ebf54-d343-4104-8711-82c2feac534a", "tokenRolledAt": "2019-08-24T14:15:22Z", "rolledByUserId": "4cb4397c-25f6-46d5-b288-c49713e36c73", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}