New: build custom CDF applications with Cognite Flows. Documentation · What's new.
const groups = await client.groups.list({ all: true });{
"items": [
{
"name": "Production Engineers",
"id": 123,
"isDeleted": false,
"capabilities": [
{
"agentsAcl": {
"actions": [
"READ"
],
"scope": {
"all": {}
}
},
"projectUrlNames": {
"urlNames": [
"publicdata"
]
}
}
],
"metadata": {},
"attributes": {
"token": {
"appIds": [
"<string>"
]
}
},
"sourceId": "b7c9a5a4-99c2-4785-bed3-5e6ad9a78603",
"deletedTime": 123
}
]
}Required capabilities:
groupsAcl:LIST
Retrieves a list of groups the asking principal a member of. Principals with groups:list capability can optionally ask for all groups in a project.
const groups = await client.groups.list({ all: true });{
"items": [
{
"name": "Production Engineers",
"id": 123,
"isDeleted": false,
"capabilities": [
{
"agentsAcl": {
"actions": [
"READ"
],
"scope": {
"all": {}
}
},
"projectUrlNames": {
"urlNames": [
"publicdata"
]
}
}
],
"metadata": {},
"attributes": {
"token": {
"appIds": [
"<string>"
]
}
},
"sourceId": "b7c9a5a4-99c2-4785-bed3-5e6ad9a78603",
"deletedTime": 123
}
]
}Documentation Index
Fetch the complete documentation index at: https://docs.cognite.com/llms.txt
Use this file to discover all available pages before exploring further.
Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
Whether to get all groups, only available with the groups:list acl.
A list of groups.
Group membership managed by the external identity provider
Show child attributes
Was this page helpful?