Groups
Was this helpful?
Was this helpful?
Get a user group by their ID.
The ID of the group to retrieve.
3131f219-16bb-4c95-853a-894ae12db42aGET /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 a group by their ID.
The ID of the group to delete.
3131f219-16bb-4c95-853a-894ae12db42aDELETE /api/v1/auth/group/{id} HTTP/1.1
Host: api.secoda.co
Authorization: Bearer string
Accept: */*
No content
Get a list of user groups in the workspace.
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 a new user group in the workspace.
Indicates the name of the group.
Data StewardsIndicates the icon of the team.
😀Description of the group.
Users responsible for keeping documentation up to date.A list of user IDs that are part of this group.
["33733f42-8ff7-460b-9e20-50a2133d3bb0","c90dedee-40ee-47ec-9c27-96dc3b2ec363"]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
}Use this endpoint to update the Group. Editable fields include the name, description, icon, and users.
The ID of the group to update.
3131f219-16bb-4c95-853a-894ae12db42aIndicates the name of the group.
New GroupPATCH /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
}