Identity REST API

Use the Identity API to manage the administrative configuration for your organization in the Veracode Platform.

The API provides endpoints for Administrators to manage users (UI users and API users), teams, and business units using the create, update, read, and delete actions on their respective objects. Use the API credentials endpoint to get information about API credentials expiration, revoke API credentials, or renew your credentials.

For some API requests, you must set your updates as incremental or partial. partial=true indicates that you are updating only a subset of properties for an object. incremental=true indicates that you are adding items to a list for an object property, such as adding users to a team.

Administrators assign roles when creating users or editing users. Users that are members of a team inherit the permissions assigned to that team, limiting their access to team-assigned resources.

note

The Scope column indicates the breadth of access granted by each role:

Organization-wide — Grants access to organizational settings and resources across all teams
Team-level — Grants access only to resources assigned to the user's teams
Workspace-level — Grants access only to resources within a specific Software Composition Analysis (SCA) workspace
Individual — Grants access to user-specific features or settings

API users not assigned to a team have no team restrictions and can access all application profiles across the entire organization. To limit an API user's access to specific teams, assign the user to one or more teams when creating or editing their account.

Permissions

Before you can use all endpoints of this API, you must have one of the following accounts with the required roles:

An API user account with the Admin API role.
A UI user account with the Administrator role.

Users without these roles can access the following endpoints:

/users/self
/users/api_credentials

For detailed information about predefined API roles and their scope (organization-wide or team-level), see API user roles. For information about creating custom API roles with specific permissions, see Custom user roles.

Authentication

This API requires secure authentication to Veracode.

Identity API specification

The Identity API specification is available from SwaggerHub.

Create a UI user

To create a UI user account, send the following request:

http --auth-type=veracode_hmac POST "https://api.veracode.com/api/authn/v2/users" < input.json

The API passes the JSON file that you populate with the necessary values as shown in this example payload:

{
   "email_address":"[email protected]",
   "first_name":"Example",
   "last_name":"User",
   "ip_restricted":false,
   "pin_required": true,
   "active":true,
   "roles":[
      {
         "role_name":"extseclead"
      },
      {
         "role_name":"extsubmitanyscan"
      }
   ],
   "title":"Sample",
   "user_name":"[email protected]",
   "userType":"VOSP",
   "teams":[
      {
         "team_id":"teamId"
      }
   ]
}

note

Creating an account and configuring authentication can take up to one minute to complete.

Roles

The following table lists the predefined user roles.

