Nurama Developers
Join Links

Issue a new token for a join link

Replaces the link's token, invalidating the previous URL immediately. This is the revocation path for a leaked link: the configuration and audit trail survive, the circulating URL stops working. An `expiresAt` may be set in the same call.

POST
/join-links/{linkId}/roll

Replaces the link's token, invalidating the previous URL immediately. This is the revocation path for a leaked link: the configuration and audit trail survive, the circulating URL stops working. An expiresAt may be set in the same call.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

linkId*string
Match^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Formatuuid

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/497f6eca-6276-4993-bfeb-53cbbbba6f08/roll" \  -H "Content-Type: application/json" \  -d '{}'
{  "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"}