public final class AdminAPIWrapper extends AbstractAPIWrapper
Provides access to the Veracode Admin API. The Veracode Admin API enables you to automate administration tasks such as creating and managing users and teams in the Veracode platform and obtaining reference information about your organization. For example, you can use a script to mass create users, mass assign users to teams, or de-provision many users at once. You can also use the Admin API to automatically connect Veracode to your organization's directory (LDAP or Active Directory), so that as changes occur in your directory (adding or terminating employees), those changes are automatically reflected in your user list in Veracode.
To be able to access the Admin API, you must have a non-human API customer account that has the Admin API role. You cannot use the Admin API to create a non-human API user account; you must do this task using the Veracode platform.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CREATE_TEAM_URI |
static java.lang.String |
CREATE_USER_URI |
static java.lang.String |
DELETE_TEAM_URI |
static java.lang.String |
DELETE_USER_URI |
static java.lang.String |
GET_CURRICULUM_LIST_URI |
static java.lang.String |
GET_TEAM_INFO_URI |
static java.lang.String |
GET_TEAM_LIST_URI |
static java.lang.String |
GET_TRACK_LIST_URI |
static java.lang.String |
GET_USER_INFO_URI |
static java.lang.String |
GET_USER_LIST_URI |
static java.lang.String |
UPDATE_TEAM_URI |
static java.lang.String |
UPDATE_USER_URI |
BASE_ADDRESS
Constructor and Description |
---|
AdminAPIWrapper() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
createTeam(java.lang.String team_name)
Creates a new team of users.
|
java.lang.String |
createTeam(java.lang.String team_name,
java.lang.String members)
Creates a new team of users.
|
java.lang.String |
createUser(java.lang.String first_name,
java.lang.String last_name,
java.lang.String email_address,
java.lang.String roles)
Creates a new user login account.
|
java.lang.String |
createUser(java.lang.String first_name,
java.lang.String last_name,
java.lang.String email_address,
java.lang.String roles,
java.lang.String teams)
Creates a new user login account.
|
java.lang.String |
deleteTeam(java.lang.String team_id)
Deletes a specified team of users.
|
java.lang.String |
deleteUser(java.lang.String username,
java.lang.String custom_id)
Deletes a Veracode user login account.
|
java.lang.String |
getCurriculumList()
Returns a list of the eLearning curricula that is defined for your
organization
|
java.lang.String |
getTeamInfo(java.lang.String team_id)
Gets information about a specific team.
|
java.lang.String |
getTeamInfo(java.lang.String team_id,
java.lang.String include_users)
Gets information about a specific team.
|
java.lang.String |
getTeamInfo(java.lang.String team_id,
java.lang.String include_users,
java.lang.String include_applications)
Gets information about a specific team.
|
java.lang.String |
getTeamList()
Returns a list of the user teams for your organization.
|
java.lang.String |
getTrackList()
Returns a list of the eLearning tracks that are available for your
organization.
|
java.lang.String |
getUserInfo(java.lang.String username,
java.lang.String custom_id)
Returns information about the specified user.
|
java.lang.String |
getUserList()
Returns a list of the Veracode user accounts in your organization.
|
java.lang.String |
getUserList(java.lang.String first_name,
java.lang.String last_name,
java.lang.String custom_id,
java.lang.String email_address,
java.lang.String login_account_type,
java.lang.String phone,
java.lang.String teams,
java.lang.String roles,
java.lang.String is_saml_user,
java.lang.String login_enabled,
java.lang.String requires_token,
java.lang.String is_elearning_manager,
java.lang.String elearning_manager,
java.lang.String elearning_track,
java.lang.String elearning_curriculum,
java.lang.String keep_elearning_active,
java.lang.String custom_one,
java.lang.String custom_two,
java.lang.String custom_three,
java.lang.String custom_four,
java.lang.String custom_five)
Returns a list of the Veracode user accounts in your organization.
|
java.lang.String |
getUserList(java.lang.String first_name,
java.lang.String last_name,
java.lang.String custom_id,
java.lang.String email_address,
java.lang.String login_account_type,
java.lang.String phone,
java.lang.String teams,
java.lang.String roles,
java.lang.String is_saml_user,
java.lang.String login_enabled,
java.lang.String requires_token,
java.lang.String is_elearning_manager,
java.lang.String elearning_manager,
java.lang.String elearning_track,
java.lang.String elearning_curriculum,
java.lang.String keep_elearning_active,
java.lang.String custom_one,
java.lang.String custom_two,
java.lang.String custom_three,
java.lang.String custom_four,
java.lang.String custom_five,
java.lang.String position)
Returns a list of the Veracode user accounts in your organization.
|
java.lang.String |
updateTeam(java.lang.String team_id)
Updates or changes the member information of the specified team.
|
java.lang.String |
updateTeam(java.lang.String members,
java.lang.String team_id,
java.lang.String team_name)
Updates or changes the member information of the specified team.
|
java.lang.String |
updateUser(java.lang.String username,
java.lang.String custom_id)
Updates or changes the information of the specified user account.
|
java.lang.String |
updateUser(java.lang.String username,
java.lang.String custom_id,
java.lang.String first_name,
java.lang.String last_name,
java.lang.String email_address,
java.lang.String new_custom_id,
java.lang.String login_account_type,
java.lang.String phone,
java.lang.String teams,
java.lang.String roles,
java.lang.String is_saml_user,
java.lang.String login_enabled,
java.lang.String requires_token,
java.lang.String is_elearning_manager,
java.lang.String elearning_manager,
java.lang.String elearning_track,
java.lang.String elearning_curriculum,
java.lang.String keep_elearning_active,
java.lang.String custom_one,
java.lang.String custom_two,
java.lang.String custom_three,
java.lang.String custom_four,
java.lang.String custom_five)
Updates or changes the information of the specified user account.
|
setUpApiCredentials, setUpCredentials, setUpProxy, setUpProxy, setUpProxy
public static final java.lang.String CREATE_TEAM_URI
public static final java.lang.String CREATE_USER_URI
public static final java.lang.String DELETE_TEAM_URI
public static final java.lang.String DELETE_USER_URI
public static final java.lang.String GET_CURRICULUM_LIST_URI
public static final java.lang.String GET_TEAM_LIST_URI
public static final java.lang.String GET_TRACK_LIST_URI
public static final java.lang.String GET_USER_INFO_URI
public static final java.lang.String GET_USER_LIST_URI
public static final java.lang.String UPDATE_TEAM_URI
public static final java.lang.String UPDATE_USER_URI
public static final java.lang.String GET_TEAM_INFO_URI
public java.lang.String createTeam(java.lang.String team_name) throws java.io.IOException
Creates a new team of users.
Calls this URL: https://analysiscenter.veracode.com/api/3.0/createteam.do Schema File: https://analysiscenter.veracode.com/resource/3.0/teaminfo.xsd
team_name
- Required. Must be unique.java.io.IOException
public java.lang.String createTeam(java.lang.String team_name, java.lang.String members) throws java.io.IOException
Creates a new team of users.
Calls this URL: https://analysiscenter.veracode.com/api/3.0/createteam.do Schema File: https://analysiscenter.veracode.com/resource/3.0/teaminfo.xsd
team_name
- Required. Must be unique.members
- Optional. Comma-delimited string. List of usernames.java.io.IOException
public java.lang.String createUser(java.lang.String first_name, java.lang.String last_name, java.lang.String email_address, java.lang.String roles) throws java.io.IOException
Creates a new user login account. You can only create a human user. To create non-human API users, you must use the Veracode platform.
Calls this URL: https://analysiscenter.veracode.com/api/3.0/createuser.do Schema File: https://analysiscenter.veracode.com/resource/3.0/userinfo.xsd
first_name
- Required.last_name
- Required.email_address
- Required.roles
- Required. Comma-delimited string. Case-sensitive. You can only
pass the following human user roles: Administrator, Creator,
Executive, Mitigation Approver, Policy Administrator,
Reviewer, Security Lead, Submitter, Security Insights,
eLearning. You cannot pass any of the non-human API user
roles. If you use either the Creator, Security Lead, or
Submitter role, you must also pass one or more of the scan
permission roles: Manual Scan, Static Scan, Dynamic Scan, or
Any Scan. The createuser.do call only returns users that match
all the listed roles.java.io.IOException
public java.lang.String createUser(java.lang.String first_name, java.lang.String last_name, java.lang.String email_address, java.lang.String roles, java.lang.String teams) throws java.io.IOException
Creates a new user login account. You can only create a human user. To create non-human API users, you must use the Veracode platform.
Calls this URL: https://analysiscenter.veracode.com/api/3.0/createuser.do Schema File: https://analysiscenter.veracode.com/resource/3.0/userinfo.xsd
first_name
- Required.last_name
- Required.email_address
- Required.roles
- Required. Comma-delimited string. Case-sensitive. You can only
pass the following human user roles: Administrator, Creator,
Executive, Mitigation Approver, Policy Administrator,
Reviewer, Security Lead, Submitter, Security Insights,
eLearning. You cannot pass any of the non-human API user
roles. If you use either the Creator, Security Lead, or
Submitter role, you must also pass one or more of the scan
permission roles: Manual Scan, Static Scan, Dynamic Scan, or
Any Scan. The createuser.do call only returns users that match
all the listed roles.teams
- Comma-delimited string. Case-sensitive.java.io.IOException
public java.lang.String deleteTeam(java.lang.String team_id) throws java.io.IOException
Deletes a specified team of users.
Calls this URL: https://analysiscenter.veracode.com/api/3.0/deleteteam.do Schema File: https://analysiscenter.veracode.com/resource/3.0/teamlist.xsd
team_id
- Required. A String that represents an Integer value.java.io.IOException
public java.lang.String deleteUser(java.lang.String username, java.lang.String custom_id) throws java.io.IOException
Deletes a Veracode user login account. You can only delete a human user. To delete non-human API users, you must use the Veracode platform.
Calls this URL: https://analysiscenter.veracode.com/api/3.0/deleteuser.do Schema File: https://analysiscenter.veracode.com/resource/3.0/userlist.xsd
username
- Required.custom_id
- Required if the username parameter is not provided.java.io.IOException
public java.lang.String getCurriculumList() throws java.io.IOException
Returns a list of the eLearning curricula that is defined for your organization
Calls this URL: https://analysiscenter.veracode.com/api/3.0/getcurriculumlist.do Schema File: https://analysiscenter.veracode.com/resource/3.0/curriculumlist.xsd
java.io.IOException
public java.lang.String getTeamList() throws java.io.IOException
Returns a list of the user teams for your organization.
Calls this URL: https://analysiscenter.veracode.com/api/3.0/getteamlist.do Schema File: https://analysiscenter.veracode.com/resource/3.0/teamlist.xsd
java.io.IOException
public java.lang.String getTeamInfo(java.lang.String team_id) throws java.io.IOException
Gets information about a specific team.
Calls this URL: https://analysiscenter.veracode.com/api/3.0/getteaminfo.do Schema File: https://analysiscenter.veracode.com/resource/3.0/teaminfo.xsd
team_id
- Required. A String that represents an Integer value.java.io.IOException
public java.lang.String getTeamInfo(java.lang.String team_id, java.lang.String include_users) throws java.io.IOException
Gets information about a specific team.
Calls this URL: https://analysiscenter.veracode.com/api/3.0/getteaminfo.do Schema File: https://analysiscenter.veracode.com/resource/3.0/teaminfo.xsd
team_id
- Required. A String that represents an Integer value.include_users
- Optional. A String if the answer is Yes returns the members of the team.java.io.IOException
public java.lang.String getTeamInfo(java.lang.String team_id, java.lang.String include_users, java.lang.String include_applications) throws java.io.IOException
Gets information about a specific team.
Calls this URL: https://analysiscenter.veracode.com/api/3.0/getteaminfo.do Schema File: https://analysiscenter.veracode.com/resource/3.0/teaminfo.xsd
team_id
- Required. A String that represents an Integer value.include_users
- Optional. A String if the answer is Yes returns the members of the team.include_applications
- Optional. A String if the answer is Yes returns applications assigned to the team.java.io.IOException
public java.lang.String getTrackList() throws java.io.IOException
Returns a list of the eLearning tracks that are available for your organization.
Calls this URL: https://analysiscenter.veracode.com/api/3.0/gettracklist.do Schema File: https://analysiscenter.veracode.com/resource/3.0/tracklist.xsd
java.io.IOException
public java.lang.String getUserInfo(java.lang.String username, java.lang.String custom_id) throws java.io.IOException
Returns information about the specified user.
Calls this URL: https://analysiscenter.veracode.com/api/3.0/getuserinfo.do Schema File: https://analysiscenter.veracode.com/resource/3.0/userinfo.xsd
username
- Required. This is usually the email address of the user.custom_id
- Required if the username parameter is not provided.java.io.IOException
public java.lang.String getUserList() throws java.io.IOException
Returns a list of the Veracode user accounts in your organization.
Calls this URL: https://analysiscenter.veracode.com/api/3.0/getuserlist.do Schema File: https://analysiscenter.veracode.com/resource/3.0/userlist.xsd
java.io.IOException
public java.lang.String getUserList(java.lang.String first_name, java.lang.String last_name, java.lang.String custom_id, java.lang.String email_address, java.lang.String login_account_type, java.lang.String phone, java.lang.String teams, java.lang.String roles, java.lang.String is_saml_user, java.lang.String login_enabled, java.lang.String requires_token, java.lang.String is_elearning_manager, java.lang.String elearning_manager, java.lang.String elearning_track, java.lang.String elearning_curriculum, java.lang.String keep_elearning_active, java.lang.String custom_one, java.lang.String custom_two, java.lang.String custom_three, java.lang.String custom_four, java.lang.String custom_five) throws java.io.IOException
Returns a list of the Veracode user accounts in your organization.
Calls this URL: https://analysiscenter.veracode.com/api/3.0/getuserlist.do Schema File: https://analysiscenter.veracode.com/resource/3.0/userlist.xsd
email_address
- Valid email address.login_account_type
- user or apiteams
- Comma-delimited string. This filter only returns users
matching all the listed team names.roles
- Comma-delimited string. Case-sensitive. You can filter on
theses human user roles: Administrator, Creator, Executive,
Mitigation Approver, Policy Administrator, Reviewer, Security
Lead, Submitter, Security Insights, eLearning. This filter
only returns users that match all of the listed teams.is_saml_user
- true or falselogin_enabled
- true or falserequires_token
- true or falseis_elearning_manager
- true or falseelearning_manager
- The first and last name (not the username) of the eLearning
manager. For example, Mary Doe.elearning_track
- The eLearning track name.elearning_curriculum
- The eLearning curriculum name.keep_elearning_active
- true or falsecustom_one
- Custom field.custom_two
- Custom field.custom_three
- Custom field.custom_four
- Custom field.custom_five
- Custom field.java.io.IOException
public java.lang.String getUserList(java.lang.String first_name, java.lang.String last_name, java.lang.String custom_id, java.lang.String email_address, java.lang.String login_account_type, java.lang.String phone, java.lang.String teams, java.lang.String roles, java.lang.String is_saml_user, java.lang.String login_enabled, java.lang.String requires_token, java.lang.String is_elearning_manager, java.lang.String elearning_manager, java.lang.String elearning_track, java.lang.String elearning_curriculum, java.lang.String keep_elearning_active, java.lang.String custom_one, java.lang.String custom_two, java.lang.String custom_three, java.lang.String custom_four, java.lang.String custom_five, java.lang.String position) throws java.io.IOException
Returns a list of the Veracode user accounts in your organization.
Calls this URL: https://analysiscenter.veracode.com/api/3.0/getuserlist.do Schema File: https://analysiscenter.veracode.com/resource/3.0/userlist.xsd
email_address
- Valid email address.login_account_type
- user or apiteams
- Comma-delimited string. This filter only returns users
matching all the listed team names.roles
- Comma-delimited string. Case-sensitive. You can filter on
theses human user roles: Administrator, Creator, Executive,
Mitigation Approver, Policy Administrator, Reviewer, Security
Lead, Submitter, Security Insights, eLearning. This filter
only returns users that match all of the listed teams.is_saml_user
- true or falselogin_enabled
- true or falserequires_token
- true or falseis_elearning_manager
- true or falseelearning_manager
- The first and last name (not the username) of the eLearning
manager. For example, Mary Doe.elearning_track
- The eLearning track name.elearning_curriculum
- The eLearning curriculum name.keep_elearning_active
- true or falsecustom_one
- Custom field.custom_two
- Custom field.custom_three
- Custom field.custom_four
- Custom field.custom_five
- Custom field.position
- Job title of the user.java.io.IOException
public java.lang.String updateTeam(java.lang.String team_id) throws java.io.IOException
Updates or changes the member information of the specified team.
Calls this URL: https://analysiscenter.veracode.com/api/3.0/updateteam.do Schema File: https://analysiscenter.veracode.com/resource/3.0/teaminfo.xsd
team_id
- Required. A String that represents an Integer value.java.io.IOException
public java.lang.String updateTeam(java.lang.String members, java.lang.String team_id, java.lang.String team_name) throws java.io.IOException
Updates or changes the member information of the specified team.
Calls this URL: https://analysiscenter.veracode.com/api/3.0/updateteam.do Schema File: https://analysiscenter.veracode.com/resource/3.0/teaminfo.xsd
members
- Optional. Comma-delimited string. To update or change the
membership of the team, provide a new list of members. To get
the current membership of the team before you change it,
issue: getuserlist.do?teams="Team_Id"team_id
- Required. A String that represents an Integer value.team_name
- Optional.java.io.IOException
public java.lang.String updateUser(java.lang.String username, java.lang.String custom_id) throws java.io.IOException
Updates or changes the information of the specified user account. You can use this call to change any of the parameters that you can change in the Veracode platform, except for login_account_type.
Calls this URL: https://analysiscenter.veracode.com/api/3.0/updateuser.do Schema File: https://analysiscenter.veracode.com/resource/3.0/userinfo.xsd
username
- Required. To change the username, send a new value in the
email_address parameter.custom_id
- Required. To change a custom_id, send a new value in the
new_custom_id parameter.java.io.IOException
public java.lang.String updateUser(java.lang.String username, java.lang.String custom_id, java.lang.String first_name, java.lang.String last_name, java.lang.String email_address, java.lang.String new_custom_id, java.lang.String login_account_type, java.lang.String phone, java.lang.String teams, java.lang.String roles, java.lang.String is_saml_user, java.lang.String login_enabled, java.lang.String requires_token, java.lang.String is_elearning_manager, java.lang.String elearning_manager, java.lang.String elearning_track, java.lang.String elearning_curriculum, java.lang.String keep_elearning_active, java.lang.String custom_one, java.lang.String custom_two, java.lang.String custom_three, java.lang.String custom_four, java.lang.String custom_five) throws java.io.IOException
Updates or changes the information of the specified user account. You can use this call to change any of the parameters that you can change in the Veracode platform, except for login_account_type.
Calls this URL: https://analysiscenter.veracode.com/api/3.0/updateuser.do Schema File: https://analysiscenter.veracode.com/resource/3.0/userinfo.xsd
username
- Required. To change the username, send a new value in the
email_address parameter.custom_id
- Required. To change a custom_id, send a new value in the
new_custom_id parameter.email_address
- Valid email address.new_custom_id
- The new custom_id value.login_account_type
- user or api. (This is a placeholder. Must change using the
Veracode platform.)teams
- Comma-delimited string. This filter only returns users
matching all the listed team names.roles
- Comma-delimited string. Case-sensitive. You can filter on
theses human user roles: Administrator, Creator, Executive,
Mitigation Approver, Policy Administrator, Reviewer, Security
Lead, Submitter, Security Insights, eLearning. This filter
only returns users that match all of the listed teams.is_saml_user
- true or false. If is_saml_user is set to true, an error is
thrown unless the account has SAML enabled and the login
account has or is being given a custom_id. If is_saml_user is
being set to false, an error is thrown indicating that SAML
users cannot be switched off.login_enabled
- true or falserequires_token
- true or falseis_elearning_manager
- true or falseelearning_manager
- The first and last name (not the username) of the eLearning
manager. For example, Mary Doe.elearning_track
- The eLearning track name.elearning_curriculum
- The eLearning curriculum name.keep_elearning_active
- true or falsecustom_one
- Custom field.custom_two
- Custom field.custom_three
- Custom field.custom_four
- Custom field.custom_five
- Custom field.java.io.IOException