Get Started

Groups

Groups within the workspace. Learn more about group management here.

List Groups

get

Get a list of user groups in the workspace.

Authorizations
Responses
200
List of groups.
application/json
Responseall of
get
GET /api/v1/auth/group HTTP/1.1
Host: api.secoda.co
Authorization: Bearer string
Accept: */*

{
  "links": {
    "next": "https://api.secoda.co/resource/all/?page=2",
    "previous": "None"
  },
  "meta": {
    "page": 1,
    "previous_page": "None",
    "next_page": 2
  },
  "count": 315,
  "total_pages": 7,
  "results": [
    {
      "id": "f3bdd4f8-d6ea-4f9b-8384-e179fa8eb3da",
      "created_at": "2023-05-10T14:27:23.797657Z",
      "updated_at": "2023-10-20T13:53:06.088248Z",
      "users": [
        "33733f42-8ff7-460b-9e20-50a2133d3bb0",
        "c90dedee-40ee-47ec-9c27-96dc3b2ec363"
      ],
      "name": "Data Stewards",
      "icon": "🧪",
      "description": "Group of users that are responsible for keeping documentation updated.",
      "workspace_id": "f71585fa-251c-4102-8d81-c97c57c8d435",
      "snowflake_role": null
    }
  ]
}

Create Group

post

Create a new user group in the workspace.

Authorizations
Body
namestringOptional

Indicates the name of the group.

Example: Data Stewards
iconstringOptional

Indicates the icon of the team.

Example: 😀
descriptionstringOptional

Description of the group.

Example: Users responsible for keeping documentation up to date.
usersstring[]Optional

A list of user IDs that are part of this group.

Example: ["33733f42-8ff7-460b-9e20-50a2133d3bb0","c90dedee-40ee-47ec-9c27-96dc3b2ec363"]
Responses
201
Created
application/json
post
POST /api/v1/auth/group HTTP/1.1
Host: api.secoda.co
Authorization: Bearer string
Content-Type: application/json
Accept: */*
Content-Length: 198

{
  "name": "Data Stewards",
  "icon": "😀",
  "description": "Users responsible for keeping documentation up to date.",
  "users": [
    "33733f42-8ff7-460b-9e20-50a2133d3bb0",
    "c90dedee-40ee-47ec-9c27-96dc3b2ec363"
  ]
}
{
  "id": "f3bdd4f8-d6ea-4f9b-8384-e179fa8eb3da",
  "created_at": "2023-05-10T14:27:23.797657Z",
  "updated_at": "2023-10-20T13:53:06.088248Z",
  "users": [
    "33733f42-8ff7-460b-9e20-50a2133d3bb0",
    "c90dedee-40ee-47ec-9c27-96dc3b2ec363"
  ],
  "name": "Data Stewards",
  "icon": "🧪",
  "description": "Group of users that are responsible for keeping documentation updated.",
  "workspace_id": "f71585fa-251c-4102-8d81-c97c57c8d435",
  "snowflake_role": null
}

Get Group

get

Get a user group by their ID.

Authorizations
Path parameters
idstringRequired

The ID of the group to retrieve.

Example: 3131f219-16bb-4c95-853a-894ae12db42a
Responses
200
OK
application/json
get
GET /api/v1/auth/group/{id} HTTP/1.1
Host: api.secoda.co
Authorization: Bearer string
Accept: */*

{
  "id": "f3bdd4f8-d6ea-4f9b-8384-e179fa8eb3da",
  "created_at": "2023-05-10T14:27:23.797657Z",
  "updated_at": "2023-10-20T13:53:06.088248Z",
  "users": [
    "33733f42-8ff7-460b-9e20-50a2133d3bb0",
    "c90dedee-40ee-47ec-9c27-96dc3b2ec363"
  ],
  "name": "Data Stewards",
  "icon": "🧪",
  "description": "Group of users that are responsible for keeping documentation updated.",
  "workspace_id": "f71585fa-251c-4102-8d81-c97c57c8d435",
  "snowflake_role": null
}

Delete Group

delete

Delete a group by their ID.

Authorizations
Path parameters
idstringRequired

The ID of the group to delete.

Example: 3131f219-16bb-4c95-853a-894ae12db42a
Responses
204
No Content
delete
DELETE /api/v1/auth/group/{id} HTTP/1.1
Host: api.secoda.co
Authorization: Bearer string
Accept: */*

No content

Update Group

patch

Use this endpoint to update the Group. Editable fields include the name, description, icon, and users.

Authorizations
Path parameters
idstringRequired

The ID of the group to update.

Example: 3131f219-16bb-4c95-853a-894ae12db42a
Body
namestringOptional

Indicates the name of the group.

Example: New Group
Responses
200
Group updated successfully
application/json
patch
PATCH /api/v1/auth/group/{id} HTTP/1.1
Host: api.secoda.co
Authorization: Bearer string
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "name": "New Group"
}
{
  "id": "f3bdd4f8-d6ea-4f9b-8384-e179fa8eb3da",
  "created_at": "2023-05-10T14:27:23.797657Z",
  "updated_at": "2023-10-20T13:53:06.088248Z",
  "users": [
    "33733f42-8ff7-460b-9e20-50a2133d3bb0",
    "c90dedee-40ee-47ec-9c27-96dc3b2ec363"
  ],
  "name": "Data Stewards",
  "icon": "🧪",
  "description": "Group of users that are responsible for keeping documentation updated.",
  "workspace_id": "f71585fa-251c-4102-8d81-c97c57c8d435",
  "snowflake_role": null
}

Was this helpful?