Kantata Kantata OX Knowledge Base Release Notes Status Page

Insights Access Group Memberships

Insights Access Groups allow you to manage Insights access for users. An Insights Access Group Membership represents the connection of a user to an Insights Access Group.

Fetching a list of Insights Access Group Memberships

This endpoint returns structured Insights Access Group Membership objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the insights_access_group_memberships top-level JSON key. Please see our Response Format section for more information.

Request
query Parameters
by_access_group_id
integer <int32>

Return only memberships associated with a specified Insights Access Group ID.

by_user_name
string

Return only memberships associated with a specified user name.

include
string

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • user (User) - References the associated user.
only
string

Allows you to request one or more resources directly by ID. Multiple IDs can be supplied in a comma separated list, like GET /api/v1/workspaces.json?only=5,6,7.

optional_fields
Array of strings

Allows you to request one or more optional fields as an array.

Items Enum: "user_name" "account_permission"
order
string
Default: "created_at:desc"

Supply order with the name of a valid sort field for the endpoint and a direction.

Valid values: created_at:asc and created_at:desc.

page
integer <int32>
Default: 1
per_page
integer <int32> <= 200
Default: 20
user_ids
Array of integers <int32>

Return only memberships associated with the specified user IDs.

Responses
200

A list of Insights Access Group Memberships have been retrieved.

Response Schema: application/json
count
integer <int32>
object
Array of objects
object
object
400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/insights_access_group_memberships
Request samples
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "insights_access_group_memberships": {
    },
  • "users": {
    }
}

Creating a new Insights Access Group Membership

Adds a user to an Insights Access Group. Only Account Administrators can add users to Insights Access Groups.

This endpoint returns structured Insights Access Group Membership objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the insights_access_group_memberships top-level JSON key. Please see our Response Format section for more information.

Request
query Parameters
include
string

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • user (User) - References the associated user.
optional_fields
Array of strings

Allows you to request one or more optional fields as an array.

Items Enum: "user_name" "account_permission"
Request Body schema: application/json
object
user_id
required
integer <int32>

The ID of the user to add to the Insights Access Group.

insights_access_group_id
required
integer <int32>

The ID of the Insights Access Group to add the user to.

Responses
200

Insights Access Group Membership has been created.

Response Schema: application/json
count
integer <int32>
object
Array of objects
object
object
400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

post/insights_access_group_memberships
Request samples
application/json
{
  • "insights_access_group_membership": {
    }
}
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "insights_access_group_memberships": {
    },
  • "users": {
    }
}

Fetching a single Insights Access Group Membership

This endpoint returns structured Insights Access Group Membership objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the insights_access_group_memberships top-level JSON key. Please see our Response Format section for more information.

Request
path Parameters
id
required
integer

The ID of the Model.

query Parameters
include
string

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • user (User) - References the associated user.
optional_fields
Array of strings

Allows you to request one or more optional fields as an array.

Items Enum: "user_name" "account_permission"
Responses
200

The Insights Access Group Membership has been retrieved.

Response Schema: application/json
count
integer <int32>
object
Array of objects
object
object
400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/insights_access_group_memberships/{id}
Request samples
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "insights_access_group_memberships": {
    },
  • "users": {
    }
}

Updating an existing Insights Access Group Membership

Only Account Administrators can update Insights Access Group Memberships.

Note: To move a user from one Insights Access Group to another, delete the existing Access Group Membership, then create a new one.

This endpoint returns structured Insights Access Group Membership objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the insights_access_group_memberships top-level JSON key. Please see our Response Format section for more information.

Request
path Parameters
id
required
integer

The ID of the Model.

query Parameters
include
string

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • user (User) - References the associated user.
optional_fields
Array of strings

Allows you to request one or more optional fields as an array.

Items Enum: "user_name" "account_permission"
Request Body schema: application/json
object
can_edit
boolean

Whether the user can create and edit custom Insights dashboards and reports.

Warning: Giving a user can_edit permission gives them access to all account data via Insights.

Note: It may take up to 15 minutes for the system to sync the can_edit field.

Responses
200

Insights Access Group Membership has been updated.

Response Schema: application/json
count
integer <int32>
object
Array of objects
object
object
400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

put/insights_access_group_memberships/{id}
Request samples
application/json
{
  • "insights_access_group_membership": {
    }
}
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "insights_access_group_memberships": {
    },
  • "users": {
    }
}

Deleting an existing Insights Access Group Membership

Removes a user from an Insights Access Group. Only Account Administrators can delete Insights Access Group Memberships.

The response will contain no content and an HTTP 204 status code if the request was successful, or a standard Kantata OX error message explaining why the object could not be deleted.

Request
path Parameters
id
required
integer

The ID of the Model.

Responses
204

Insights Access Group Membership has been deleted.

400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

delete/insights_access_group_memberships/{id}
Request samples
Response samples
application/json
{
  • "errors": [
    ]
}