Users

Users represent clients accessing the Qlik Cloud tenant.

Published when a new user is created.

Payload

object

sourcestring

The source of the event.

default = "com.qlik/identities"
eventIDstring

Unique identifier for the event.
eventTimestring

Timestamp of when the event happened.

format = "date-time"
contentTypestring

The content type of the event payload.

default = "application/json"
eventTypeVersionstring

Version of the event in semantic version format.

default = "1.0.0"
cloudEventsVersionstring

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

Can be one of: "0.1"
eventTypestring

Unique identifier for the event type.

default = "com.qlik.v1.user.created"
extensionsobject
Show extensions properties
- userIdstring
  
  Unique identifier for the user triggering the event.
- tenantIdstring
  Required
  
  Unique identifier for the tenant related to the event.
dataobject
One of:
- Userobject
  Show User properties
  
  idstring
  Required
  
  The unique user identifier.
  
  format = "uid"
  
  namestring
  Required
  
  The name of the user.
  
  emailstring
  
  The email address for the user.
  
  groupsarray of strings
  
  Users assigned idp group references.
  
  localestring
  
  Represents the end-user's language tag.
  
  statusstring
  
  The status of the user within the tenant.
  
  Can be one of: "active""invited""disabled""deleted"
  
  picturestring
  
  A static url linking to the avatar of the user.
  
  format = "url"
  
  subjectstring
  Required
  
  The unique user identitier from an identity provider.
  
  tenantIdstring
  Required
  
  The tenant that the user belongs too.
  
  format = "uid"
  
  zoneinfostring
  
  Represents the end-user's time zone.
  
  createdAtstring
  
  The timestamp for when the user record was created.
  
  format = "date"
  
  inviteExpirynumber
  
  The number of seconds until the user invitation will expire.
  
  assignedRolesarray of objects
  
  represents a role entity stored in the database
  
  Show assignedRoles properties
  
  idstring
  Required
  
  The unique role identitier
  
  format = "uid"
  
  namestring
  Required
  
  The role name
  
  typestring
  Required
  
  The type of role
  
  Can be one of: "default""custom"
  
  levelstring
  Required
  
  The role level
  
  Can be one of: "admin""user"
  
  lastUpdatedAtstring
  
  The timestamp for when the user record was last updated.
  
  format = "date"
  
  assignedGroupsarray of objects
  
  represents a group entity stored in the database
  
  Show assignedGroups properties
  
  idstring
  Required
  
  The unique group identitier
  
  format = "uid"
  
  namestring
  Required
  
  The group name
  
  assignedRolesarray of objects
  
  represents a role entity stored in the database
  
  Show assignedRoles properties
  
  idstring
  Required
  
  The unique role identitier
  
  format = "uid"
  
  namestring
  Required
  
  The role name
  
  typestring
  Required
  
  The type of role
  
  Can be one of: "default""custom"
  
  levelstring
  Required
  
  The role level
  
  Can be one of: "admin""user"
  
  preferredLocalestring
  
  Represents the end-user's preferred language tag.
  
  preferredZoneinfostring
  
  Represents the end-user's preferred time zone.
- BotUserobject
  Show BotUser properties
  
  idstring
  Required
  
  The unique bot user identifier.
  
  format = "uid"
  
  namestring
  Required
  
  The name of the bot user.
  
  groupsarray of strings
  
  Group names associated to the bot user.
  
  statusstring
  
  The status of the bot user within the tenant.
  
  Can be one of: "active""disabled""deleted"
  
  subjectstring
  Required
  
  The unique bot user identifier which incorporates the client ID.
  
  clientIdstring
  Required
  
  The OAuth client ID that the bot user belongs to.
  
  tenantIdstring
  Required
  
  The tenant that the bot user belongs too.
  
  format = "uid"
  
  createdAtstring
  
  The timestamp for when the bot user record was created.
  
  format = "date"
  
  assignedRolesarray of objects
  
  represents a role entity stored in the database
  
  Show assignedRoles properties
  
  idstring
  Required
  
  The unique role identitier
  
  format = "uid"
  
  namestring
  Required
  
  The role name
  
  typestring
  Required
  
  The type of role
  
  Can be one of: "default""custom"
  
  levelstring
  Required
  
  The role level
  
  Can be one of: "admin""user"
  
  lastUpdatedAtstring
  
  The timestamp for when the bot user record was last updated.
  
  format = "date"
  
  assignedGroupsarray of objects
  
  represents a group entity stored in the database
  
  Show assignedGroups properties
  
  idstring
  Required
  
  The unique group identitier
  
  format = "uid"
  
  namestring
  Required
  
  The group name
  
  assignedRolesarray of objects
  
  represents a role entity stored in the database
  
  Show assignedRoles properties
  
  idstring
  Required
  
  The unique role identitier
  
  format = "uid"
  
  namestring
  Required
  
  The role name
  
  typestring
  Required
  
  The type of role
  
  Can be one of: "default""custom"
  
  levelstring
  Required
  
  The role level
  
  Can be one of: "admin""user"

com.qlik.v1.user.created

Example payload of the "User created" event

{
  "source": "com.qlik/identities",
  "eventID": "d585448c-dfed-42bd-a5bc-e60f90bf",
  "eventTime": "2018-10-30T07:06:22Z",
  "contentType": "application/json",
  "eventTypeVersion": "1.0.0",
  "cloudEventsVersion": "0.1",
  "eventType": "com.qlik.v1.user.created",
  "extensions": {
    "userId": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
    "tenantId": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT"
  },
  "data": {
    "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
    "name": "string",
    "email": "string",
    "groups": [
      "group1",
      "group2"
    ],
    "locale": "string",
    "status": "active",
    "picture": "http://example.com",
    "subject": "string",
    "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
    "zoneinfo": "string",
    "createdAt": "string",
    "inviteExpiry": 42,
    "assignedRoles": [
      {
        "id": "507f191e810c19729de860ea",
        "name": "Developer",
        "type": "default",
        "level": "admin"
      }
    ],
    "lastUpdatedAt": "string",
    "assignedGroups": [
      {
        "id": "507f191e810c19729de860ea",
        "name": "Finance",
        "assignedRoles": [
          {
            "id": "507f191e810c19729de860ea",
            "name": "Developer",
            "type": "default",
            "level": "admin"
          }
        ]
      }
    ],
    "preferredLocale": "string",
    "preferredZoneinfo": "string"
  }
}

Published when a user is deleted.

Payload

object

sourcestring

The source of the event.

default = "com.qlik/identities"
eventIDstring

Unique identifier for the event.
eventTimestring

Timestamp of when the event happened.

format = "date-time"
contentTypestring

The content type of the event payload.

default = "application/json"
eventTypeVersionstring

Version of the event in semantic version format.

default = "1.0.0"
cloudEventsVersionstring

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

Can be one of: "0.1"
eventTypestring

Unique identifier for the event type.

default = "com.qlik.v1.user.deleted"
extensionsobject
Show extensions properties
- userIdstring
  
  Unique identifier for the user triggering the event.
- tenantIdstring
  Required
  
  Unique identifier for the tenant related to the event.
dataobject
One of:
- Userobject
  Show User properties
  
  idstring
  Required
  
  The unique user identifier.
  
  format = "uid"
  
  namestring
  Required
  
  The name of the user.
  
  emailstring
  
  The email address for the user.
  
  groupsarray of strings
  
  Users assigned idp group references.
  
  localestring
  
  Represents the end-user's language tag.
  
  statusstring
  
  The status of the user within the tenant.
  
  Can be one of: "active""invited""disabled""deleted"
  
  picturestring
  
  A static url linking to the avatar of the user.
  
  format = "url"
  
  subjectstring
  Required
  
  The unique user identitier from an identity provider.
  
  tenantIdstring
  Required
  
  The tenant that the user belongs too.
  
  format = "uid"
  
  zoneinfostring
  
  Represents the end-user's time zone.
  
  createdAtstring
  
  The timestamp for when the user record was created.
  
  format = "date"
  
  inviteExpirynumber
  
  The number of seconds until the user invitation will expire.
  
  assignedRolesarray of objects
  
  represents a role entity stored in the database
  
  Show assignedRoles properties
  
  idstring
  Required
  
  The unique role identitier
  
  format = "uid"
  
  namestring
  Required
  
  The role name
  
  typestring
  Required
  
  The type of role
  
  Can be one of: "default""custom"
  
  levelstring
  Required
  
  The role level
  
  Can be one of: "admin""user"
  
  lastUpdatedAtstring
  
  The timestamp for when the user record was last updated.
  
  format = "date"
  
  assignedGroupsarray of objects
  
  represents a group entity stored in the database
  
  Show assignedGroups properties
  
  idstring
  Required
  
  The unique group identitier
  
  format = "uid"
  
  namestring
  Required
  
  The group name
  
  assignedRolesarray of objects
  
  represents a role entity stored in the database
  
  Show assignedRoles properties
  
  idstring
  Required
  
  The unique role identitier
  
  format = "uid"
  
  namestring
  Required
  
  The role name
  
  typestring
  Required
  
  The type of role
  
  Can be one of: "default""custom"
  
  levelstring
  Required
  
  The role level
  
  Can be one of: "admin""user"
  
  preferredLocalestring
  
  Represents the end-user's preferred language tag.
  
  preferredZoneinfostring
  
  Represents the end-user's preferred time zone.
