Kantata Kantata OX Knowledge Base
Release Notes
Kantata OX Release Notes API Breaking Changes
Status Page
Kantata OX API Documentation

Access Group Memberships

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

Fetching a list of Access Group Memberships

Returns all access group memberships. The non-editable "Account Administrators" group is excluded from the response.

This endpoint returns structured 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 access_group_memberships top-level JSON key. Please see our Response Format section for more information.

Request
query Parameters
access_group_id
integer <int32>

Returns only access group memberships for a specified access group.

include
string

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

  • access_group (AccessGroup) - References the associated access group.
  • 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.

page
integer <int32>
Default: 1
per_page
integer <int32> <= 200
Default: 20
user_id
integer <int32>

Returns only access group memberships for a specified user.

Responses
200

A list of 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/access_group_memberships
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "access_group_memberships": {
    },
  • "users": {
    }
}
Creating a new Access Group Membership
Adds a user to an access group. Note: To add a user to the Account Administrators access group, you must update
the user's account membership permission instead.


This endpoint returns structured 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 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.


    

  • access_group (AccessGroup) - References the associated access group.
    • 

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



 
Request Body schema: application/json
required
object
 
access_group_id
required
integer <int32> 
The ID of the access group to add the user to.


 
user_id
required
integer <int32> 
The ID of the user to add to the access group.


 
Responses 
200
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/access_group_memberships
Request samples 
application/json
{
  • "access_group_membership": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "access_group_memberships": {
    },
  • "users": {
    }
}
Fetching a single Access Group Membership
This endpoint returns structured 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 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.


    

  • access_group (AccessGroup) - References the associated access group.
    • 

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



 
Responses 
200
The 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/access_group_memberships/{id}
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "access_group_memberships": {
    },
  • "users": {
    }
}
Deleting an existing Access Group Membership
Deletes the specified access group membership (i.e. removes the user from the access group). Note: To remove a user
from the Account Administrators access group, you must update the user's account membership permission instead.


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
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/access_group_memberships/{id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
➔ Next to Account Colors