Removes the permission from the user. | Dependency-Track unofficial

2 parameters

usernamestringrequired

A valid username

permissionstringrequired

A valid permission

4 status codes

200The updated user

emailstringoptional

permissionsarray<object>optional

teamsarray<object>optional

usernamestringrequired

304The user already has the specified permission assigned

401Unauthorized

404The user could not be found

Error handling

A 401 is returned: Unauthorized. A 404 is returned: The user could not be found.

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.user.delete({
  permission: "example",
  username: "octocat",
});

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

Request

Response

Errors