Request Headers (Applies to all methods)
PUT
/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/filters/{filterID}/push/subscriptions/users/{userID}
Subscribe this user to the current filter. If the bucket does not exist, the bucket will be created before subscribing the user to it. The user becomes the bucket owner in this case.
Can be performed by the administrator and the user to subscribe himself. The user needs to have the query permission to the bucket where the filter belongs. If the target bucket does not exist, the user also needs to have the bucket creation permission.
This request requires empty body.
Content-Type (None)
Content-Type application/vnd.kii.UserNotFoundException+json
Name | Type | Description |
---|---|---|
errorCode | string | Error code "USER_NOT_FOUND". |
message | string | The error message. |
field | string | The field used for searching the user. This can be the userID or address field. |
value | string | The field value used for searching the user. |
appID | string | The ID of the application. |
Content-Type application/vnd.kii.GroupNotFoundException+json
Name | Type | Description |
---|---|---|
errorCode | string | Error code "GROUP_NOT_FOUND". |
message | string | The error message. |
groupID | string | The groupID of the group. |
appID | string | The ID of the application. |
Content-Type application/vnd.kii.FilterNotFoundException+json
Name | Type | Description |
---|---|---|
errorCode | string | Error code "FILTER_NOT_FOUND". |
message | string | The error message. |
Content-Type application/vnd.kii.PushSubscriptionAlreadyExistsException+json
Name | Type | Description |
---|---|---|
errorCode | string | Error code "PUSH_SUBSCRIPTION_ALREADY_EXISTS". |
message | string | The error message. |
topicID | string | The ID of the topic where the subscription already exists |
objectScope | ObjectScope | The scope of the topic |
appID | string | The ID of the application. |
userID | string | The ID of the user. Only provided for a user-scope bucket. |
groupID | string | The ID of the group. Only provided for a group-scope bucket. |
thingID | string | The ID of the thing. Only provided for a thing-scope bucket. |
type | string | One of "APP", "APP_AND_USER", "APP_AND_GROUP", or "APP_AND_THING". |
subject | string | The subject that is already subscribed to the topic/filter |
Content-Type application/vnd.kii.UnauthorizedAccessException+json
Name | Type | Description |
---|---|---|
errorCode | string | Error code "UNAUTHORIZED". |
message | string | The error message. |
authenticatedAppID | string | The authenticated appID. |
authenticatedPrincipalID | string | The authenticated principal ID (userID or thingID). |
GET
/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/filters/{filterID}/push/subscriptions/users/{userID}
Check if this user is subscribed to the current filter.
Can be performed by the administrator and the subscribed user himself.
Content-Type (None)
Content-Type application/vnd.kii.UserNotFoundException+json
Name | Type | Description |
---|---|---|
errorCode | string | Error code "USER_NOT_FOUND". |
message | string | The error message. |
field | string | The field used for searching the user. This can be the userID or address field. |
value | string | The field value used for searching the user. |
appID | string | The ID of the application. |
Content-Type application/vnd.kii.GroupNotFoundException+json
Name | Type | Description |
---|---|---|
errorCode | string | Error code "GROUP_NOT_FOUND". |
message | string | The error message. |
groupID | string | The groupID of the group. |
appID | string | The ID of the application. |
Content-Type application/vnd.kii.FilterNotFoundException+json
Name | Type | Description |
---|---|---|
errorCode | string | Error code "FILTER_NOT_FOUND". |
message | string | The error message. |
Content-Type application/vnd.kii.PushSubscriptionNotFoundException+json
Name | Type | Description |
---|---|---|
errorCode | string | Error code "PUSH_SUBSCRIPTION_NOT_FOUND". |
message | string | The error message. |
topicID | string | The ID of the topic where the subscription is not found |
objectScope | ObjectScope | The scope of the topic |
appID | string | The ID of the application. |
userID | string | The ID of the user. Only provided for a user-scope bucket. |
groupID | string | The ID of the group. Only provided for a group-scope bucket. |
thingID | string | The ID of the thing. Only provided for a thing-scope bucket. |
type | string | One of "APP", "APP_AND_USER", "APP_AND_GROUP", or "APP_AND_THING". |
subject | string | The subject that is not subscribed to the topic/filter |
Content-Type application/vnd.kii.UnauthorizedAccessException+json
Name | Type | Description |
---|---|---|
errorCode | string | Error code "UNAUTHORIZED". |
message | string | The error message. |
authenticatedAppID | string | The authenticated appID. |
authenticatedPrincipalID | string | The authenticated principal ID (userID or thingID). |
DELETE
/api/apps/{appID}/groups/{groupID}/buckets/{bucketID}/filters/{filterID}/push/subscriptions/users/{userID}
Unsubscribe this user from the current filter.
Can be performed by the administrator and the user to unsubscribe himself.
Content-Type (None)
Content-Type application/vnd.kii.FilterNotFoundException+json
Name | Type | Description |
---|---|---|
errorCode | string | Error code "FILTER_NOT_FOUND". |
message | string | The error message. |
Content-Type application/vnd.kii.UserNotFoundException+json
Name | Type | Description |
---|---|---|
errorCode | string | Error code "USER_NOT_FOUND". |
message | string | The error message. |
field | string | The field used for searching the user. This can be the userID or address field. |
value | string | The field value used for searching the user. |
appID | string | The ID of the application. |
Content-Type application/vnd.kii.GroupNotFoundException+json
Name | Type | Description |
---|---|---|
errorCode | string | Error code "GROUP_NOT_FOUND". |
message | string | The error message. |
groupID | string | The groupID of the group. |
appID | string | The ID of the application. |
Content-Type application/vnd.kii.PushSubscriptionNotFoundException+json
Name | Type | Description |
---|---|---|
errorCode | string | Error code "PUSH_SUBSCRIPTION_NOT_FOUND". |
message | string | The error message. |
topicID | string | The ID of the topic where the subscription is not found |
objectScope | ObjectScope | The scope of the topic |
appID | string | The ID of the application. |
userID | string | The ID of the user. Only provided for a user-scope bucket. |
groupID | string | The ID of the group. Only provided for a group-scope bucket. |
thingID | string | The ID of the thing. Only provided for a thing-scope bucket. |
type | string | One of "APP", "APP_AND_USER", "APP_AND_GROUP", or "APP_AND_THING". |
subject | string | The subject that is not subscribed to the topic/filter |
Content-Type application/vnd.kii.UnauthorizedAccessException+json
Name | Type | Description |
---|---|---|
errorCode | string | Error code "UNAUTHORIZED". |
message | string | The error message. |
authenticatedAppID | string | The authenticated appID. |
authenticatedPrincipalID | string | The authenticated principal ID (userID or thingID). |