Access Control (REST) API Summary

Owned by David P (Deactivated)
Last updated: Oct 11, 2020 by Johannes Stark (Unlicensed)
2 min read

This section is designed to be used as a basic summary of our Access Control (REST) API offering. Access Control (REST) APIs are grouped according to its own area and each API has a direct link to the relevant API documentation. Cx version, indicating when the API was first introduced to Checkmarx, as well as the AC (Access Control) and API versions are also indicated.

GroupAPICx Ver.AC Ver.API Ver.
Assignable UserGET /AssignableUsers9.0.0 up1.5 up1.0
Authentication Providers

GET /AuthenticationProviders

9.0.0 up

1.5 up

1.0

First User

POST /Users/FirstAdmin

9.0.0 up

2.0 up

1.0


GET /Users/FirstAdminExistence

9.0.0 up

2.0 up

1.0

LDAP Role MappingsGET /LDAPRoleMappings9.0.0 up

1.5 up

1.0

PUT /LDAPServers/{id}/RoleMappings

9.0.0 up

1.5 up

1.0


DELETE /LDAPRoleMappings/{id}

9.0.0 up

1.5 up

1.0

LDAP Servers

POST /LDAPServers/TestConnection

9.0.0 up

1.5 up

1.0


GET /LDAPServers/{id}/UserEntries

9.0.0 up

1.5 up

1.0


GET /LDAPServers/{id}/GroupEntries

9.0.0 up

1.5 up

1.0


GET /LDAPServers

9.0.0 up

1.5 up

1.0


POST /LDAPServers

9.0.0 up

1.5 up

1.0


GET /LDAPServers/{id}

9.0.0 up

1.5 up

1.0


PUT /LDAPServers/{id}

9.0.0 up

1.5 up

1.0


DELETE /LDAPServers/{id}

9.0.0 up

1.5 up

1.0

LDAP Team Mappings

GET /LDAPTeamMappings

9.0.0 up

1.5 up

1.0


PUT /LDAPServers/{id}/TeamMappings

9.0.0 up

1.5 up

1.0


DELETE /LDAPTeamMappings/{id}

9.0.0 up

1.5 up

1.0

My Profile

GET /MyProfile

9.0.0 up

2.0 up

1.0


PUT /MyProfile

9.0.0 up

2.0 up

1.0

OIDC Clients

GET /OIDCClients

9.0.0 up

1.5 up

1.0


POST /OIDCClients

9.0.0 up

1.5 up

1.0


GET /OIDCClients/{id}

9.0.0 up

1.5 up

1.0


PUT /OIDCClients/{id}

9.0.0 up

1.5 up

1.0


DELETE /OIDCClients/{id}

9.0.0 up

1.5 up

1.0

Permissions

GET /Permissions

9.0.0 up

1.5 up

1.0


GET /Permissions/{id}

9.0.0 up

1.5 up

1.0

Roles

GET /Roles

9.0.0 up

1.5 up

1.0


POST /Roles

9.0.0 up

1.5 up

1.0


GET /Roles/{id}

9.0.0 up

1.5 up

1.0


PUT /Roles/{id}

9.0.0 up

1.5 up

1.0


DELETE /Roles/{id}

9.0.0 up

1.5 up

1.0

 Saml Identity ProvidersGET /SamlIdentityProviders9.0.0 up

2.0 up

1.0

POST /SamlIdentityProviders

9.0.0 up2.0 up1.0 

GET /SamlIdentityProviders/{id}9.0.0 up2.0 up1.0 

PUT /SamlIdentityProviders/{id}

9.0.0 up2.0 up1.0 

DELETE /SamlIdentityProviders/{id}9.0.0 up2.0 up 1.0 
 Saml Service ProviderGET /SamlServiceProvider/metadata9.0.0 up2.0 up 1.0 

GET /SamlServiceProvider9.0.0 up2.0 up 1.0 

PUT /SamlServiceProvider9.0.0 up2.0 up 1.0 
 Service ProvidersGET /ServiceProviders9.0.0 up2.0 up 1.0 

GET /ServiceProviders/{id}9.0.0 up2.0 up 1.0 
SMTP Settings

GET /SMTPSettings

9.0.0 up

1.5 up

1.0


POST /SMTPSettings

9.0.0 up

1.5 up

1.0


GET /SMTPSettings/{id}

9.0.0 up

1.5 up

1.0


PUT /SMTPSettings/{id}

9.0.0 up

1.5 up

1.0


DELETE /SMTPSettings/{id}

9.0.0 up

1.5 up

1.0


POST /SMTPSettings/testconnection

9.0.0 up

1.5 up

1.0

System Locales

GET /SystemLocales

9.0.0 up

1.5 up

1.0

Team Members

GET /Teams/{id}Users

9.0.0 up

1.5 up

1.0


PUT /Teams/teamId}Users

9.0.0 up

1.5 up

1.0


POST /Teams/{teamId}/Users/{userId}

9.0.0 up

1.5 up

1.0


DELETE /Teams/{teamId}/users/{userId}

9.0.0 up

1.5 up

1.0

Teams

GET /Teams

9.0.0 up

1.5 up

1.0


POST /Teams

9.0.0 up

1.5 up

1.0


GET /Teams/{id}

9.0.0 up

1.5 up

1.0


PUT /Teams/{id}

9.0.0 up

1.5 up

1.0


DELETE /Teams/{id}

9.0.0 up

1.5 up

1.0

Token Signing Certificates

POST TokenSigningCertificateGeneration

9.0.0 up

1.5 up

1.0


POST TokenSigningCertificate

9.0.0 up

1.5 up

1.0

Users

GET /Users

9.0.0 up

1.5 up

1.0


POST /Users

9.0.0 up

1.5 up

1.0


GET /Users/{id}

9.0.0 up

1.5 up

1.0


PUT /Users/{id}

9.0.0 up

1.5 up

1.0


DELETE /Users/{id}

9.0.0 up

1.5 up

1.0

Windows Domains

GET /WindowsDomains

9.0.0 up

1.5 up

1.0


POST /WindowsDomains

9.0.0 up

1.5 up

1.0


GET /WindowsDomains/{id}

9.0.0 up

1.5 up

1.0


PUT /WindowsDomains/{id}

9.0.0 up

1.5 up

1.0


DELETE /WindowsDomains/{id}

9.0.0 up

1.5 up

1.0


GET /WindowsDomains/{id}/UserEntries9.0.0 up2.0 up 1.0 



Read more: