API Endpoints: Invitations
GET /invitations
Get all invitations for the account that the principal is associated with.
Path parameters:
- None
Query parameters:
- None
Example request:
curl -X GET "https://landscape.canonical.com/api/v2/invitations" -H "Authorization: Bearer $JWT"
Example output:
{
"count": 2,
"results": [
{
"id": 1,
"secure_id": "EbXOD9yH4SCmIoTmO60AZkdFNVuMZ5",
"account": "Onward, Inc.",
"name": "Joe Wright",
"email": "[email protected]",
"creation_time": "2024-03-20T14:49:25Z"
},
{
"id": 2,
"secure_id": "YE6XEiWr5V0HUBgMhZAwgyofwY5EKd",
"account": "Onward, Inc.",
"name": "Ted Support",
"email": "[email protected]",
"creation_time": "2024-03-20T14:49:25Z"
}
],
"next": null,
"previous": null
}
POST /invitations
Create and send an invitation to a new administrator for your account. The default to the GlobalAdmin role if no role is specified.
Required parameters:
name: The name of the person to invite.email: The email address where the administrator invitation will be sent.
Optional parameters:
roles: If specified, a list of strings with the roles that the administrator will have in your account.
Example request:
curl -X POST "https://landscape.canonical.com/api/v2/invitations" -H "Authorization: Bearer $JWT" -d '{"name": "Bobby", "email": "[email protected]", "roles": ["Auditor", "SupportAnalyst"]}'
Example output:
{
"id": 4,
"secure_id": "ozVPhiV41ZfgyP53QHvlwOP3syeKel"
}
DELETE /invitations/<int:id>
Deletes an invitation request for a user to join Landscape.
Required parameters:
id: The invitation ID
Optional parameters:
- None
Example request:
curl -X DELETE "https://landscape.canonical.com/api/v2/invitations/4" -H "Authorization: Bearer $JWT"
GET /invitations/<int:id>
Gets the person’s information in an invitation request to join Landscape.
Path parameters:
id: The invitation ID
Query parameters:
- None
Example request:
curl -X GET "https://landscape.canonical.com/api/v2/invitations/2" -H "Authorization: Bearer $JWT"
Example output:
{
"id": 2,
"secure_id": "YE6XEiWr5T0HUBgMhXAwgyofwY5EKd",
"account": "Onward, Inc.",
"name": "Ted Support",
"email": "[email protected]",
"creation_time": "2024-03-20T14:49:25Z"
}