Role short name	Role name	Scope	Required companion roles	UI user	API user
`deletescans`	Delete Scans	Organization-wide	`extseclead` or `extcreator`	Yes	Yes
`sandboxadmin`	Sandbox Administrator	Organization-wide		Yes	Yes
`sandboxuser`	Sandbox User	Organization-wide		Yes	Yes
`workSpaceAdmin`	Workspace Administrator	Organization-wide		Yes	Yes
`workSpaceEditor`	Workspace Editor	Organization-wide		Yes	Yes
`extseclead`	Security Lead	Team-level	Users must have one or more of the following roles that match the types of scans they want to create and submit: `extsubmitmanualscan` (MPT scan), `extsubmitstaticscan` (SAST scan), `extsubmitdynamicscan` (DAST scan), `extsubmitdynamicanalysis` (DAST analysis), `extsubmitdynamicmpscan` (Dynamic MP scan), `extsubmitanyscan` (Any scan type)	Yes	Yes
`extcreator`	Creator	Team-level	Users must have one or more of the following roles that match the types of scans they want to create and submit: `extsubmitmanualscan`, `extsubmitstaticscan`, `extsubmitdynamicscan`, `extsubmitdynamicanalysis`, `extsubmitanyscan`, `extsubmitdynamicmpscan`	Yes	Yes
`extsubmitter`	Submitter	Team-level	Users must have one or more of the following roles that match the types of scans they want to create and submit: `extsubmitmanualscan`, `extsubmitstaticscan`, `extsubmitdynamicscan`, `extsubmitdynamicanalysis`, `extsubmitanyscan`, `extsubmitdynamicmpscan`	Yes	Yes
`extreviewer`	Reviewer	Team-level		Yes	Yes
`extmitigationapprover`	Mitigation Approver	Team-level		Yes	Yes
`extexecutive`	Executive	Organization-wide		Yes	Yes
`securityinsightsonly`	Security Insights	Team-level		Yes	Yes
`securityLabsUser`	Security Labs User	Team-level		Yes	Yes
`extadmin`	Administrator	Organization-wide	Contact Veracode Technical Support to assign this role to a user.	Yes	Yes
`extpolicyadmin`	Policy Administrator	Organization-wide		Yes	Yes
`extelearn`	eLearning	Organization-wide		Yes	Yes
`teamAdmin`	Team Admin	Team-level		Yes	No
`greenlightideuser`	Greenlight IDE User	Individual		Yes	No
`analyticsCreator`	Analytics Creator	Team-level		Yes	No
`apisubmitanyscan`	API Submit Any Scan	Team-level		No	Yes
`apisubmitstaticscan`	API Submit Static Scan	Team-level		No	Yes
`apisubmitdynamicscan`	API Submit Dynamic Scan	Team-level		No	Yes
`apisubmitdynamicanalysis`	API Submit Dynamic Analysis	Team-level		No	Yes
`mpuploadapi`	Manual Penetration Testing Upload API	Team-level		No	Yes
`submitterapi`	Submitter API	Team-level		No	Yes
`noteamrestrictionapi`	No Team Restriction API	Organization-wide		No	Yes
`discoveryuploadapi`	Discovery Upload API	Team-level		No	Yes
`staticuploadapi`	Static Upload API	Team-level		No	Yes
`cloudatlasadmin`	Cloud Atlas Admin	Organization-wide		No	Yes
`cloudatlascustomeradmin`	Cloud Atlas Customer Admin	Organization-wide		No	Yes
`cloudatlascustomer`	Cloud Atlas Customer	Team-level		No	Yes
`portableScopeResultsApi`	Portable Scope Results API	Team-level		No	Yes
`dassaultadminapi`	Dassault Admin API	Organization-wide		No	Yes
`managedlpapi`	Managed LP API	Team-level		No	Yes
`runasuser`	Run As User	Organization-wide		No	Yes
`archerreports`	Archer Reports	Organization-wide		No	Yes
`resultsapi`	Results API	Team-level		No	Yes
`uploadapi`	Upload API	Team-level		No	Yes
`adminapi`	Admin API	Organization-wide		No	Yes
`mitigationapi`	Mitigation API	Team-level		No	Yes

Create a SAML user

To create a user account with SAML sign-on, send the following request:

http --auth-type=veracode_hmac POST "https://api.veracode.com/api/authn/v2/users" < input.json

The API passes the JSON file that you populate with the necessary values as shown in this example payload:

{
   "email_address":"[email protected]",
   "first_name":"Example",
   "last_name":"User",
   "ip_restricted":false,
   "active":true,
   "roles":[
      {
         "role_name":"extseclead"
      },
      {
         "role_name":"extsubmitanyscan"
      }
   ],
   "title":"Sample",
   "saml_user":true,
   "saml_subject":"[email protected]",
   "user_type":"VOSP"
 }

See the list of roles you can assign to users.

Create an API user

To create an API user account, send the following request:

http --auth-type=veracode_hmac POST "https://api.veracode.com/api/authn/v2/users" < input.json

The API passes the JSON file that you populate with the necessary values as shown in this example payload:

{
   "user_name":"vitunicornidentityapi",
   "first_name":"VITUnicorn",
   "last_name":"IdentityAPI",
   "email_address":"[email protected]",
   "ip_restricted":false,
   "active":true,
   "roles":[
      {
         "role_name":"noteamrestrictionapi"
      },
      {
         "role_name":"apisubmitanyscan"
      },
      {
         "role_name":"uploadapi"
      },
      {
         "role_name":"resultsapi"
      }
   ],
   "permissions":[
      {
         "permission_name":"apiUser"
      }
   ],
   "teams":[
      {
         "team_id":"teamId"
      }
   ]
}

If you want an API user account to have access to all applications, regardless of which team the user is a member, use noteamrestrictionapi.

To restrict scan types for a user with the uploadapi role, use one or more of these additional roles:

apisubmitanyscan
apisubmitstaticscan
apisubmitdynamicscan
apisubmitmanualscan

Custom API roles

In addition to the predefined API roles listed above, you can create custom API roles with specific permissions tailored to your organization's needs. Custom API roles allow you to grant fine-grained permissions to API users without assigning them to broad predefined roles.

To create or manage custom API roles, use the Identity REST API endpoints for creating and updating custom roles. See Create a custom role and Custom user roles for detailed information about available permissions and permission types.

Permission types

When creating custom API roles, you specify permission types to control the scope of access granted by each permission. Common permission types include:

retrieve: Grants read-only access to data (individual or organization-wide, depending on context)
retrieveTeamOnly: Grants read-only access limited to the user's assigned teams
retrieveOrg: Grants read-only access across the entire organization
create: Grants permission to create new resources
update: Grants permission to modify existing resources
delete: Grants permission to delete resources
generate: Grants permission to generate credentials or tokens
revoke: Grants permission to revoke credentials or tokens

For example, the ManageUser permission supports multiple types: create, createTeamOnly, retrieve, retrieveOrg, retrieveTeamOnly, update, updateOrg, updateTeamOnly, delete, and deleteTeamOnly.

For a complete list of available permissions and their supported types, see Custom user roles.

List all users in an organization

To list all users in an organization, send the following request:

http --auth-type=veracode_hmac GET "https://api.veracode.com/api/authn/v2/users"

By default, the output results show up to 20 users per page. To page through the list, you can resend the request with ?page=1, ?page=2, and so on, appended to the end.

To increase the page size from the maximum of 20 and list more users in the output, send the following request:

http --auth-type=veracode_hmac GET "https://api.veracode.com/api/authn/v2/users?page={page number}&size={page size}"

For example, set page=0&size=50 to increase the size of page 0 to 50.

To list only users whose accounts are enabled, send the following request:

http --auth-type=veracode_hmac GET "https://api.veracode.com/api/authn/v2/users?enabled=true"

To list only users whose accounts are disabled, set enabled=false.

Search for users

To search for users, including user accounts and API user accounts, by username, send the following request:

http --auth-type=veracode_hmac GET "https://api.veracode.com/api/authn/v2/users?user_name={user_name}"

You must specify the full username. The request does not support matching partial usernames.

To search for users by email address, send the following request:

http --auth-type=veracode_hmac GET "https://api.veracode.com/api/authn/v2/users?email_address={email_address},{email_address}"

Important

In each email address, you must specify the @ character using URL encoding or the request fails. For example, user%40domain.com. Use a comma-separated list to specify multiple addresses.

To search for users using with partial terms, send the following request:

http --auth-type=veracode_hmac GET "https://api.veracode.com/api/authn/v2/users/search?search_term={search_term}"

You can search for partial strings of the username, first name, last name, or email address. You can combine this call with other search parameters.

To search for users by API ID, send the following request:

http --auth-type=veracode_hmac GET "https://api.veracode.com/api/authn/v2/users/search?api_id={api_id}"

You must specify the exact API ID. You can combine this call with other search parameters.

Filter users

To filter users by role, send the following request:

http --auth-type=veracode_hmac GET "https://api.veracode.com/api/authn/v2/users/search?role_id={role_id}"

To filter users by user type, send the following request:

http --auth-type=veracode_hmac GET "https://api.veracode.com/api/authn/v2/users/search?user_type={user_type}"

To filter users by login status, send the following request:

http --auth-type=veracode_hmac GET "https://api.veracode.com/api/authn/v2/users/search?login_status={login_status}"

To filter users by SAML status, send the following request:

http --auth-type=veracode_hmac GET "https://api.veracode.com/api/authn/v2/users/search?saml_user=true"

To filter users by team, send the following request:

http --auth-type=veracode_hmac GET "https://api.veracode.com/api/authn/v2/users/search?team_id={team_guid}"

Update a user

To update a user account, send the following request:

http --auth-type=veracode_hmac PUT "https://api.veracode.com/api/authn/v2/users/{userId}?partial=true" < input.json

The API passes the JSON file that you populate with the necessary values as shown in this example payload:

{
 "ip_restricted": true,
 "allowed_ip_addresses": ["72.22.163.41"]
}

Update a user to require multifactor authentication

To update an existing account, send the following request:

http --auth-type=veracode_hmac PUT "https://api.veracode.com/api/authn/v2/users/{userId}?partial=true" < input.json

The API passes the JSON file that you populate with the necessary values as shown in this example payload:

{
  "pin_required": true
}

Delete a user

To delete an account, send the following request:

http --auth_type=veracode_hmac DELETE "https://api.veracode.com/api/authn/v2/users/{userId}"

userId is the numeric ID, separated with hyphens, for the target account. For example: 7336556f-9ef2-4a1c-b536-be8608822db6.

Get principal for your account

To get the principal, with key details for your user, send the following request:

http --auth-type=veracode_hmac GET "https://api.veracode.com/api/authn/v2/principal"

Generate API credentials for your account

To generate new API credentials for your account, send the following request:

http --auth-type=veracode_hmac --json POST "https://api.veracode.com/api/authn/v2/api_credentials"

Generate API credentials

To send this request, you must have the Administrator role or be the administrator for the specified user.

To generate new API credentials for the user you specify with userId, send the following request:

http --auth-type=veracode_hmac --json POST "https://api.veracode.com/api/authn/v2/api_credentials/user_id/{userId}"

Get API credentials expiration

Use these requests to view the expiration date for API credentials.

Get the expiration date for your account

To view the expiration date and time for your API credentials, send the following request:

http --auth-type=veracode_hmac GET "https://api.veracode.com/api/authn/v2/api_credentials"

Get the expiration date by API ID

To view credentials expiration information for a specific API ID, send the following request:

http --auth-type=veracode_hmac GET "https://api.veracode.com/api/authn/v2/api_credentials/{apiCredsId}"

Get the expiration date

To send this request, you must have the Administrator role or be the administrator for the specified user.

To view the current API credentials and their expiration for the user you specify with userId, send the following request:

http --auth-type=veracode_hmac --json GET "https://api.veracode.com/api/authn/v2/api_credentials/user_id/{userId}"

You must include the --json parameter to force the request to send the Content-Type: application/json in the HTTP header.

Revoke API credentials

This use case scenario provides the Identity REST API request for revoking API credentials. The credentials expire immediately after you revoke them. You can no longer use them to access Veracode.

You can use the Veracode Platform or the Identity API to generate new API credentials.

To revoke the API credentials for a specific API ID, send the following request:

http --auth-type=veracode_hmac --json DELETE "https://api.veracode.com/api/authn/v2/api_credentials/{apiCredsId}"

You must include the --json parameter to force the request to send the Content-Type: application/json in the HTTP he

Delete API credentials

To delete the API credentials for the user you specify with userId, send the following request:

http --auth-type=veracode_hmac --json DELETE "https://api.veracode.com/api/authn/v2/api_credentials/user_id/{userId}"

You must include the --json parameter to force the request to send the Content-Type: application/json in the HTTP header.

List all roles in an organization

To list all roles in an organization, including user accounts and API user accounts, send the following request:

http --auth-type=veracode_hmac GET "https://api.veracode.com/api/authn/v2/roles"

By default, the output results list up to 20 roles per page. To page through the list, append ?page=1, ?page=2, and so on, to the end of your request.

To increase the page size from the maximum of 20 and list more roles in the output, send the following request:

http --auth-type=veracode_hmac GET "https://api.veracode.com/api/authn/v2/roles?size=500"

List roles that include a specific permission

To list the roles that contain a specific permission, send the following request:

http --auth-type=veracode_hmac GET "https://api.veracode.com/api/authn/v2/roles?size=500&permission_name={permission_name}"

See the full list of permissions.

List all permissions in an organization

To list all Veracode permissions, including for user accounts and API user accounts, send the following request:

http --auth-type=veracode_hmac GET "https://api.veracode.com/api/authn/v2/permissions?"

By default, the output results show up to 20 permissions per page. To page through the list, resend the request with ?page=1, ?page=2, and so on, appended to the end. For example:

http --auth-type=veracode_hmac GET "https://api.veracode.com/api/authn/v2/permissions?page=4"

Get details of a role

To view information about a specific role, send the following request:

http --auth-type=veracode_hmac GET "https://api.veracode.com/api/authn/v2/roles/{role_id}"

The role details include the name, description, associated permissions, and more.

To get the role_id, list the roles in your organization.

Create a custom role

To create a custom role, send the following request:

http --auth-type=veracode_hmac POST "https://api.veracode.com/api/authn/v2/roles" < input.json

The API passes the JSON file that you populate with the permissions to grant the user, as shown in this example payload:

{
  "role_name": "developer",
  "role_description": "Developer",
  "is_api": false,
  "jit_assignable": true,
  "jit_assignable_default": true,
  "ignore_team_restrictions" : true,
  "permissions": [
    {
      "permission_name": "ManageApiCredentials",
      "permission_types": [
        "retrieve",
        "revoke",
        "generate"
      ]
    },
    {
      "permission_name": "viewResults"
    },
    {
      "permission_name": "viewDynamicAnalysisResult"
    },
    {
      "permission_name": "updateResults"
    },
    {
      "permission_name": "ManageUser",
      "permission_types": [
        "retrieve",
        "update"
      ]
    }
  ]
}

Properties

You use JSON properties to create and update custom roles with the Identity REST API.

Each role must include role_name, role_description, and permissions, as shown in the following example:

{
  "role_name": "developer",
  "role_description": "Developer",
  "permissions": [
    {
      "permission_name": "ManageApiCredentials",
      "permission_types": [
        "retrieve",
        "revoke",
        "generate"
      ]
    },
    {
      "permission_name": "viewResults"
    }
  ]
}

The following table describes the JSON properties for creating and updating custom roles. These properties apply to both UI users and API users.

Property	Type	Description
`role_name` Required	String	Internal name of the custom role. Must be lower case and contain no spaces. Veracode automatically prepends `custom-` to the name. For example, if you enter `developer`, the internal name is `custom-developer`.
`role_description` Required	String	User-facing name of the custom role. This name appears in the Veracode Platform when selecting roles for users.
`is_api`	Boolean	Whether the role applies to API user accounts. Default is `false`.
`requires_token`	Boolean	Whether users must have multifactor authentication to use the role. Default is `false`.
`team_admin_manageable`	Boolean	Whether Team Admins can manage the role. Default is `false`.
`jit_assignable`	Boolean	Whether you can use the role with Just-In-Time provisioning. Default is `false`.
`jit_assignable_default`	Boolean	Whether you can use this role in SAML assertions. Default is `false`.
`permissions` Required	Array	List of permissions that the role grants to users.
`child_roles`	Array	List of roles whose permissions this role grants to users.
`ignore_team_restrictions`	Boolean	Whether the role is limited to teams the user is assigned to. Default is `false`.

Create a custom role using child roles

When you create a custom role, you can use child roles to grant all the permissions associated with existing roles to your custom role. To include the permissions from a Veracode role or a custom role in your new custom role, include them in the payload when you create the role.

To create a custom role that uses child roles, send the following request:

http --auth-type=veracode_hmac POST "https://api.veracode.com/api/authn/v2/roles" < input.json

The API passes the JSON file that you populate with the necessary values as shown in this example payload:

{
  "role_name": "developer",
  "role_description": "Developer",
  "is_api" : false,
  "jit_assignable" : true,
  "jit_assignable_default" : true,
  "permissions": [
  ],
  "child_roles": [{
      "role_description": "Sandbox User"
    },
    {
      "role_description": "Reviewer"
    },
    {
      "role_description": "Submitter"
    },
    {
      "role_description": "Delete Scans"
    },
    {
      "role_description": "Security Insights"
    },
    {
      "role_name": "custom-myOtherCustomRole"
    }]
}