- BotUserobject
  Show BotUser properties
  
  idstring
  Required
  
  The unique bot user identifier.
  
  format = "uid"
  
  namestring
  Required
  
  The name of the bot user.
  
  groupsarray of strings
  
  Group names associated to the bot user.
  
  statusstring
  
  The status of the bot user within the tenant.
  
  Can be one of: "active""disabled""deleted"
  
  subjectstring
  Required
  
  The unique bot user identifier which incorporates the client ID.
  
  clientIdstring
  Required
  
  The OAuth client ID that the bot user belongs to.
  
  tenantIdstring
  Required
  
  The tenant that the bot user belongs too.
  
  format = "uid"
  
  createdAtstring
  
  The timestamp for when the bot user record was created.
  
  format = "date"
  
  assignedRolesarray of objects
  
  represents a role entity stored in the database
  
  Show assignedRoles properties
  
  idstring
  Required
  
  The unique role identitier
  
  format = "uid"
  
  namestring
  Required
  
  The role name
  
  typestring
  Required
  
  The type of role
  
  Can be one of: "default""custom"
  
  levelstring
  Required
  
  The role level
  
  Can be one of: "admin""user"
  
  lastUpdatedAtstring
  
  The timestamp for when the bot user record was last updated.
  
  format = "date"
  
  assignedGroupsarray of objects
  
  represents a group entity stored in the database
  
  Show assignedGroups properties
  
  idstring
  Required
  
  The unique group identitier
  
  format = "uid"
  
  namestring
  Required
  
  The group name
  
  assignedRolesarray of objects
  
  represents a role entity stored in the database
  
  Show assignedRoles properties
  
  idstring
  Required
  
  The unique role identitier
  
  format = "uid"
  
  namestring
  Required
  
  The role name
  
  typestring
  Required
  
  The type of role
  
  Can be one of: "default""custom"
  
  levelstring
  Required
  
  The role level
  
  Can be one of: "admin""user"

com.qlik.v1.user.deleted

Example payload of the "User deleted" event

{
  "source": "com.qlik/identities",
  "eventID": "d585448c-dfed-42bd-a5bc-e60f90bf",
  "eventTime": "2018-10-30T07:06:22Z",
  "contentType": "application/json",
  "eventTypeVersion": "1.0.0",
  "cloudEventsVersion": "0.1",
  "eventType": "com.qlik.v1.user.deleted",
  "extensions": {
    "userId": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT",
    "tenantId": "VZhiEfgW2bLd7HgR-jjzAh6VnicipweT"
  },
  "data": {
    "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
    "name": "string",
    "email": "string",
    "groups": [
      "group1",
      "group2"
    ],
    "locale": "string",
    "status": "active",
    "picture": "http://example.com",
    "subject": "string",
    "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
    "zoneinfo": "string",
    "createdAt": "string",
    "inviteExpiry": 42,
    "assignedRoles": [
      {
        "id": "507f191e810c19729de860ea",
        "name": "Developer",
        "type": "default",
        "level": "admin"
      }
    ],
    "lastUpdatedAt": "string",
    "assignedGroups": [
      {
        "id": "507f191e810c19729de860ea",
        "name": "Finance",
        "assignedRoles": [
          {
            "id": "507f191e810c19729de860ea",
            "name": "Developer",
            "type": "default",
            "level": "admin"
          }
        ]
      }
    ],
    "preferredLocale": "string",
    "preferredZoneinfo": "string"
  }
}