Subscription management
- Be a subscription admin.
- Authenticate your requests with a Subscription API key.
projects[]
Show child attributes
https://manage.kontent.ai/v2/subscriptions/{subscription_id}/projectshttps://manage.kontent.ai/v2/subscriptions/{subscription_id}/usershttps://manage.kontent.ai/v2/subscriptions/{subscription_id}/users/{user_identifier}https://manage.kontent.ai/v2/subscriptions/{subscription_id}/users/{user_identifier}/activatehttps://manage.kontent.ai/v2/subscriptions/{subscription_id}/users/{user_identifier}/deactivatesubscription_idx-continuationprojects[]subscription_idx-continuationusers[]subscription_iduser_identifieridfirst_namelast_nameemailsubscription_iduser_identifiersubscription_iduser_identifierpaginationpaginationhas_pending_invitationprojects[]x-continuation header parameter to the value of the continuation_token property.x-continuation header parameter to the value of the continuation_token property.mB9I0b-n-Zhe-x2my4NPjJovOiE0cqKgIyuVjqfKyW0) or email (e.g., email/user@example.com).mB9I0b-n-Zhe-x2my4NPjJovOiE0cqKgIyuVjqfKyW0) or email (e.g., email/user@example.com).mB9I0b-n-Zhe-x2my4NPjJovOiE0cqKgIyuVjqfKyW0) or email (e.g., email/user@example.com).idnameis_activeenvironments[]idfirst_namelast_nameemailhas_pending_invitationprojects[]
. All rights reserved.
{
"projects": {
"id": "a7d24131-b0c5-4dda-ad78-c0b409951493",
"name": "Sample project",
"is_active": true,
"environments": [
{
"id": "c9bad3b5-2b91-4df9-9d4a-53d0bf14343b",
"name": "Production"
},
{
"id": "fcd4e8cb-4577-4bd0-9104-07538b64eef7",
"name": "Dev"
}
]
},
"pagination": {
"continuation_token": "W3sidG9rZW4iOiIrUklEOn...",
"next_page": "https://manage.kontent.ai/v2/your/chosen/list/endpoint"
}
}{
"users": {
"id": "e67eadda-dc58-4bf9-89fc-1dadc0b95858",
"first_name": "John",
"last_name": "Doe",
"email": "jonh.doe@exmaple.com",
"has_pending_invitation": true,
"projects": {
"id": "a7d24131-b0c5-4dda-ad78-c0b409951493",
"name": "Sample project",
"environments": {
"id": "c9bad3b5-2b91-4df9-9d4a-53d0bf14343b",
"name": "Production",
"is_user_active": true,
"last_activity_at": "2021-12-24T12:00:00.7692802Z",
"collection_groups": {
"collections": {
"id": "3f367e4f-75b7-4b48-be3b-1136bbaf1f53"
},
"roles": {
"id": "c11a2c9e-f129-43b8-9cb1-20a7b3746934",
"name": "Project manager",
"codename": "project-manager",
"languages": {
"id": "00000000-0000-0000-0000-000000000000",
"external_id": "string",
"codename": "default",
"name": "Default language",
"is_active": true
}
}
}
}
}
},
"pagination": {
"continuation_token": "W3sidG9rZW4iOiIrUklEOn...",
"next_page": "https://manage.kontent.ai/v2/your/chosen/list/endpoint"
}
}{
"id": "a7d24131-b0c5-4dda-ad78-c0b409951493",
"name": "Sample project",
"is_active": true,
"environments": [
{
"id": "c9bad3b5-2b91-4df9-9d4a-53d0bf14343b",
"name": "Production"
},
{
"id": "fcd4e8cb-4577-4bd0-9104-07538b64eef7",
"name": "Dev"
}
]
}{
"id": "e67eadda-dc58-4bf9-89fc-1dadc0b95858",
"first_name": "John",
"last_name": "Doe",
"email": "jonh.doe@exmaple.com",
"has_pending_invitation": true,
"projects": {
"id": "a7d24131-b0c5-4dda-ad78-c0b409951493",
"name": "Sample project",
"environments": {
"id": "c9bad3b5-2b91-4df9-9d4a-53d0bf14343b",
"name": "Production",
"is_user_active": true,
"last_activity_at": "2021-12-24T12:00:00.7692802Z",
"collection_groups": {
"collections": {
"id": "3f367e4f-75b7-4b48-be3b-1136bbaf1f53",
"codename": "object_codename",
"external_id": "your-own-custom-identifier"
},
"roles": {
"id": "c11a2c9e-f129-43b8-9cb1-20a7b3746934",
"name": "Project manager",
"codename": "project-manager",
"languages": {
"id": "00000000-0000-0000-0000-000000000000",
"external_id": "string",
"codename": "default",
"name": "Default language",
"is_active": true
}
}
}
}
}
}// Tip: Find more about .NET SDKs at https://kontent.ai/learn/net
using Kontent.Ai.Management;
var client = new ManagementClient(new ManagementOptions
{
ApiKey = "KONTENT_AI_MANAGEMENT_API_KEY",
EnvironmentId = "KONTENT_AI_ENVIRONMENT_ID"
});
var client = _fileSystemFixture.CreateMockClientWithResponse("SubscriptionUsers.json");
var response = await client.ListSubscriptionUsersAsync();
// Tip: Find more about .NET SDKs at https://kontent.ai/learn/net
using Kontent.Ai.Management;
var client = new ManagementClient(new ManagementOptions
{
ApiKey = "KONTENT_AI_MANAGEMENT_API_KEY",
EnvironmentId = "KONTENT_AI_ENVIRONMENT_ID"
});
var response = await client.ListSubscriptionUsersAsync();
// Tip: Find more about .NET SDKs at https://kontent.ai/learn/net
using Kontent.Ai.Management;
var client = new ManagementClient(new ManagementOptions
{
ApiKey = "KONTENT_AI_MANAGEMENT_API_KEY",
EnvironmentId = "KONTENT_AI_ENVIRONMENT_ID"
});
var identifier = UserIdentifier.ByEmail("Joe.Joe@kontent.ai");
//var identifier = UserIdentifier.ById("usr_0vKjTCH2TkO687K3y3bKNS");
var response = await client.GetSubscriptionUserAsync(identifier);
{
"id": "e67eadda-dc58-4bf9-89fc-1dadc0b95858",
"first_name": "John",
"last_name": "Doe",
"email": "jonh.doe@exmaple.com",
"has_pending_invitation": true,
"projects": {
"id": "a7d24131-b0c5-4dda-ad78-c0b409951493",
"name": "Sample project",
"environments": {
"id": "c9bad3b5-2b91-4df9-9d4a-53d0bf14343b",
"name": "Production",
"is_user_active": true,
"last_activity_at": "2021-12-24T12:00:00.7692802Z",
"collection_groups": {
"collections": {
"id": "3f367e4f-75b7-4b48-be3b-1136bbaf1f53"
},
"roles": {
"id": "c11a2c9e-f129-43b8-9cb1-20a7b3746934",
"name": "Project manager",
"codename": "project-manager",
"languages": {
"id": "00000000-0000-0000-0000-000000000000",
"external_id": "string",
"codename": "default",
"name": "Default language",
"is_active": true
}
}
}
}
}
}// Tip: Find more about .NET SDKs at https://kontent.ai/learn/net
using Kontent.Ai.Management;
var client = new ManagementClient(new ManagementOptions
{
ApiKey = "KONTENT_AI_MANAGEMENT_API_KEY",
EnvironmentId = "KONTENT_AI_ENVIRONMENT_ID"
});
var identifier = UserIdentifier.ByEmail("user@kontent.ai");
//var identifier = UserIdentifier.ById("d94bc87a-c066-48a1-a910-4f991ccc1fb5");
await client.ActivateSubscriptionUserAsync(identifier);
{
"request_id": "02e2f665c547564d",
"error_code": 229,
"message": "The user 'sso_32c0ad0f-4f5e-4c4c-96ea-d1ed41024d79' is a subscription admin. They cannot be activated or deactivated in all projects."
}// Tip: Find more about .NET SDKs at https://kontent.ai/learn/net
using Kontent.Ai.Management;
var client = new ManagementClient(new ManagementOptions
{
ApiKey = "KONTENT_AI_MANAGEMENT_API_KEY",
EnvironmentId = "KONTENT_AI_ENVIRONMENT_ID"
});
var identifier = UserIdentifier.ByEmail("user@kontent.ai");
//var identifier = UserIdentifier.ById("d94bc87a-c066-48a1-a910-4f991ccc1fb5");
await client.DeactivateSubscriptionUserAsync(identifier);
{
"request_id": "02e2f665c547564d",
"error_code": 229,
"message": "This user with ID '5bbf48135624682e96bb8c21' is subscription admin and cannot be activated or deactivated in all projects."
}