Add support for subscription users

[zbynekh]

Motivation

We have created a subscription-scoped part of the management API, called Subscription API (SAPI) for subscription admins and we would like it to be covered in the SDK.

(!) Going to be released in the first half of January 22.

Proposed solution

The SDK should include functionality of the new endpoints for subscription users:

• get all subscription users
• get subscription user by identifier
• activate user in all subscription projects
• deactivate user in all subscription projects

Additional context

SAPI endpoins contract

See Docs preview for more detailed info.

The endpoints that were added:

• GET /v2/subscriptions/{subscription_id}/users

  • get all subscription users including their assignment to projects
  • with pagination
  • sample response body:

    {
    "users":[
    {
    "id":"e67eadda-dc58-4bf9-89fc-1dadc0b95858",
    "first_name":"John",
    "last_name":"Doe",
    "email":"jonh.doe@exmaple.com",
    "has_pending_invitation":false,
    "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":"+RID:~...",
    "next_page":"https://manage.kontent.ai/v2/subscriptions/<subscription_id>/<resource>?continuationToken=%2bRID%3a~..."
    }
    }

• GET /v2/subscriptions/{subscription_id}/users/{user_identifier}

  • return subscription user by his id or email including the assignment to projects
  • user identifier can be
  • {user_id}
  • email/{email}
  • sample response body:

    {
    "id":"e67eadda-dc58-4bf9-89fc-1dadc0b95858",
    "first_name":"John",
    "last_name":"Doe",
    "email":"jonh.doe@exmaple.com",
    "has_pending_invitation":false,
    "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
                }
              ]
            }
          ]
        }
      ]
    }
    ]
    }
    ]
    }

• PUT /v2/subscriptions/{subscription_id}/users/{user_identifier}/activate

  • activates the user in all projects in the subscription
  • user identifier can be
  • {user_id}
  • email/{email}
  • returns 204 without body, or 400 / 404 with error object

• PUT /v2/subscriptions/{subscription_id}/users/{user_identifier}/dectivate

  • deactivates the user in all projects in the subscription
  • user identifier can be
  • {user_id}
  • email/{email}
  • returns 204 without body, or 400 / 404 with error object

[milan009]

Released on 2022-01-12

[Enngage]

Released in 2.0.0