See the list of properties and the list of permissions you can include when creating roles.

Update a custom role

To update a custom role, send the following request:

http --auth-type=veracode_hmac PUT "https://api.veracode.com/api/authn/v2/roles/{role_id}?partial=true" < input.json

To get the role_id, list the roles in your organization. You cannot update the standard Veracode roles.

The API passes the JSON file that you populate with the necessary values as shown in this example payload:

{
  "role_name": "developer",
  "role_description": "Developer",
  "is_api" : false,
  "jit_assignable" : true,
  "jit_assignable_default" : true,
  "permissions": [
    {
      "permission_name": "ManageApiCredentials",
      "permission_types": [
        "retrieve",
        "revoke",
        "generate"
      ]
    },
    {
      "permission_name": "viewResults"
    },
    {
      "permission_name": "viewDynamicAnalysisResult"
    },
    {
      "permission_name": "updateResults"
    },
    {
      "permission_name": "ManageUser",
      "permission_types": [
        "retrieve",
        "update"
      ]
    }
  ]
}

See the list of properties and the list of permissions you can include when updating roles.

Add permissions to a custom role

To add permissions to a custom role, send the following request:

http --auth-type=veracode_hmac PUT "https://api.veracode.com/api/authn/v2/roles/{role_id}?partial=true&incremental=true" < input.json

To add permissions to the role without redefining the other details of the role, include incremental=true in the request.

To get the role_id, list the roles in your organization. You cannot update the standard Veracode roles.

The API passes the JSON file that you populate with the necessary values as shown in this example payload:

{
    "permissions": [
         {
            "permission_name": "ManageUser",
            "permission_types": [
                "retrieve",
                "update"
            ]
        },
        {
            "permission_name": "dashboard"
        },
        {
            "permission_name": "exportCustomData"
        },
        {
            "permission_name": "lookerAnalyticsViewer"
        }
    ]
}

See the list of properties and the list of permissions you can include when updating roles.

Delete a custom role

To delete a custom role from your organization, send the following request:

http --auth-type=veracode_hmac DELETE "https://api.veracode.com/api/authn/v2/roles/{role_id}"

To get the role_id, list the roles in your organization. You cannot delete the standard Veracode roles.

Get a list of users by role or custom role

You can get a list of users who are impacted by changing or deleting a custom role. To get the list of users who are directly or indirectly assigned a role or custom role, send the following request:

http --auth-type=veracode_hmac GET "https://api.veracode.com/api/authn/v2/users/by_role/{{role_ID}}"

Disable a role

To disable a role for your organization so that the role cannot be assigned to users, send the following request:

http --auth-type=veracode_hmac POST "https://api.veracode.com/api/authn/v2/roles_disabled"

The API passes the JSON file that you populate with the necessary values as shown in this example payload:

{
  "org_id": "0a41b543-c6f2-4c2d-a119-2ef33afecea",
  "role_id": "8f3ea8cc-53db-436f-bb26-df98cdbc1361",
  "disabled": true
}

To get the role_id, list the roles in your organization. You cannot disable custom roles.

Get list of disabled roles

To get a list of all the roles disabled for your organization, send the following request:

http --auth-type=veracode_hmac GET "https://api.veracode.com/api/authn/v2/roles_disabled"

Get a disabled role

To get the details of a role disabled by your organization, send the following request:

http --auth-type=veracode_hmac GET "https://api.veracode.com/api/authn/v2/roles_disabled/{role_id}"

To get the role_id, list the roles in your organization.

Update a disabled role

To update a disabled role, send the following request:

http --auth-type=veracode_hmac PUT "https://api.veracode.com/api/authn/v2/roles_disabled"

The API passes the JSON file that you populate with the necessary values as shown in this example payload:

