Users

Users is the resource that represents a user in the platform.

User created (com.qlik.v1.user.created)

experimental

The user created event will be published when a new user is created.

Payload

cloudEventsVersion
string

The event is compatible with the CloudEvents specification v0.1.

Enum:

0.1

eventTypeVersion
default='1.0.0'
string

Version of the event in semantic version format.

source
default='com.qlik/users'
string

The source of the event.

contentType
default='application/json'
string

The content type of the event payload.

eventId
string

Unique identifier for the event.

eventTime
string<date-time>

Timestamp of when the event happened.

eventType
default='com.qlik.v1.user.created'
string

Unique identifier for the event type.

extensions

No description

data

No description

Example

{
  "cloudEventsVersion": "0.1",
  "eventTypeVersion": "1.0.0",
  "source": "com.qlik/users",
  "contentType": "application/json",
  "eventId": "id123",
  "eventTime": "2018-10-30T07:06:22Z",
  "eventType": "com.qlik.v1.user.created",
  "extensions": {
    "description": "User created",
    "tenantId": "id123",
    "userId": "id123"
  },
  "data": {
    "id": "string",
    "tenantId": "string",
    "subject": "string"
  }
}

User deleted (com.qlik.v1.user.deleted)

The user deleted event will be published when an user is deleted.

Payload

cloudEventsVersion
string

The event is compatible with the CloudEvents specification v0.1.

Enum:

0.1

eventTypeVersion
default='1.0.0'
string

Version of the event in semantic version format.

source
default='com.qlik/users'
string

The source of the event.

contentType
default='application/json'
string

The content type of the event payload.

eventId
string

Unique identifier for the event.

eventTime
string<date-time>

Timestamp of when the event happened.

eventType
default='com.qlik.v1.user.deleted'
string

Unique identifier for the event type.

extensions

No description

data

No description

Example

{
  "cloudEventsVersion": "0.1",
  "eventTypeVersion": "1.0.0",
  "source": "com.qlik/users",
  "contentType": "application/json",
  "eventId": "id123",
  "eventTime": "2018-10-30T07:06:22Z",
  "eventType": "com.qlik.v1.user.deleted",
  "extensions": {
    "description": "User created",
    "tenantId": "id123",
    "userId": "id123"
  },
  "data": {
    "id": "string",
    "tenantId": "string",
    "subject": "string"
  }
}

cloudEvents

object

Properties

cloudEventsVersion
optional
string

The event is compatible with the CloudEvents specification v0.1.

Enum:

0.1

eventTypeVersion
optional, default='1.0.0'
string

Version of the event in semantic version format.

source
optional, default='com.qlik/users'
string

The source of the event.

contentType
optional, default='application/json'
string

The content type of the event payload.

eventId
optional
string

Unique identifier for the event.

eventTime
optional
string<date-time>

Timestamp of when the event happened.

extensionObject

object

Properties

description
optional
string

Plain text description of the action.

tenantId
optional
string

Unique identifier for the tenant related to the event.

userId
optional
string

Unique identifer for the user related to the event.

userCreated

experimental

The user created event will be published when a new user is created.

Payload

eventType
default='com.qlik.v1.user.created'
string

Unique identifier for the event type.

extensions

No description

data

No description

userDeleted

The user deleted event will be published when an user is deleted.

Payload

eventType
default='com.qlik.v1.user.deleted'
string

Unique identifier for the event type.

extensions

No description

data

No description

v1.0.0
Was this page helpful?