Try for free

Group

The Group API allows you to manage user groups within your Decube organization. Use these endpoints to create groups, add or remove users from groups, retrieve group details, and list all groups. This is essential for managing access control and permissions at scale.

Add User To Group

post

Add user to group.

Body
user_idstringRequired
group_idintegerRequired
Responses
200

Successful Response

application/json
Responseany
post
POST /api/v1/data/acl/group/add_user HTTP/1.1
Host: connect.<REGION>.decube.io
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "user_id": "text",
  "group_id": 1
}
No content

Remove User From Group

post

Remove user from group.

Body
user_idstringRequired
group_idintegerRequired
Responses
200

Successful Response

application/json
Responseany
post
POST /api/v1/data/acl/group/remove_user HTTP/1.1
Host: connect.<REGION>.decube.io
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "user_id": "text",
  "group_id": 1
}
No content

Get Group

get

Fetch group based on group id.

Query parameters
group_idintegerRequired

Id of group

Responses
200

Successful Response

application/json
get
GET /api/v1/data/acl/group?group_id=1 HTTP/1.1
Host: connect.<REGION>.decube.io
Accept: */*

{
  "id": 1,
  "name": "text",
  "description": "text",
  "owner": true,
  "users": [
    "text"
  ],
  "policies": [
    1
  ]
}

List Groups

get

List all groups available in the account.

Query parameters
pageinteger · min: 1OptionalDefault: 1
page_sizeinteger · min: 1 · max: 100OptionalDefault: 10
Responses
200

Successful Response

application/json
get
GET /api/v1/data/acl/group/list HTTP/1.1
Host: connect.<REGION>.decube.io
Accept: */*

[
  {
    "id": 1,
    "name": "text",
    "description": "text",
    "owner": true,
    "users": [
      "text"
    ],
    "policies": [
      1
    ]
  }
]
PreviousACLNextReports

Last updated