Create Invitation

1 import requests 2 3 url = "https://api.coactive.ai/api/v1/auth-management/user-invitations" 4 5 payload = { 6 "name": "John Doe", 7 "email": "john@example.com", 8 "roles": [{ "role_id": "admin" }] 9 } 10 headers = { 11 "Authorization": "Bearer <token>", 12 "Content-Type": "application/json" 13 } 14 15 response = requests.post(url, json=payload, headers=headers) 16 17 print(response.json())

1 { 2 "invitation_id": "inv_123", 3 "inviter": { 4 "name": "John Doe" 5 }, 6 "invitee": { 7 "email": "john@example.com", 8 "name": "John Doe", 9 "roles": [ 10 { 11 "role_id": "admin" 12 } 13 ] 14 }, 15 "invitation_url": "https://example.com/invitation/123", 16 "created_at": "2024-01-01T00:00:00Z", 17 "expires_at": "2024-01-01T00:00:00Z", 18 "roles": [ 19 { 20 "role_id": "admin", 21 "resource": "resource", 22 "resource_instance": "resource_instance" 23 } 24 ] 25 }

Create a new user invitation. This endpoint creates a new invitation for a user to join the organization. The invitation will be sent to the specified email address.

Request

This endpoint expects an object.

namestringRequired

Display name for the invited user

emailstringRequired

Email address to send the invitation to

roleslist of objectsOptional

List of roles to assign to the user

Response

The created invitation details

invitation_idstring

Unique identifier for the invitation

inviterobject

Details about the user who sent the invitation

inviteeobject

Details about the user being invited

invitation_urlstring

URL for the user to accept the invitation

created_atstring

Timestamp when the invitation was created

expires_atstring

Timestamp when the invitation expires

roleslist of objects

List of roles that will be assigned upon acceptance

Headers

Request

Response

Errors