Register a user to topic

This endpoint is used to register a user to topic.

URL

https://{{HOST}}/udp/register

Method

POST

Required IMS Scopes

  • apollo_admin

Request Header Parameters

Type Value Description
Content-Type
required		 application/json Content Type
Authentication
required		 Bearer {access_token} IMS access token

Request Body Parameters

Name Description Type
userId
required		 user id String
principle
required		 App, User or Device String
userRelation
required		 list of type of relation between topic and user String
topicRelation
required		 relation type String
topicName
required		 topic name to which relation is created String

Example

Request

curl -X POST 
  'https://{{HOST}}/udp/register' 
  -H 'Authorization: Bearer {access_token}' 
  -H 'Content-Type: application/json' 
  -d '{
    "userId":"Apollo.testUser1",
    "principle": "User",
    "userRelation": [
        {
            "topicRelation": "subscriber",
            "topicName": "temperature"
        },
        {
            "topicRelation": "publisher",
            "topicName": "temperature"
        }
    ]
}'

Response

{
    "status": "Success",
    "message": "User Registered Successfully"
}

Errors

Code Description
400 The request could not be understood by the server due to malformed syntax.
422 Invalid input
403 The request can not be processed if token is not valid or expired.
500 Any other error e.g. DB operation failed

Response Body Parameters

Name Description Schema
message completed or bad request message String
status success String