{
  "org_id": "0a41b543-c6f2-4c2d-a119-2ef33afecea",
  "role_id": "8f3ea8cc-53db-436f-bb26-df98cdbc1361",
  "disabled": false
}

To get the role_id, list the roles in your organization. You cannot disable custom roles.

Delete a disabled role

To enable a disabled role, send the following request:

http --auth-type=veracode_hmac DELETE "https://api.veracode.com/api/authn/v2/roles_disabled/{role_id}"

To get the role_id, list the roles in your organization.

Create a team

To create a team, send the following request:

http --auth-type=veracode_hmac POST "https://api.veracode.com/api/authn/v2/teams" < input.json

The API passes the JSON file that you populate with the necessary values as shown in this example payload:

{
  "team_name": "Physical Penetration Testing"
}

Add users to a team

To add users to a team, send the following request:

http --auth-type=veracode_hmac PUT "https://api.veracode.com/api/authn/v2/teams/{teamId}?partial=true&incremental=true" < input.json

The API passes the JSON file that you populate with the necessary values as shown in this example payload:

{
  "team_name": "Red Team Testing",
  "users": [
    {
      "user_name": "[email protected]"
    },
    {
      "user_name": "[email protected]"
    }
  ]
}

You can specify user_id or user_name.

Important

You must set incremental=true or the request overwrites the list of users instead of adding them to the specified team.

Get a list of teams

To view a list of all teams of which you are a member, send the following request:

http --auth-type=veracode_hmac GET "https://api.veracode.com/api/authn/v2/teams"

You can also view information about a specific team.

To view a list of all teams in your organization, send the following request:

http --auth-type=veracode_hmac GET "https://api.veracode.com/api/authn/v2/teams?all_for_org=true"

Get team details

To view information about a specific team in your organization, send the following request:

http --auth-type=veracode_hmac GET "https://api.veracode.com/api/authn/v2/teams/{teamId}"

teamId is the numeric ID, separated with hyphens, for the target team. For example: 7336556f-9ef2-4a1c-b536-be8608822db6.

The request output includes information about any users who are linked to the team.

Update a team

To change the name of a team, send the following request:

http --auth-type=veracode_hmac PUT "https://api.veracode.com/api/authn/v2/teams/{teamId}?partial=true" < input.json

teamId is the numeric ID, separated with hyphens, for the target team. For example: 7336556f-9ef2-4a1c-b536-be8608822db6.

The API passes the JSON file that you populate with the necessary values as shown in this example payload:

{
  "team_name": "Physical Penetration Testing"
}

Delete a team

To delete a team, send the following request:

http --auth-type=veracode_hmac DELETE "https://api.veracode.com/api/authn/v2/teams/{teamId}"

teamId is the numeric ID, separated with hyphens, for the target object. For example: 7336556f-9ef2-4a1c-b536-be8608822db6.

Create a business unit

To create a business unit, send the following request:

http --auth-type=veracode_hmac POST "https://api.veracode.com/api/authn/v2/business_units" < input.json

The API passes the JSON file that you populate with the necessary values as shown in this example payload:

{
  "bu_name": "Business Unit Five"
}

Add a team to a business unit

To add a team to a business unit, send the following request:

http --auth-type=veracode_hmac PUT "https://api.veracode.com/api/authn/v2/business_units/{businessUnitId}?partial=true&incremental=true" < input.json

businessUnitId is the numeric ID, separated with hyphens, for the target business unit. For example: 7336556f-9ef2-4a1c-b536-be8608822db6.

The API passes the JSON file that you populate with the necessary values as shown in this example payload:

{
  "teams": [
    {
      "team_id": "d56ebdfd-6797-4566-96a1-67455975b6a4"
    }
  ]
}

Get a list of business units

To list all business units for an organization, send the following request:

http --auth-type=veracode_hmac GET "https://api.veracode.com/api/authn/v2/business_units"

You can also view details about a specific business unit.

Get business unit details

To view details about a specific business unit, send the following request:

http --auth-type=veracode_hmac GET "https://api.veracode.com/api/authn/v2/business_units/{businessUnitId}"

