SubscriptionInvites
SubscriptionInvites
GetInvites
Get list of invites in a subscription, the added users will be displayed in the list of users of the subscription, and these users will also have an active subscription.
Request
GET /api/manage/v1/Subscriptions/{subscriptionId}/invitesParameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *subscriptionId | string | Idenitifier of subscription |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Succesfully added |
|
| 400 | The request is wrong |
|
| 402 | The subscription is blocked |
|
| 403 | You don't have permissions for the operation |
|
| 404 | Subscription or user is not found |
CreateInvite
Create invite to subscription
Request
POST /api/manage/v1/Subscriptions/{subscriptionId}/inviteParameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *subscriptionId | string | id |
|
| body | create VM |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Successfully created |
|
| 400 | Request is wrong |
|
| 402 | subscription is outdated |
|
| 403 | Not enough permissions |
|
| 404 | there is no subscription with such id |
DeleteInvite
Delete invite with specified token
Request
DELETE /api/manage/v1/Subscriptions/{subscriptionId}/invite/{accesstoken}Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *subscriptionId | string | id |
|
| *accesstoken | string | invite's token |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 204 | Successfully deleted |
|
| 400 | Request is wrong |
|
| 402 | subscription is outdated |
|
| 403 | Not enough permissions |
|
| 404 | there is no subscription with such id |
AcceptInvite
Add the current user to the subscription using invite,
Request
GET /api/manage/v1/Subscriptions/{subscriptionId}/invite/{accessToken}/acceptParameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *subscriptionId | string | Idenitifier of subscription |
|
| *accessToken | string | access token of the subscription |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | User already in subscription |
|
| 204 | Succesfully added |
|
| 400 | The request is wrong |
|
| 403 | You don't have permissions for the operation |
|
| 404 | Subscription or user is not found |
Definitions
SubscriptionInvitesVM
| Name | Type | Notes |
|---|---|---|
| invites |
|
|
| count | integer (int64) | |
| $t | string |
SubscriptionInviteVM
| Name | Type | Notes |
|---|---|---|
| usages | integer (int64) | |
| durable | boolean | |
| accessToken | string | |
| expiredDate | string (date-time) | |
| addedUsers |
|
|
| creatorUserId | string | |
| $t | string |
InvitedUser
| Name | Type | Notes |
|---|---|---|
| userId | string | |
| invitedAt | string (date-time) |
ProblemDetails
| Name | Type | Notes |
|---|---|---|
| type | string | |
| title | string | |
| status | integer (int32) | |
| detail | string | |
| instance | string |
CreateSubscriptionInviteVM
| Name | Type | Notes |
|---|---|---|
| usages | integer (int64) | |
| durable | boolean | |
| expiredDate | string (date-time) | |
| $t | string |