Returns a list of all LDAP users | Dependency-Track unofficial

2 status codes

200A list of all LDAP users

dnstringoptional

emailstringoptional

permissionsarray<object>optional

teamsarray<object>optional

usernamestringrequired

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.ldap.list();

[
  {
    "dn": "example_value",
    "email": "user@example.com",
    "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"
          }
        ]
      }
    ],
    "teams": [
      {
        "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": [
              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"
          }
        ],
        "mappedLdapGroups": [
          {
            "dn": "example_value",
            "uuid": "550e8400-e29b-41d4-a716-446655440000"
          }
        ],
        "mappedOidcGroups": [
          {
            "group": {
              "name": null,
              "uuid": null
            },
            "uuid": "550e8400-e29b-41d4-a716-446655440000"
          }
        ],
        "name": "Example Name",
        "oidcUsers": [
          {
            "email": "user@example.com",
            "permissions": [
              null
            ],
            "subjectIdentifier": "example_value",
            "teams": [
              null
            ],
            "username": "janedoe"
          }
        ],
        "permissions": [
          {
            "description": "Example description",
            "ldapUsers": [
              null
            ],
            "managedUsers": [
              null
            ],
            "name": "Example Name",
            "oidcUsers": [
              null
            ]
          }
        ],
        "serviceAccounts": [
          {
            "email": "user@example.com",
            "permissions": [
              null
            ],
            "suspended": true,
            "teams": [
              null
            ],
            "username": "janedoe"
          }
        ],
        "uuid": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "username": "janedoe"
  }
]

Response

Errors