businessUnitId is the numeric ID, separated with hyphens, for the target business unit. For example: 7336556f-9ef2-4a1c-b536-be8608822db6.

The output results include information about any teams that are linked to the specified business unit.

You can also list all business units.

Update a business unit

To update a business unit, send the following request:

Important

You must set partial=true or the request overwrites all existing business units.

http --auth-type=veracode_hmac PUT "https://api.veracode.com/api/authn/v2/business_units/{businessUnitId}?partial=true" < input.json

businessUnitId is the numeric ID, separated with hyphens, for the target business unit. For example: 7336556f-9ef2-4a1c-b536-be8608822db6.

The API passes the JSON file that you populate with the necessary values as shown in this example payload:

{
  "bu_name": "My business unit"
}

Delete a business unit

To delete a business unit, send the following request:

http --auth-type=veracode_hmac DELETE "https://api.veracode.com/api/authn/v2/business_units/{businessUnitId}"

businessUnitId is the numeric ID, separated with hyphens, for the target business unit. For example: 7336556f-9ef2-4a1c-b536-be8608822db6.

Delete JWT token by okta user id

To delete all JWT tokens for a user, send the following request:

http ---auth-type=veracode_hmac DELETE "https://api.veracode.com/api/authn/v2/session/idp_user_id/{okta_user_id}"

To get the okta_user_id, search for the user. The okta_user_id appears in the details.

Delete JWT tokens by veracode user id

To delete all JWT tokens for a user, send the following request:

http ---auth-type=veracode_hmac DELETE "https://api.veracode.com/api/authn/v2/session/user_id/{user_id}"

user_id is the numeric ID, separated with hyphens, for the target account. For example: 7336556f-9ef2-4a1c-b536-be8608822db6.

Permissions​

Authentication​

Identity API specification​

Create a UI user​

Roles​

Create a SAML user​

Create an API user​

Custom API roles​

Permission types​

List all users in an organization​

Search for users​

Filter users​

Update a user​

Update a user to require multifactor authentication​

Delete a user​

Get principal for your account​

Generate API credentials for your account​

Generate API credentials​

Get API credentials expiration​

Get the expiration date for your account​

Get the expiration date by API ID​

Get the expiration date​

Revoke API credentials​

Delete API credentials​

List all roles in an organization​

List roles that include a specific permission​

List all permissions in an organization​

Get details of a role​

Create a custom role​

Properties​

Create a custom role using child roles​

Update a custom role​

Add permissions to a custom role​

Delete a custom role​

Get a list of users by role or custom role​

Disable a role​

Get list of disabled roles​

Get a disabled role​

Update a disabled role​

Delete a disabled role​

Create a team​

Add users to a team​

Get a list of teams​

Get team details​

Update a team​

Delete a team​

Create a business unit​

Add a team to a business unit​

Get a list of business units​

Get business unit details​

Update a business unit​

Delete a business unit​

Delete JWT token by okta user id​

Delete JWT tokens by veracode user id​

Did you find this helpful?

Permissions

Authentication

Identity API specification

Create a UI user

Roles

Create a SAML user

Create an API user

Custom API roles

Permission types

List all users in an organization

Search for users

Filter users

Update a user

Update a user to require multifactor authentication

Delete a user

Get principal for your account

Generate API credentials for your account

Generate API credentials

Get API credentials expiration

Get the expiration date for your account

Get the expiration date by API ID

Get the expiration date

Revoke API credentials

Delete API credentials

List all roles in an organization

List roles that include a specific permission

List all permissions in an organization

Get details of a role

Create a custom role

Properties

Create a custom role using child roles

Update a custom role

Add permissions to a custom role

Delete a custom role

Get a list of users by role or custom role

Disable a role

Get list of disabled roles

Get a disabled role

Update a disabled role

Delete a disabled role

Create a team

Add users to a team

Get a list of teams

Get team details

Update a team

Delete a team

Create a business unit

Add a team to a business unit

Get a list of business units

Get business unit details

Update a business unit

Delete a business unit

Delete JWT token by okta user id

Delete JWT tokens by veracode user id