Returns a list of all teams | Dependency-Track unofficial

6 parameters

pageNumberstringoptional

The page to return. To be used in conjunction with <code>pageSize</code>.

Default:1

pageSizestringoptional

Number of elements to return per page. To be used in conjunction with <code>pageNumber</code>.

Default:100

offsetstringoptional

Offset to start returning elements from. To be used in conjunction with <code>limit</code>.

limitstringoptional

Number of elements to return per page. To be used in conjunction with <code>offset</code>.

sortNamestringoptional

Name of the resource field to sort on.

sortOrderstringoptional

Ordering of items when sorting with <code>sortName</code>.

Allowed:asc, desc

2 status codes

200A list of all teams

apiKeysarray<object>optional

ldapUsersarray<object>optional

managedUsersarray<object>optional

mappedLdapGroupsarray<object>optional

mappedOidcGroupsarray<object>optional

namestringrequired

oidcUsersarray<object>optional

permissionsarray<object>optional

serviceAccountsarray<object>optional

uuidstringrequired

401Unauthorized

Error handling

A 401 is returned: Unauthorized.

import { Client } from "dependency-track-unofficial-sdk";

const client = new Client({
  baseUrl: "http://localhost:8081/api",
  auth: { apiKey: process.env.API_KEY },
});

const result = await client.team.list({
  pageNumber: 1,
  pageSize: 20,
  offset: 0,
  limit: 20,
  sortName: "Untitled",
});

[
  {
    "apiKeys": [
      {
        "comment": "example_value",
        "created": 1,
        "expiresAt": 1,
        "key": "example_key_abc123",
        "lastUsed": 1,
        "legacy": true,
        "maskedKey": "example_key_abc123",
        "publicId": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "ldapUsers": [
      {
        "dn": "example_value",
        "email": "user@example.com",
        "permissions": [
          {
            "description": "Example description",
            "ldapUsers": [
              null
            ],
            "managedUsers": [
              null
            ],
            "name": "Example Name",
            "oidcUsers": [
              null
            ]
          }
        ],
        "teams": [
          {
            "apiKeys": [
              null
            ],
            "ldapUsers": [
              null
            ],
            "managedUsers": [
              null
            ],
            "mappedLdapGroups": [
              null
            ],
            "mappedOidcGroups": [
              null
            ],
            "name": "Example Name",
            "oidcUsers": [
              null
            ],
            "permissions": [
              null
            ],
            "serviceAccounts": [
              null
            ],
            "uuid": "550e8400-e29b-41d4-a716-446655440000"
          }
        ],
        "username": "janedoe"
      }
    ],
    "managedUsers": [
      {
        "confirmPassword": "example_value",
        "email": "user@example.com",
        "forcePasswordChange": true,
        "fullname": "Jane Doe",
        "lastPasswordChange": 1,
        "newPassword": "example_value",
        "nonExpiryPassword": true,
        "permissions": [
          {
            "description": "Example description",
            "ldapUsers": [
              null
            ],
            "managedUsers": [
              null
            ],
            "name": "Example Name",
            "oidcUsers": [
              null
            ]
          }
        ],
        "suspended": true,
        "teams": [
          {
            "apiKeys": [
              null
            ],
            "ldapUsers": [
              null
            ],
            "managedUsers": [
              null
            ],
            "mappedLdapGroups": [
              null
            ],
            "mappedOidcGroups": [
              null
            ],
            "name": "Example Name",
            "oidcUsers": [
              null
            ],
            "permissions": [
              null
            ],
            "serviceAccounts": [
              null
            ],
            "uuid": "550e8400-e29b-41d4-a716-446655440000"
          }
        ],
        "username": "janedoe"
      }
    ],
    "mappedLdapGroups": [
      {
        "dn": "example_value",
        "uuid": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "mappedOidcGroups": [
      {
        "group": {
          "name": "Example Name",
          "uuid": "550e8400-e29b-41d4-a716-446655440000"
        },
        "uuid": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "name": "Example Name",
    "oidcUsers": [
      {
        "email": "user@example.com",
        "permissions": [
          {
            "description": "Example description",
            "ldapUsers": [
              null
            ],
            "managedUsers": [
              null
            ],
            "name": "Example Name",
            "oidcUsers": [
              null
            ]
          }
        ],
        "subjectIdentifier": "example_value",
        "teams": [
          {
            "apiKeys": [
              null
            ],
            "ldapUsers": [
              null
            ],
            "managedUsers": [
              null
            ],
            "mappedLdapGroups": [
              null
            ],
            "mappedOidcGroups": [
              null
            ],
            "name": "Example Name",
            "oidcUsers": [
              null
            ],
            "permissions": [
              null
            ],
            "serviceAccounts": [
              null
            ],
            "uuid": "550e8400-e29b-41d4-a716-446655440000"
          }
        ],
        "username": "janedoe"
      }
    ],
    "permissions": [
      {
        "description": "Example description",
        "ldapUsers": [
          {
            "dn": "example_value",
            "email": "user@example.com",
            "permissions": [
              null
            ],
            "teams": [
              null
            ],
            "username": "janedoe"
          }
        ],
        "managedUsers": [
          {
            "confirmPassword": "example_value",
            "email": "user@example.com",
            "forcePasswordChange": true,
            "fullname": "Jane Doe",
            "lastPasswordChange": 1,
            "newPassword": "example_value",
            "nonExpiryPassword": true,
            "permissions": [
              null
            ],
            "suspended": true,
            "teams": [
              null
            ],
            "username": "janedoe"
          }
        ],
        "name": "Example Name",
        "oidcUsers": [
          {
            "email": "user@example.com",
            "permissions": [
              null
            ],
            "subjectIdentifier": "example_value",
            "teams": [
              null
            ],
            "username": "janedoe"
          }
        ]
      }
    ],
    "serviceAccounts": [
      {
        "email": "user@example.com",
        "permissions": [
          {
            "description": "Example description",
            "ldapUsers": [
              null
            ],
            "managedUsers": [
              null
            ],
            "name": "Example Name",
            "oidcUsers": [
              null
            ]
          }
        ],
        "suspended": true,
        "teams": [
          {
            "apiKeys": [
              null
            ],
            "ldapUsers": [
              null
            ],
            "managedUsers": [
              null
            ],
            "mappedLdapGroups": [
              null
            ],
            "mappedOidcGroups": [
              null
            ],
            "name": "Example Name",
            "oidcUsers": [
              null
            ],
            "permissions": [
              null
            ],
            "serviceAccounts": [
              null
            ],
            "uuid": "550e8400-e29b-41d4-a716-446655440000"
          }
        ],
        "username": "janedoe"
      }
    ],
    "uuid": "550e8400-e29b-41d4-a716-446655440000"
  }
]

Request

Response

Errors