ancoreMate Spaces and Access (Preview)
Control access to Qlik Cloud®: read the tenant, create spaces, add members and change their space roles, share space content, and read users and groups. Qlik®, Qlik Cloud® and Qlik Sense® are trademarks of QlikTech International AB. ancoreMate is not affiliated with or endorsed by Qlik.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | ancoreSoft |
| URL | https://ancorecloud.com/ |
| support@ancoresoft.com |
| Connector Metadata | |
|---|---|
| Publisher | ancoreSoft |
| Website | https://ancorecloud.com/ |
| Privacy policy | https://ancoresoft.com/legal/ancoremate/privacy/ |
| Categories | IT Operations;Productivity |
ancoreMate Spaces and Access
Control access to Qlik Cloud®: read the tenant, create spaces, add members and change their space roles, share space content, and read users and groups.
Qlik®, Qlik Cloud® and Qlik Sense® are trademarks of QlikTech International AB. ancoreMate is not affiliated with or endorsed by Qlik.
Publisher
ancoreSoft
Prerequisites
- An ancoreCloud account with an ancoreMate subscription. See https://ancorecloud.com/ for details and https://docs.ancoresoft.com/ for the documentation.
- A Qlik Cloud user with access to the content you want to automate. No OAuth client, client ID or API key needs to be created in Qlik Cloud.
Supported operations
Add space member
Assigns a user or group to a space with the given roles.
Add space member roles
Adds roles to a user or group in a space and keeps the existing roles; adds the member when needed.
Create or update space
Creates a space, or updates the name and description of an existing space when a space ID is given.
Create space share
Shares an item of a space with a user or group.
Delete space
Deletes a space. The space must be empty.
Delete space share
Removes a share from a space.
Get Qlik connection
Returns whether ancoreMate is connected to a Qlik Cloud tenant, and to which tenant and Qlik user.
Get current user
Returns the Qlik Cloud user ancoreMate is connected with.
Get group
Returns a group of the tenant.
Get space
Returns a space with its settings.
Get space member
Returns one assignment of a user or group to a space.
Get space share
Returns one share of a space.
Get tenant
Returns the name, hostnames and status of the tenant.
Get user
Returns a user of the tenant.
List groups
Lists the groups of the tenant. Use the filter to search, for example name eq "Finance".
List space members
Lists the users and groups assigned to a space with their roles.
List space shares
Lists the items shared directly from a space.
List space types
Lists the types of spaces available in the tenant.
List spaces
Lists the spaces the connected Qlik Cloud user can see.
List users
Lists the users of the tenant. Use the filter to search, for example name co "anna".
Remove space member
Removes a user or group from a space.
Remove space member roles
Removes roles from a user or group in a space; without remaining roles the member is removed from the space.
Send Qlik Cloud request
Calls any REST API of your Qlik Cloud tenant below /api/v1/ with the connected user's rights, for operations that have no action of their own.
Set space member
Gives a user or group exactly the given roles in a space and adds the member when needed.
Update space member
Replaces the roles of a user or group in a space.
Update space share
Changes the roles of a share.
Obtaining credentials
- Create a connection and select Sign in.
- Sign in with your ancoreCloud account.
- The first time, enter your Qlik Cloud tenant, for example
company.eu.qlikcloud.com, sign in at Qlik Cloud and approve the access for ancoreMate. Later sign-ins list the Qlik Cloud connections of your ancoreCloud account: continue with one of them, or add another tenant or Qlik user. Each connection works with the Qlik Cloud connection chosen in its sign-in; the others stay as they are. - If your Qlik Cloud administrators require it, an administrator approves ancoreMate once in the Qlik Cloud administration (Integrations > OAuth).
Getting started
Use Add space member to give a new team member access to a project space, or List spaces with a filter to report which spaces exist and who manages them.
Known issues and limitations
- Changing space members requires the rights to manage the space in Qlik Cloud.
- Only Qlik Cloud tenants are supported; Qlik Sense client-managed (on-premises) deployments are not supported.
- Qlik Cloud rate limits apply. When Qlik Cloud limits requests, the action fails with status 429; the flow's retry policy retries it automatically.
- Each connection works with one Qlik Cloud tenant and Qlik user, chosen in its sign-in. To work with several tenants or Qlik users, for example development and production, create one connection per tenant or user; a flow can use several of them.
Deployment instructions
Use the instructions to deploy a custom connector with the files apiDefinition.swagger.json and apiProperties.json of this folder.
Actions
| Add space member |
Assigns a user or group to a space with the given roles. |
| Add space member roles |
Adds roles to a user or group in a space and keeps the existing roles; adds the member when needed. |
| Create or update space |
Creates a space, or updates the name and description of an existing space when a space ID is given. |
| Create space share |
Shares an item of a space with a user or group. |
| Delete space |
Deletes a space. The space must be empty. |
| Delete space share |
Removes a share from a space. |
| Get current user |
Returns the Qlik Cloud user ancoreMate is connected with. |
| Get group |
Returns a group of the tenant. |
| Get Qlik connection |
Returns whether ancoreMate is connected to a Qlik Cloud tenant, and to which tenant and Qlik user. |
| Get space |
Returns a space with its settings. |
| Get space member |
Returns one assignment of a user or group to a space. |
| Get space share |
Returns one share of a space. |
| Get tenant |
Returns the name, hostnames and status of the tenant. |
| Get user |
Returns a user of the tenant. |
| List groups |
Lists the groups of the tenant. Use the filter to search, for example name eq "Finance". |
| List space members |
Lists the users and groups assigned to a space with their roles. |
| List space shares |
Lists the items shared directly from a space. |
| List space types |
Lists the types of spaces available in the tenant. |
| List spaces |
Lists the spaces the connected Qlik Cloud user can see. |
| List users |
Lists the users of the tenant. Use the filter to search, for example name co "anna". |
| Remove space member |
Removes a user or group from a space. |
| Remove space member roles |
Removes roles from a user or group in a space; without remaining roles the member is removed from the space. |
| Send Qlik Cloud request |
Calls any REST API of your Qlik Cloud tenant below /api/v1/ with the connected user's rights, for operations that have no action of their own. |
| Set space member |
Gives a user or group exactly the given roles in a space and adds the member when needed. |
| Update space member |
Replaces the roles of a user or group in a space. |
| Update space share |
Changes the roles of a share. |
Add space member
Assigns a user or group to a space with the given roles.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Space ID
|
spaceId | True | string |
The ID of the space of the assignment. |
|
Type
|
type | True | string |
The type of assignment such as user or group. |
|
Roles
|
roles | True | array of string |
The roles assigned to the assigneeId. |
|
Assignee ID
|
assigneeId | True | string |
The userId or groupId based on the type. |
Returns
A space member.
- Body
- SpaceMember
Add space member roles
Adds roles to a user or group in a space and keeps the existing roles; adds the member when needed.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Space
|
spaceId | True | string |
The space. |
|
Type
|
type | string |
Whether the member is a user (default) or a group. |
|
|
User or group ID
|
assigneeId | True | string |
The ID of the user or group. |
|
Roles
|
roles | True | array of string |
The roles to add, for example consumer or producer. |
Returns
A space member.
- Body
- SpaceMember
Create or update space
Creates a space, or updates the name and description of an existing space when a space ID is given.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Name
|
name | True | string |
The name of the space. |
|
Type
|
type | True | string |
The type of space such as shared, managed, and so on. |
|
Description
|
description | string |
The description of the space. |
|
|
Space ID
|
spaceId | string |
The space to update. Leave empty to create a new space. |
Returns
A space is a security context simplifying the management of access control by allowing users to control it on the containers instead of on the resources themselves.
- Body
- Space
Create space share
Shares an item of a space with a user or group.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Space ID
|
spaceId | True | string |
The ID of the space of the share. |
|
Type
|
type | True | string |
The type. |
|
Roles
|
roles | True | array of string |
The roles assigned to the assigneeId. |
|
Assignee ID
|
assigneeId | True | string |
The userId or groupId based on the type. |
|
Resource ID
|
resourceId | True | string |
The resource id for the shared item. |
|
Resource Type
|
resourceType | True | string |
The resource type for the shared item. |
Returns
A space share.
- Body
- SpaceShare
Delete space
Deletes a space. The space must be empty.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Space ID
|
spaceId | True | string |
The ID of the space to delete. |
Delete space share
Removes a share from a space.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Share ID
|
shareId | True | string |
The ID of the share to delete. |
|
Space ID
|
spaceId | True | string |
The ID of the space to which the share belongs. |
Get current user
Get group
Returns a group of the tenant.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Group ID
|
groupId | True | string |
The group's unique identifier. |
Returns
Represents a Group document.
- Body
- Group
Get Qlik connection
Returns whether ancoreMate is connected to a Qlik Cloud tenant, and to which tenant and Qlik user.
Returns
The connection between ancoreMate and Qlik Cloud.
- Body
- Connection
Get space
Returns a space with its settings.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Space ID
|
spaceId | True | string |
The ID of the space to retrieve. |
Returns
A space is a security context simplifying the management of access control by allowing users to control it on the containers instead of on the resources themselves.
- Body
- Space
Get space member
Returns one assignment of a user or group to a space.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Assignment ID
|
assignmentId | True | string |
The ID of the assignment to retrieve. |
|
Space ID
|
spaceId | True | string |
The ID of the space of the assignment. |
Returns
A space member.
- Body
- SpaceMember
Get space share
Returns one share of a space.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Share ID
|
shareId | True | string |
The ID of the share to retrieve. |
|
Space ID
|
spaceId | True | string |
The ID of the space to which the share belongs. |
Returns
A space share.
- Body
- SpaceShare
Get tenant
Get user
Returns a user of the tenant.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
User ID
|
userId | True | string |
The user's unique identifier. |
|
Fields
|
fields | string |
A comma-delimited string of the requested fields per entity. |
Returns
A user object.
- Body
- User
List groups
Lists the groups of the tenant. Use the filter to search, for example name eq "Finance".
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Filter
|
filter | string |
The advanced filtering to use for the query. |
|
|
Sort
|
sort | string |
Optional resource field name to sort on, eg. |
|
|
System Groups
|
systemGroups | boolean |
Return system groups (e.g. |
|
|
Limit
|
limit | integer |
The maximum number of items to return, between 1 and 5000. |
Returns
A list of group items.
- Body
- GroupList
List space members
Lists the users and groups assigned to a space with their roles.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Space ID
|
spaceId | True | string |
The ID of the space of the assignment. |
|
Assignee ID
|
assigneeId | string |
Filters assignment for a specific assigneeid. |
|
|
Type
|
type | string |
The type of assignment. |
|
|
Limit
|
limit | integer |
The maximum number of items to return, between 1 and 5000. |
Returns
A list of space member items.
- Body
- SpaceMemberList
List space shares
Lists the items shared directly from a space.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Space ID
|
spaceId | True | string |
The ID of the space containing the shares. |
|
Group ID
|
groupId | string |
The ID of the group to which the resource is shared. |
|
|
Name
|
name | string |
The name of the shared resource. |
|
|
Resource ID
|
resourceId | string |
The ID of the shared resource. |
|
|
Resource Type
|
resourceType | string |
The type of the shared resource. |
|
|
Type
|
type | string |
The type of share. |
|
|
User ID
|
userId | string |
The ID of the user to which the resource is shared. |
|
|
Limit
|
limit | integer |
The maximum number of items to return, between 1 and 5000. |
Returns
A list of space share items.
- Body
- SpaceShareList
List space types
Lists the types of spaces available in the tenant.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
The maximum number of items to return, between 1 and 5000. |
Returns
A list of space items.
- Body
- SpaceTypeItemList
List spaces
Lists the spaces the connected Qlik Cloud user can see.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Action
|
action | string |
Action on space. |
|
|
Name
|
name | string |
Space name to search and filter for. |
|
|
Owner ID
|
ownerId | string |
Space ownerId to filter by. |
|
|
Sort
|
sort | string |
Field to sort by. |
|
|
Type
|
type | string |
Type(s) of space to filter. |
|
|
Limit
|
limit | integer |
The maximum number of items to return, between 1 and 5000. |
Returns
A list of space items.
- Body
- SpaceList
List users
Lists the users of the tenant. Use the filter to search, for example name co "anna".
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Fields
|
fields | string |
A comma-delimited string of the requested fields per entity. |
|
|
Filter
|
filter | string |
The advanced filtering to use for the query. |
|
|
Sort
|
sort | string |
The field to sort by, with +/- prefix indicating sort order. |
|
|
Limit
|
limit | integer |
The maximum number of items to return, between 1 and 5000. |
Returns
A list of user items.
- Body
- UserList
Remove space member
Removes a user or group from a space.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Assignment ID
|
assignmentId | True | string |
The ID of the assignment to delete. |
|
Space ID
|
spaceId | True | string |
The ID of the space of the assignment. |
Remove space member roles
Removes roles from a user or group in a space; without remaining roles the member is removed from the space.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Space
|
spaceId | True | string |
The space. |
|
Type
|
type | string |
Whether the member is a user (default) or a group. |
|
|
User or group ID
|
assigneeId | True | string |
The ID of the user or group. |
|
Roles
|
roles | True | array of string |
The roles to remove, for example producer. |
Returns
A space member.
- Body
- SpaceMember
Send Qlik Cloud request
Calls any REST API of your Qlik Cloud tenant below /api/v1/ with the connected user's rights, for operations that have no action of their own.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Method
|
method | True | string |
The HTTP method. |
|
Path
|
path | True | string |
The path below /api/v1/, for example spaces or apps/1234/reloads/logs. |
|
Query
|
query | string |
Query parameters as in a URL, for example limit=10&name=Sales. |
|
|
Body
|
body | object |
The JSON body for POST, PUT, PATCH and DELETE, for example the IDs of the items to delete. |
Returns
The JSON response of Qlik Cloud, unchanged.
- response
- object
Set space member
Gives a user or group exactly the given roles in a space and adds the member when needed.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Space
|
spaceId | True | string |
The space. |
|
Type
|
type | string |
Whether the member is a user (default) or a group. |
|
|
User or group ID
|
assigneeId | True | string |
The ID of the user or group. |
|
Roles
|
roles | array of string |
The roles, for example consumer, contributor, producer or facilitator. Without roles the member is removed. |
Returns
A space member.
- Body
- SpaceMember
Update space member
Replaces the roles of a user or group in a space.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Assignment ID
|
assignmentId | True | string |
The ID of the assignment to update. |
|
Space ID
|
spaceId | True | string |
The ID of the space of the assignment. |
|
Roles
|
roles | array of string |
The roles assigned to the assigneeId. |
Returns
A space member.
- Body
- SpaceMember
Update space share
Changes the roles of a share.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Share ID
|
shareId | True | string |
The ID of the share to update. |
|
Space ID
|
spaceId | True | string |
The ID of the space to which the share belongs. |
|
Roles
|
roles | True | array of string |
The roles the share grants, for example consumer. |
Returns
A space share.
- Body
- SpaceShare
Definitions
Connection
The connection between ancoreMate and Qlik Cloud.
| Name | Path | Type | Description |
|---|---|---|---|
|
Connected
|
connected | boolean |
Whether ancoreMate is connected to Qlik Cloud. |
|
Qlik Cloud tenant
|
tenantHost | string |
The host name of the connected Qlik Cloud tenant. |
|
Qlik user
|
qlikUserName | string |
The name of the connected Qlik Cloud user. |
|
Connected at
|
connectedAt | date-time |
The time the connection was established. |
Group
Represents a Group document.
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
The unique identifier for the group. |
|
Name
|
name | string |
The name of the group. |
|
Href
|
links.self.href | uri |
Link to the current group document. |
|
Status
|
status | string |
The state of the group. |
|
Tenant ID
|
tenantId | string |
The tenant identifier associated with the given group. |
|
Created At
|
createdAt | date-time |
The timestamp for when the group record was created. |
|
Created By
|
createdBy | string |
Id of user that created role. |
|
Updated By
|
updatedBy | string |
Id of user that last updated this role. |
|
Description
|
description | string |
A description of a custom group. |
|
Provider Type
|
providerType | string |
The type of provider for the group. |
|
Assigned Roles
|
assignedRoles | array of object |
An array of role references. |
|
ID
|
assignedRoles.id | string |
The unique role identitier. |
|
Name
|
assignedRoles.name | string |
The role name. |
|
Type
|
assignedRoles.type | string |
The type of role. |
|
Level
|
assignedRoles.level | string |
The role level. |
|
Last Updated At
|
lastUpdatedAt | date-time |
The timestamp for when the group record was last updated. |
GroupList
A list of group items.
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
value | array of Group |
The items. |
Space
A space is a security context simplifying the management of access control by allowing users to control it on the containers instead of on the resources themselves.
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
A unique identifier for the space, for example, 62716f4b39b865ece543cd45. |
|
Roles
|
meta.roles | array of string |
The list of roles assigned to the current user in this space. |
|
Actions
|
meta.actions | array of string |
The list of actions allowed by the current user in this space. |
|
Assignable Roles
|
meta.assignableRoles | array of string |
The list of roles that could be assigned in this space. |
|
Name
|
name | string |
The name of the space. |
|
Type
|
type | string |
The type of space such as shared, managed, and so on. |
|
Href
|
links.self.href | string |
URL that defines the resource. |
|
Href
|
links.assignments.href | string |
URL that defines the resource. |
|
Owner ID
|
ownerId | string |
The ID for the space owner. |
|
Tenant ID
|
tenantId | string |
The ID for the tenant, for example, xqGQ0k66vSR8f9G7J-vYtHZQkiYrCpct. |
|
Created At
|
createdAt | date-time |
The date and time when the space was created. |
|
Created By
|
createdBy | string |
The ID of the user who created the space. |
|
Updated At
|
updatedAt | date-time |
The date and time when the space was updated. |
|
Description
|
description | string |
The description of the space. |
SpaceList
A list of space items.
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
value | array of Space |
The items. |
SpaceMember
A space member.
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
The id. |
|
Type
|
type | string |
The type of assignment such as user or group. |
|
Href
|
links.self.href | string |
URL that defines the resource. |
|
Href
|
links.space.href | string |
URL that defines the resource. |
|
Roles
|
roles | array of string |
The roles assigned to a user or group. |
|
Space ID
|
spaceId | string |
The unique identifier for the space. |
|
Tenant ID
|
tenantId | string |
The unique identifier for the tenant. |
|
Created At
|
createdAt | date-time |
The date and time when the space was created. |
|
Created By
|
createdBy | string |
The ID of the user who created the assignment. |
|
Updated At
|
updatedAt | date-time |
The date and time when the space was updated. |
|
Updated By
|
updatedBy | string |
The ID of the user who updated the assignment. |
|
Assignee ID
|
assigneeId | string |
The userId or groupId based on the type. |
SpaceMemberList
A list of space member items.
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
value | array of SpaceMember |
The items. |
SpaceShare
A space share.
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
The id. |
|
Type
|
type | string |
The type. |
|
Href
|
links.self.href | string |
URL that defines the resource. |
|
Href
|
links.space.href | string |
URL that defines the resource. |
|
Roles
|
roles | array of string |
The roles assigned to the assigneeId. |
|
Space ID
|
spaceId | string |
The space id. |
|
Disabled
|
disabled | boolean |
If the share is disabled (effective ONLY for link shares). |
|
Tenant ID
|
tenantId | string |
The tenant id. |
|
Created At
|
createdAt | date-time |
The created at. |
|
Created By
|
createdBy | string |
The ID of the user who created the share. |
|
Updated At
|
updatedAt | date-time |
The updated at. |
|
Updated By
|
updatedBy | string |
The ID of the user who updated the share. |
|
Assignee ID
|
assigneeId | string |
The userId or groupId based on the type. |
|
Resource ID
|
resourceId | string |
The ID of the shared resource. |
|
Resource Name
|
resourceName | string |
The name of the shared resource. |
|
Resource Type
|
resourceType | string |
The type of the shared resource. |
SpaceShareList
A list of space share items.
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
value | array of SpaceShare |
The items. |
SpaceTypeItem
SpaceTypeItemList
A list of space items.
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
value | array of SpaceTypeItem |
The items. |
Tenant
A tenant.
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
The unique tenant identifier. |
|
Name
|
name | string |
The display name of the tenant. |
|
Href
|
links.self.href | string |
URL that defines the resource. |
|
Region
|
region | string |
The region where the tenant is located. |
|
Status
|
status | string |
The status of the tenant. |
|
Created
|
created | date |
The timestamp for when the tenant record was created (1970-01-01T00:00:00.001Z for static tenants). |
|
Hostnames
|
hostnames | array of string |
List of case insensitive hostnames that are mapped to the tenant. |
|
Datacenter
|
datacenter | string |
The datacenter where the tenant is located. |
|
Last Updated
|
lastUpdated | date |
The timestamp for when the tenant record was last updated (1970-01-01T00:00:00.001Z for static tenants). |
|
Created By User
|
createdByUser | string |
The user ID who created the tenant. |
|
Status Last Updated At
|
statusLastUpdatedAt | date-time |
The timestamp for when the tenant status was last changed. |
|
Enable Analytic Creation
|
enableAnalyticCreation | boolean |
The enable analytic creation. |
|
Enable App Opening Feedback
|
enableAppOpeningFeedback | boolean |
The enable app opening feedback. |
|
Auto Assign Create Shared Spaces Role To Professionals
|
autoAssignCreateSharedSpacesRoleToProfessionals | boolean |
The auto assign create shared spaces role to professionals. |
|
Auto Assign Data Services Contributor Role To Professionals
|
autoAssignDataServicesContributorRoleToProfessionals | boolean |
The auto assign data services contributor role to professionals. |
|
Auto Assign Private Analytics Content Creator Role To Professionals
|
autoAssignPrivateAnalyticsContentCreatorRoleToProfessionals | boolean |
The auto assign private analytics content creator role to professionals. |
User
A user object.
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
The unique user identifier. |
|
Name
|
name | string |
The name of the user. |
|
Email
|
string |
The email address for the user. |
|
|
Href
|
links.self.href | uri |
URL that defines the resource. |
|
Locale
|
locale | string |
Represents the end-user's language tag. |
|
Status
|
status | string |
The status of the user within the tenant. |
|
Picture
|
picture | string |
A static url linking to the avatar of the user. |
|
Subject
|
subject | string |
The unique user identitier from an identity provider. |
|
Tenant ID
|
tenantId | string |
The tenant that the user belongs too. |
|
Zoneinfo
|
zoneinfo | string |
Represents the end-user's time zone. |
|
Created At
|
createdAt | date-time |
The timestamp for when the user record was created. |
|
Invite Expiry
|
inviteExpiry | number |
The Unix timestamp indicating when the invite will expire. |
|
Assigned Roles
|
assignedRoles | array of object |
An array of role references. |
|
ID
|
assignedRoles.id | string |
The unique role identitier. |
|
Name
|
assignedRoles.name | string |
The role name. |
|
Type
|
assignedRoles.type | string |
The type of role. |
|
Level
|
assignedRoles.level | string |
The role level. |
|
Last Updated At
|
lastUpdatedAt | date-time |
The timestamp for when the user record was last updated. |
|
Assigned Groups
|
assignedGroups | array of object |
An array of group references. |
|
ID
|
assignedGroups.id | string |
The unique group identitier. |
|
Name
|
assignedGroups.name | string |
The group name. |
|
Provider Type
|
assignedGroups.providerType | string |
The provider type of the group. |
|
Assigned Roles
|
assignedGroups.assignedRoles | array of object |
An array of role references. |
|
items
|
assignedGroups.assignedRoles | object |
Represents a role entity stored in the database. |
|
Assigned Scopes
|
assignedScopes | array of string |
An array of scopes assigned to a user. |
|
Preferred Locale
|
preferredLocale | string |
Represents the end-user's preferred language tag. |
|
Preferred Zoneinfo
|
preferredZoneinfo | string |
Represents the end-user's preferred time zone. |
UserList
A list of user items.
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
value | array of User |
The items. |
object
This is the type 'object'.