Explore
Sechub API
1.0
OAS 3.0
The Sechub API description
Authorize
auth/saml
GET
/v1
/auth
/saml
/azure
/{providerId}
initiate saml login
authentication/oidc
GET
/v1
/authentication
/oidc
/{providerId}
GET
/v1
/authentication
/oidc
/callback
backup
POST
/v1
/backup
GET
/v1
/backup
GET
/v1
/backup
/{id}
PUT
/v1
/backup
/{id}
DELETE
/v1
/backup
/{id}
GET
/v1
/backup
/{id}
/download
POST
/v1
/backup
/{id}
/restore
POST
/v1
/backup
/upload
capabilities
GET
/v1
/capabilities
POST
/v1
/capabilities
GET
/v1
/capabilities
/{id}
PUT
/v1
/capabilities
/{id}
DELETE
/v1
/capabilities
/{id}
connectors/ldap
GET
/v1
/connectors
/ldap
POST
/v1
/connectors
/ldap
GET
/v1
/connectors
/ldap
/{id}
PUT
/v1
/connectors
/ldap
/{id}
DELETE
/v1
/connectors
/ldap
/{id}
connectors/oidc
GET
/v1
/connectors
/oidc
POST
/v1
/connectors
/oidc
GET
/v1
/connectors
/oidc
/{id}
PUT
/v1
/connectors
/oidc
/{id}
DELETE
/v1
/connectors
/oidc
/{id}
connectors/userpass
GET
/v1
/connectors
/userpass
POST
/v1
/connectors
/userpass
GET
/v1
/connectors
/userpass
/{id}
PUT
/v1
/connectors
/userpass
/{id}
DELETE
/v1
/connectors
/userpass
/{id}
counters
GET
/v1
/counters
/activity
active users and tokens
POST
/v1
/counters
/config
GET
/v1
/counters
/config
GET
/v1
/counters
/current
current users and tokens
GET
/v1
/counters
/http
http requests per month
GET
/v1
/counters
/tokens
total number of tokens
GET
/v1
/counters
/users
total number of users
credentials/aws/config
GET
/v1
/credentials
/aws
/config
POST
/v1
/credentials
/aws
/config
credentials/aws/generate
POST
/v1
/credentials
/aws
/roles
/{id}
/generate
credentials/aws/roles
POST
/v1
/credentials
/aws
/roles
GET
/v1
/credentials
/aws
/roles
GET
/v1
/credentials
/aws
/roles
/{id}
PUT
/v1
/credentials
/aws
/roles
/{id}
DELETE
/v1
/credentials
/aws
/roles
/{id}
credentials/azure/config
GET
/v1
/credentials
/azure
/config
POST
/v1
/credentials
/azure
/config
credentials/azure/generate
POST
/v1
/credentials
/azure
/roles
/{id}
/generate
credentials/azure/roles
POST
/v1
/credentials
/azure
/roles
GET
/v1
/credentials
/azure
/roles
GET
/v1
/credentials
/azure
/roles
/{id}
PUT
/v1
/credentials
/azure
/roles
/{id}
DELETE
/v1
/credentials
/azure
/roles
/{id}
default
POST
/v1
/migrate
/secrets
encryption
POST
/v1
/encryption
/decrypt
/{name}
POST
/v1
/encryption
/encrypt
/{name}
encryption/keys
POST
/v1
/encryption
/keys
GET
/v1
/encryption
/keys
GET
/v1
/encryption
/keys
/{id}
PUT
/v1
/encryption
/keys
/{id}
DELETE
/v1
/encryption
/keys
/{id}
POST
/v1
/encryption
/keys
/{id}
/rotate
fido
GET
/v1
/fido
/login
POST
/v1
/fido
/login
GET
/v1
/fido
/register
POST
/v1
/fido
/register
generate
POST
/v1
/generate
/passphrase
POST
/v1
/generate
/password
locker
GET
/v1
/locker
POST
/v1
/locker
DELETE
/v1
/locker
GET
/v1
/locker
/{path}
login
POST
/v1
/login
logout
POST
/v1
/logout
mySecrets
GET
/v1
/mySecrets
/folder
/{path}
Returns all of the secrets at the given path
GET
/v1
/mySecrets
/key
/{path}
Returns the secret at the given path
POST
/v1
/mySecrets
/key
/{path}
Create / Update a secret
DELETE
/v1
/mySecrets
/key
/{path}
Remove a secret
GET
/v1
/mySecrets
/list
Returns all secret folders
GET
/v1
/mySecrets
/raw
/{path}
Returns the raw secret data at the given path
oidc
GET
/v1
/identity
/oidc
/.well-known
/keys
GET
/v1
/identity
/oidc
/.well-known
/openid-configuration
PUT
/v1
/identity
/oidc
/{oidcRoleId}
/token
GET
/v1
/identity
/oidc
/configuration
PUT
/v1
/identity
/oidc
/configuration
POST
/v1
/identity
/oidc
/introspect
oidc/keys
GET
/v1
/oidc
/keys
POST
/v1
/oidc
/keys
GET
/v1
/oidc
/keys
/{id}
PUT
/v1
/oidc
/keys
/{id}
DELETE
/v1
/oidc
/keys
/{id}
oidc/roles
GET
/v1
/oidc
/roles
POST
/v1
/oidc
/roles
GET
/v1
/oidc
/roles
/{id}
PUT
/v1
/oidc
/roles
/{id}
DELETE
/v1
/oidc
/roles
/{id}
policies
GET
/v1
/policies
POST
/v1
/policies
GET
/v1
/policies
/{id}
PUT
/v1
/policies
/{id}
DELETE
/v1
/policies
/{id}
policy/match/capabilities
POST
/v1
/policy
/match
/capabilities
providers
GET
/v1
/providers
GET
/v1
/providers
/domain
/{name}
GET
/v1
/providers
/id
/{id}
GET
/v1
/providers
/sso
providers/jwt
GET
/v1
/providers
/jwt
POST
/v1
/providers
/jwt
GET
/v1
/providers
/jwt
/{id}
PUT
/v1
/providers
/jwt
/{id}
DELETE
/v1
/providers
/jwt
/{id}
POST
/v1
/providers
/jwt
/init
providers/jwt/roles
GET
/v1
/providers
/jwt
/{providerId}
/roles
POST
/v1
/providers
/jwt
/{providerId}
/roles
GET
/v1
/providers
/jwt
/{providerId}
/roles
/{id}
PUT
/v1
/providers
/jwt
/{providerId}
/roles
/{id}
DELETE
/v1
/providers
/jwt
/{providerId}
/roles
/{id}
providers/ldap
GET
/v1
/providers
/ldap
POST
/v1
/providers
/ldap
GET
/v1
/providers
/ldap
/{id}
PUT
/v1
/providers
/ldap
/{id}
DELETE
/v1
/providers
/ldap
/{id}
providers/oidc
GET
/v1
/providers
/oidc
POST
/v1
/providers
/oidc
GET
/v1
/providers
/oidc
/{id}
PUT
/v1
/providers
/oidc
/{id}
DELETE
/v1
/providers
/oidc
/{id}
providers/saml
GET
/v1
/providers
/saml
POST
/v1
/providers
/saml
GET
/v1
/providers
/saml
/{id}
PUT
/v1
/providers
/saml
/{id}
DELETE
/v1
/providers
/saml
/{id}
providers/userpass
GET
/v1
/providers
/userpass
POST
/v1
/providers
/userpass
GET
/v1
/providers
/userpass
/{id}
PUT
/v1
/providers
/userpass
/{id}
DELETE
/v1
/providers
/userpass
/{id}
rootkey
DELETE
/v1
/rootkey
GET
/v1
/rootkey
POST
/v1
/rootkey
PUT
/v1
/rootkey
POST
/v1
/rootkey
/decode
secrets
GET
/v1
/secrets
/folder
/{path}
Returns all of the secrets at the given path
GET
/v1
/secrets
/key
/{path}
Returns the secret at the given path
POST
/v1
/secrets
/key
/{path}
Create / Update a secret
DELETE
/v1
/secrets
/key
/{path}
Remove a secret
GET
/v1
/secrets
/list
Returns all secret folders
GET
/v1
/secrets
/raw
/{path}
Returns the raw secret data at the given path
system
POST
/v1
/system
/initialize
PUT
/v1
/system
/lock
PUT
/v1
/system
/policy-refresh
GET
/v1
/system
/status
PUT
/v1
/system
/unlock
token
POST
/v1
/token
/capabilities
POST
/v1
/token
/issue
POST
/v1
/token
/lookup
GET
/v1
/token
/lookup-self
POST
/v1
/token
/refresh
POST
/v1
/token
/refresh-self
POST
/v1
/token
/revoke
POST
/v1
/token
/revoke-self
totp
POST
/v1
/totp
GET
/v1
/totp
PUT
/v1
/totp
DELETE
/v1
/totp
POST
/v1
/totp
/validate
userGroups
GET
/v1
/usergroups
POST
/v1
/usergroups
GET
/v1
/usergroups
/{id}
PUT
/v1
/usergroups
/{id}
DELETE
/v1
/usergroups
/{id}
users
GET
/v1
/users
POST
/v1
/users
GET
/v1
/users
/{id}
PUT
/v1
/users
/{id}
DELETE
/v1
/users
/{id}
POST
/v1
/users
/{id}
/merge
Schemas
AwsCredentialConfigReadResponse
AwsCredentialConfigPayload
AwsCredentialConfigWriteResponse
AwsCredentialGeneratePayload
AwsCredentialGenerateResponse
AwsCredentialPayload
AwsCredentialRoleModel
AwsCredentialRoleCreateResponse
FindOneOptions
AwsCredentialRoleFindOneResponse
FindManyOptions
AwsCredentialRoleFindResponse
AwsCredentialRolelUpdateResponse
AzureCredentialConfigReadResponse
AzureCredentialConfigPayload
AzureCredentialConfigWriteResponse
AzureCredentialGenerateResponse
AzureCredentialPayload
AzureCredentialRoleModel
AzureCredentialRoleCreateResponse
AzureCredentialRoleFindOneResponse
AzureCredentialRoleFindResponse
AzureCredentialRolelUpdateResponse
InitPayload
InitResponse
ProviderType
PostSysAuthPathTune
ApplicationKey
ApplicationRole
Provider
CapabilityModel
PolicyCapabilityLink
PolicyModel
UserGroup
Device
User
Connector
ProviderResponse
SSOProviderResponse
ProviderUserpass
ProviderUserpassPayload
ApplicationRolePayload
ApplicationKeyPayload
SecretsTypeDto
SecretsMetadata
SecretReadRawResponse
SecretFindManyResponse
SecretReadResponse
SecretsListResponse
SecretsWritePayload
SecretCreateResponse
DeletedResponse
GeneratePassphrasePayload
GeneratePassphraseResponse
GeneratePasswordPayload
GeneratePasswordResponse
UnlockPayload
UnlockResponse
ApiResponse
RootkeyProgressResponse
RootkeyStartPayload
RootkeyStartResponse
RootkeyDecodePayload
RootkeyDecodeResponse
RootkeySubmitPayload
RootkeySubmitResponse
PolicyFindResponse
PolicyPayload
PolicyFindOneResponse
PolicyUpdateResponse
PolicyMatchCapabilityPayload
PolicyMatchCapabilitySearchResponse
EncryptionEncryptPayload
EncryptionEncryptResponse
EncryptionDecryptPayload
EncryptionDecryptResponse
EncryptionKeysPayload
EncryptionKey
EncryptionKeysConfigPayload
DeleteEncryptionKeysNameResponse
CapabilityFindResponse
CapabilityPayload
CapabilityCreateResponse
CapabilityFindOneResponse
CapabilityUpdateResponse
UserGroupPayload
UserMergePayload
UserPayload
TotpValidatePayload
LoginMfa
LoginResponse
TotpKeyCreatePayload
TotpKeyCreateResponse
TotpKeyResponse
TotpKeyUpdatePayload
DeleteCredentialsTotpKeysNameResponse
LockerReadResponse
LockerWritePayload
PostSecretsDataPathResponse
UserConnectorUserpass
UserConnectorUserpassPayload
LoginPayload
GetIdentityOidcConfigResponse
ApplicationGenerateTokenPayload
ApplicationGenerateTokenResponse
ApplicationConfigPayload
PostIdentityOidcConfigResponse
ApplicationIntrospectTokenPayload
PostIdentityOidcIntrospectResponse
GetIdentityOidcWellKnownOpenidConfigurationResponse
IdentityOidcWellKnownKey
GetIdentityOidcWellKnownKeysResponse
TokenLookupPayload
Token
TokenRefreshPayload
TokenRefreshResponse
TokenRefreshSelfPayload
TokenRefreshSelfResponse
TokenCapabilitiesPayload
TokenCapabilitiesResponse
TokenIssuePayload
TokenIssueResponse
ProviderLdapConfigPayload
ProviderLdap
ProviderLdapPayload
FidoUser
FidoError
FidoStartRegistrationResponse
FidoEndRegistrationPayload
FidoEndRegistrationResponse
FidoStartAuthenticationResponse
FidoEndAuthenticationPayload
ProviderJwtConfigPayload
ProviderJwt
ProviderJwtRole
ProviderJwtPayload
ProviderJwtRolePayload
BackupPayload
BackupModel
StreamableFile
UploadPayload
RestorePayload
RestoreResponse
StatusResponse
CountersConfigPayload
CountersConfigWriteResponse
CountersConfigReadResponse
HttpCounter
GetSysInternalCountersHttpResponse
CountersHttpRequestsResponse
CountersUsersResponse
CountersTokenResponse
CountersActivityResponse
CountersCurrentResponse
UserConnectorLdapPayload
UserConnectorOidcPayload
ProviderSamlConfigDto
ProviderSamlDto
ProviderSamlConfigPayload
ProviderSamlPayload
ProviderOidcConfigPayload
ProviderOidcRole
ProviderOidc
ProviderOidcPayload
SecretCustomProperties
SecretLogin
SecretCard
SecretSecureNote
SecretType