Groups

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

List Groups

get

https://api.secoda.cohttps://eapi.secoda.cohttps://aapi.secoda.cohttps://{customer_domain}.secoda.co

/api/v1/auth/group

Get a list of user groups in the workspace.

Authorizations

ApiKeyAuth

Responses

200

List of groups.

application/json

400

Bad Request

500

Internal Server Error

get

/api/v1/auth/group

HTTPcURLJavaScriptPython

GET /api/v1/auth/group HTTP/1.1
Host: api.secoda.co
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

https://api.secoda.cohttps://eapi.secoda.cohttps://aapi.secoda.cohttps://{customer_domain}.secoda.co

/api/v1/auth/group

Create a new user group in the workspace.

Authorizations

ApiKeyAuth

Body

application/json

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

400

Bad Request

500

Internal Server Error

post

/api/v1/auth/group

HTTPcURLJavaScriptPython

POST /api/v1/auth/group HTTP/1.1
Host: api.secoda.co
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

https://api.secoda.cohttps://eapi.secoda.cohttps://aapi.secoda.cohttps://{customer_domain}.secoda.co

/api/v1/auth/group/{id}

Get a user group by their ID.

Authorizations

ApiKeyAuth

Path parameters

idstringRequired

The ID of the group to retrieve.

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

Responses

200

OK

application/json

404

Not Found

500

Internal Server Error

get

/api/v1/auth/group/{id}

HTTPcURLJavaScriptPython

GET /api/v1/auth/group/{id} HTTP/1.1
Host: api.secoda.co
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

https://api.secoda.cohttps://eapi.secoda.cohttps://aapi.secoda.cohttps://{customer_domain}.secoda.co

/api/v1/auth/group/{id}

Delete a group by their ID.

Authorizations

ApiKeyAuth

Path parameters

idstringRequired

The ID of the group to delete.

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

Responses

204

No Content

404

Not Found

500

Internal Server Error

delete

/api/v1/auth/group/{id}

HTTPcURLJavaScriptPython

DELETE /api/v1/auth/group/{id} HTTP/1.1
Host: api.secoda.co
Accept: */*

No content

Update Group

patch

https://api.secoda.cohttps://eapi.secoda.cohttps://aapi.secoda.cohttps://{customer_domain}.secoda.co

/api/v1/auth/group/{id}

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

Authorizations

ApiKeyAuth

Path parameters

idstringRequired

The ID of the group to update.

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

Body

application/json

namestringOptional

Indicates the name of the group.

Example: New Group

Responses

200

Group updated successfully

application/json

400

Bad Request

404

User not found

500

Internal Server Error

patch

/api/v1/auth/group/{id}

HTTPcURLJavaScriptPython

PATCH /api/v1/auth/group/{id} HTTP/1.1
Host: api.secoda.co
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
}