Users - Invites

To add a new user to a tenant, a current user with the tenant administrator role must send an invite to the user. This applies both for existing users of another tenant or entirely new users. After being invited, users then can accept or decline invites. If a user accepts the invitation, the user is automatically added to the tenant.

Get User Invites

The Get User Invites endpoint returns "pending" user invites.

GET /1/users/{user_id}/invites
Host: https://api.cogniac.io

Example: Get All Pending User Invites

curl -X GET https://api.cogniac.io/1/users/current/invites \
-H "Authorization: Bearer abcdefg.hijklmnop.qrstuvwxyz" \
-H "Content-Type: application/json" \
| json_pp

import requests
import json
from pprint import pprint

url_prefix = 'https://api.cogniac.io'
api_version = "1"
token = ''  # add your token here
headers = {'Authorization': f'Bearer {token}',
           'Content-Type': 'application/json'}

url = f'{url_prefix}/{api_version}/users/current/invites'
res = requests.get(url, headers=headers)

if res.status_code == 200:
    response_data = json.loads(res.content)
    pprint(response_data)
else:
    print(f"Error: {res.status_code}, {res.text},{res.headers}")

[
  {
    "last_resend_at": 1508432670, 
    "accepted_at": null, 
    "tenant_id": "d3s1hwewhrhr", 
    "created_at": 1508432670, 
    "last_resend_by": "jane@cogniac.co", 
    "created_by": "jane@cogniac.co", 
    "resend_counter": 3, 
    "tenant_name": "My Organization Tenant", 
    "invited_user_email": "test@cogniac.co", 
    "invitation_status": "pending"
  }
]

Update User Invite

tenant_id and invitation_status are required fields. invitation_status must equal "accepted" or "declined".

POST /1/users/{user_id}/invites
Host: https://api.cogniac.io

{
  "invitation_status": "accepted",
  "tenant_id": "d3s7hwewhttr"
}

{
  "last_resend_at": 1508432670, 
  "accepted_at": 1508432670, 
  "tenant_id": "d3s7hwewhttr", 
  "created_at": 1508432670, 
  "last_resend_by": "jane@cogniac.co", 
  "created_by": "jane@cogniac.co", 
  "resend_counter": 3, 
  "tenant_name": "My Organization Tenant", 
  "invited_user_email": "test@cogniac.co", 
  "invitation_status": "accepted"
}