messaging

Manages pubnub auth token granting

Issues a messaging token for requested topics

POSThttp://admin.m2worlds.io/api/messaging/auth/

Authorization

BearerAuth

Body

application/json

worldarray of MessagingAuthTopicPermissionsDemandSchema (object)

Requested topic permissions that are scoped to the world.

requireAllGrants*boolean

Return 403 if the requested permissions could not be granted. If this is false then the request will succeed, but only the permissions the user has will be set.

ttlInMinutes*integer

The required token expiry time in minutes.

Response

2005034XX

Default Response

Body

application/json

userId*string

pubnub*object

worldarray of MessagingAuthTopicPermissionsSchema (object)

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/messaging/auth/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "requireAllGrants": true
    }),
});
const data = await response.json();

Response

{
  "userId": "text",
  "pubnub": {
    "token": "text",
    "publishKey": "text",
    "subscribeKey": "text"
  },
  "world": [
    {
      "topicId": "text",
      "channelId": "text",
      "granted": {
        "read": false,
        "write": false
      }
    }
  ]
}

Service health check

GEThttp://admin.m2worlds.io/api/messaging/healthz

Response

200

Default Response

Body

application/json

statusMessage (string)

Provides information about the service status.

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/messaging/healthz', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

"text"