Location
/api/apps/{appID}/users/{userID}/topics/{topicID}/push/subscriptions/users
This resource represents the collection of users
subscribed to the current topic.
Request Headers (Applies to all methods)
Authorization
header
Required: Yes
POST
/api/apps/{appID}/users/{userID}/topics/{topicID}/push/subscriptions/users
Description
Subscribe the current authenticated user to the topic.
Security
Can be performed only with user credentials.
Note
This request requires empty body.
Name
Required?
type
Description
Authorization
Yes
string
Authorization header. OAuth2 Bearer token
Responses
204
Content-Type (None)
The user has been subscribed successfully to the topic.
Note
This response has no contents.
404
Content-Type application/vnd.kii.UserNotFoundException+json
The user was not found.
Contents
| 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. |
404
Content-Type application/vnd.kii.TopicNotFoundException+json
The topic was not found.
Contents
| Name | Type | Description |
|---|---|---|
| errorCode | string | Error code "TOPIC_NOT_FOUND". |
| message | string | The error message. |
| topicID | string | The ID of the topic that 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". |
409
Content-Type application/vnd.kii.PushSubscriptionAlreadyExistsException+json
The user was already subscribed to the topic.
Contents
| 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 |
401
Content-Type application/vnd.kii.UnauthorizedAccessException+json
Not authorized to access this method.
Contents
| 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). |