Account Manager
locales
accountManager.locales
List locales supported by DigiCert ONE Account Manager.
Risk: read
await corsair.digicert.api.accountManager.locales({});
digicert_one_api_key, sent as x-api-key.
Output: object[]
Output full type
Output full type
{
code?: de_DE | en_US | es_ES | fr_FR | it_IT | ja_JP | ko_KR | pt_PT | ru_RU | zh_CN | zh_TW | string,
language?: Deutsch | English | Español | Français | Italiano | 日本語 | 한국어 | Português | Русский | 简体中文 | 繁體中文 | string
}[]
Account Manager Api
createAccount
accountManagerApi.createAccount
Create account
Risk: write
await corsair.digicert.api.accountManagerApi.createAccount({
body: {
name: 'example',
service_period: { to: 'example' },
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
name: string,
service_period: {
from?: string,
to: string
},
is_standard_login?: boolean,
mfa_enabled?: boolean,
locale?: string,
type?: standard | partner,
partner_account_id?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | string | No | — |
createApiToken
accountManagerApi.createApiToken
Create API key
Risk: write
await corsair.digicert.api.accountManagerApi.createApiToken({
body: { name: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
name: string,
end_date?: string,
user_id?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | string | No | — |
user_id | string | No | — |
name | string | No | — |
token | string | No | — |
end_date | string | No | — |
start_date | string | No | — |
active | boolean | No | — |
enabled | boolean | No | — |
masked_api_key | string | No | — |
createClientAuthCertificate
accountManagerApi.createClientAuthCertificate
Generate client authentication certificate
Risk: write
await corsair.digicert.api.accountManagerApi.createClientAuthCertificate({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
csr: string,
name: string,
expiration_date: string
}
object
Output full type
Output full type
{
id?: string,
user_id?: string,
name?: string,
common_name?: string,
end_date?: string,
start_date?: string,
enabled?: boolean,
serial_number?: string,
public_key?: string
}& {
x509_cert?: string,
ca_cert?: string
}
createUser
accountManagerApi.createUser
Create user
Risk: write
await corsair.digicert.api.accountManagerApi.createUser({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
user_type?: standard | service,
user_name: string,
first_name: string,
last_name: string,
end_date?: string,
friendly_name: string,
roles: string[],
permissions?: string[],
description?: string,
accounts: string[],
email: string,
locale?: string,
phone_number?: string,
password?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | string | No | — |
email | string | No | — |
status | ACTIVE | DELETED | PENDING | LOCKED | string | No | — |
access_scope | account | string | No | — |
primary_account_id | string | No | — |
created_at | string | No | — |
friendly_name | string | No | — |
description | string | No | — |
end_date | string | No | — |
api_token | object | No | — |
accounts | object[] | No | — |
applications | object[] | No | — |
api_token full type
api_token full type
{
id?: string,
user_id?: string,
name?: string,
token?: string,
end_date?: string,
start_date?: string,
active?: boolean,
enabled?: boolean,
masked_api_key?: string
}
accounts full type
accounts full type
{
id?: string,
name?: string,
active?: boolean,
service_period?: {
from?: string,
to?: string
},
friendly_identifier?: string,
admins?: {
id?: string,
name?: string,
email?: string
}[],
auth_config?: {
id?: string,
status?: string
}[],
sign_in_methods?: {
mfaStatus?: enabled | disabled | string,
signInMethod?: standard | sso | string,
status?: enabled | disabled | string,
clientAuthCertLoginEnabled?: boolean
}[],
oauth_clients?: {
id?: string,
name?: string,
status?: ENABLED | DISABLED | string,
oauthClientId?: string,
oauthClientAccountId?: string
}[],
locale?: string,
type?: standard | partner | string,
federated_account_id?: string,
packages?: {
package_code?: string,
application_code?: string
}[]
}[]
applications full type
applications full type
{
id?: string,
name?: string,
app_code?: account_manager | ca_manager | device_manager | enterprise_manager | secure_software_manager | document_signing_manager,
optional?: boolean,
app_name?: Account | CA | Trust Lifecycle | IOT Trust | Software Trust | Document Trust,
icon?: string,
url?: string,
context?: string,
short_app_code?: string,
permissions?: string[],
roles?: string[]
}[]
deleteApiToken
accountManagerApi.deleteApiToken
Delete API key
Risk: destructive
await corsair.digicert.api.accountManagerApi.deleteApiToken({
path: { id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
deleteUser
accountManagerApi.deleteUser
Delete user
Risk: destructive
await corsair.digicert.api.accountManagerApi.deleteUser({
path: { user_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
user_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
enableClientAuthCertificate
accountManagerApi.enableClientAuthCertificate
Enable/disable client authentication certificate
Risk: write
await corsair.digicert.api.accountManagerApi.enableClientAuthCertificate({
path: { certificate_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
certificate_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
enabled?: boolean
}
| Name | Type | Required | Description |
|---|---|---|---|
id | string | No | — |
user_id | string | No | — |
name | string | No | — |
common_name | string | No | — |
end_date | string | No | — |
start_date | string | No | — |
enabled | boolean | No | — |
serial_number | string | No | — |
public_key | string | No | — |
getAccountDetails
accountManagerApi.getAccountDetails
Get account details
Risk: read
await corsair.digicert.api.accountManagerApi.getAccountDetails({
path: { account_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
account_id: string
}
query full type
query full type
{
is_federated_account_id?: boolean
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | string | No | — |
name | string | No | — |
active | boolean | No | — |
service_period | object | No | — |
friendly_identifier | string | No | — |
admins | object[] | No | — |
auth_config | object[] | No | — |
sign_in_methods | object[] | No | — |
oauth_clients | object[] | No | — |
locale | string | No | — |
type | standard | partner | string | No | — |
federated_account_id | string | No | — |
packages | object[] | No | — |
service_period full type
service_period full type
{
from?: string,
to?: string
}
admins full type
admins full type
{
id?: string,
name?: string,
email?: string
}[]
auth_config full type
auth_config full type
{
id?: string,
status?: string
}[]
sign_in_methods full type
sign_in_methods full type
{
mfaStatus?: enabled | disabled | string,
signInMethod?: standard | sso | string,
status?: enabled | disabled | string,
clientAuthCertLoginEnabled?: boolean
}[]
oauth_clients full type
oauth_clients full type
{
id?: string,
name?: string,
status?: ENABLED | DISABLED | string,
oauthClientId?: string,
oauthClientAccountId?: string
}[]
packages full type
packages full type
{
package_code?: string,
application_code?: string
}[]
getApiTokenById
accountManagerApi.getApiTokenById
Get API key by ID
Risk: read
await corsair.digicert.api.accountManagerApi.getApiTokenById({
path: { id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | string | No | — |
user_id | string | No | — |
name | string | No | — |
token | string | No | — |
end_date | string | No | — |
start_date | string | No | — |
active | boolean | No | — |
enabled | boolean | No | — |
masked_api_key | string | No | — |
getClientAuthCertificatesByUserId
accountManagerApi.getClientAuthCertificatesByUserId
Get all client authentication certificates
Risk: read
await corsair.digicert.api.accountManagerApi.getClientAuthCertificatesByUserId({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
user_id?: string
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
object[]
Output full type
Output full type
(
{
id?: string,
user_id?: string,
name?: string,
common_name?: string,
end_date?: string,
start_date?: string,
enabled?: boolean,
serial_number?: string,
public_key?: string
}& {
x509_cert?: string,
ca_cert?: string
}
)[]
getOrganizationDetails
accountManagerApi.getOrganizationDetails
Get organization details
Risk: read
await corsair.digicert.api.accountManagerApi.getOrganizationDetails({
path: { organization_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
organization_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | string | No | — |
name | string | No | — |
address | string | No | — |
address2 | string | No | — |
zip_code | string | No | — |
city | string | No | — |
state | string | No | — |
country | string | No | — |
phone | string | No | — |
account | object | No | — |
active | boolean | No | — |
editable | boolean | No | — |
account full type
account full type
{
id?: string,
name?: string
}
getUserDetails
accountManagerApi.getUserDetails
Get user details
Risk: read
await corsair.digicert.api.accountManagerApi.getUserDetails({
path: { user_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
user_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | string | No | — |
user_name | string | No | — |
saml_user_name | string | No | — |
oidc_user_name | string | No | — |
first_name | string | No | — |
last_name | string | No | — |
email | string | No | — |
phone | string | No | — |
status | ACTIVE | DELETED | PENDING | LOCKED | string | No | — |
access_scope | account | string | No | — |
active | boolean | No | — |
primary_account_id | string | No | — |
created_at | string | No | — |
created_by | string | No | — |
user_type | standard | service | string | No | — |
friendly_name | string | No | — |
description | string | No | — |
end_date | string | No | — |
locale | string | No | — |
user_confirmed_lang | boolean | No | — |
disable_api_access_token | boolean | No | — |
disable_cac_upload | boolean | No | — |
applications | any[] | No | — |
accounts | object[] | No | — |
accounts full type
accounts full type
{
id?: string,
name?: string,
active?: boolean,
service_period?: {
from?: string,
to?: string
},
friendly_identifier?: string,
admins?: {
id?: string,
name?: string,
email?: string
}[],
auth_config?: {
id?: string,
status?: string
}[],
sign_in_methods?: {
mfaStatus?: enabled | disabled | string,
signInMethod?: standard | sso | string,
status?: enabled | disabled | string,
clientAuthCertLoginEnabled?: boolean
}[],
oauth_clients?: {
id?: string,
name?: string,
status?: ENABLED | DISABLED | string,
oauthClientId?: string,
oauthClientAccountId?: string
}[],
locale?: string,
type?: standard | partner | string,
federated_account_id?: string,
packages?: {
package_code?: string,
application_code?: string
}[]
}[]
listAccounts
accountManagerApi.listAccounts
List accounts
Risk: read
await corsair.digicert.api.accountManagerApi.listAccounts({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
active?: all | true | false,
name?: string,
account_ids?: string[]
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
object[]
Output full type
Output full type
{
id?: string,
name?: string,
active?: boolean,
service_period?: {
from?: string,
to?: string
},
friendly_identifier?: string,
admins?: {
id?: string,
name?: string,
email?: string
}[],
auth_config?: {
id?: string,
status?: string
}[],
sign_in_methods?: {
mfaStatus?: enabled | disabled | string,
signInMethod?: standard | sso | string,
status?: enabled | disabled | string,
clientAuthCertLoginEnabled?: boolean
}[],
oauth_clients?: {
id?: string,
name?: string,
status?: ENABLED | DISABLED | string,
oauthClientId?: string,
oauthClientAccountId?: string
}[],
locale?: string,
type?: standard | partner | string,
federated_account_id?: string,
packages?: {
package_code?: string,
application_code?: string
}[]
}[]
listAllUsers
accountManagerApi.listAllUsers
List all users
Risk: read
await corsair.digicert.api.accountManagerApi.listAllUsers({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
account_id?: string,
user_type?: service | standard,
user_name?: string,
email?: string,
status?: active | disabled | pending | locked | deleted
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
object[]
Output full type
Output full type
{
id?: string,
user_name?: string,
saml_user_name?: string,
oidc_user_name?: string,
first_name?: string,
last_name?: string,
email?: string,
phone?: string,
status?: ACTIVE | DELETED | PENDING | LOCKED | string,
access_scope?: account | string,
active?: boolean,
primary_account_id?: string,
created_at?: string,
created_by?: string,
user_type?: standard | service | string,
friendly_name?: string,
description?: string,
end_date?: string,
locale?: string,
user_confirmed_lang?: boolean,
disable_api_access_token?: boolean,
disable_cac_upload?: boolean,
applications?: any[],
accounts?: {
id?: string,
name?: string,
active?: boolean,
service_period?: {
from?: string,
to?: string
},
friendly_identifier?: string,
admins?: {
id?: string,
name?: string,
email?: string
}[],
auth_config?: {
id?: string,
status?: string
}[],
sign_in_methods?: {
mfaStatus?: enabled | disabled | string,
signInMethod?: standard | sso | string,
status?: enabled | disabled | string,
clientAuthCertLoginEnabled?: boolean
}[],
oauth_clients?: {
id?: string,
name?: string,
status?: ENABLED | DISABLED | string,
oauthClientId?: string,
oauthClientAccountId?: string
}[],
locale?: string,
type?: standard | partner | string,
federated_account_id?: string,
packages?: {
package_code?: string,
application_code?: string
}[]
}[]
}[]
listApiTokens
accountManagerApi.listApiTokens
List API keys
Risk: read
await corsair.digicert.api.accountManagerApi.listApiTokens({
query: { user_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
user_id: string
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
object[]
Output full type
Output full type
{
id?: string,
user_id?: string,
name?: string,
token?: string,
end_date?: string,
start_date?: string,
active?: boolean,
enabled?: boolean,
masked_api_key?: string
}[]
listAuditLogs
accountManagerApi.listAuditLogs
List audit log entries
Risk: read
await corsair.digicert.api.accountManagerApi.listAuditLogs({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
user_name?: string,
action?: CREATE | UPDATE | DELETE | LOGIN | EXPIRE | LOGOUT | UPDATE_PASSWORD | RESET_PASSWORD | TERMS_AND_CONDITIONS | LOGIN_ERROR | SEND_RESET_PASSWORD | UPDATE_TOTP | DISABLED | ENABLED | LICENSE_REGISTERED | LOW_LICENSE_WARNING_SENT | ACCOUNT_EXPIRY_EMAIL_SENT | API_ACCESS_TOKEN_EXPIRY_EMAIL_SENT | CLIENT_AUTH_CERT_EXPIRY_EMAIL_SENT | FEATURE_ENABLED | FEATURE_DISABLED | SERVICE_USER_EXPIRY_EMAIL_SENT | SAML_IDP_CERT_EXPIRY_EMAIL_SENT | RESET_PASSWORD_ERROR | LINK_ACCOUNT | LINK_USER | MIGRATE_ACCOUNT | MIGRATE_USER | PACKAGE_SELECTED | PACKAGE_UPGRADED | MIGRATE_ROLES,
resource_types?: ACCOUNT | USER | SERVICE_USER | APIKEY | CLIENT_AUTH_CERT | SAML2_CONFIG | OIDC_CONFIG | SSO_SAML | BASIC_AUTH | DIGEST_AUTH | OAUTH_CLIENT | OAUTH_CONFIG | LICENSE | BASIC_AUTH_MFA | SSO_SAML_MFA | CLIENT_AUTH_CERT_MFA | SSO_OIDC | SSO_OIDC_MFA | DIGICERT | DIGICERT_MFA | ROLE | ORGANIZATION | SSO_OIDC_IDP_MFA,
resource_id?: string,
status?: SUCCESS | FAILURE,
account_id?: string,
from?: string,
to?: string,
sort?: string,
offset?: number,
limit?: number
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
total | number | No | — |
offset | number | No | — |
limit | number | No | — |
items | object[] | No | — |
items full type
items full type
{
id?: string,
account?: {
id?: string,
name?: string
},
resource_type?: string,
resource_id?: string,
resource_name?: string,
action?: string,
user?: {
id?: string,
name?: string
},
timestamp?: string,
description?: string,
status?: success | failure | string,
client_ip?: string
}[]
listOrganizations
accountManagerApi.listOrganizations
List organizations
Risk: read
await corsair.digicert.api.accountManagerApi.listOrganizations({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
account_id?: string
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
object[]
Output full type
Output full type
{
id?: string,
name?: string,
address?: string,
address2?: string,
zip_code?: string,
city?: string,
state?: string,
country?: string,
phone?: string,
account?: {
id?: string,
name?: string
},
active?: boolean,
editable?: boolean
}[]
listSelectUsers
accountManagerApi.listSelectUsers
List select users
Risk: write
await corsair.digicert.api.accountManagerApi.listSelectUsers({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | string[] | No | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
object[]
Output full type
Output full type
{
id?: string,
user_name?: string,
saml_user_name?: string,
oidc_user_name?: string,
first_name?: string,
last_name?: string,
email?: string,
phone?: string,
status?: ACTIVE | DELETED | PENDING | LOCKED | string,
access_scope?: account | string,
active?: boolean,
primary_account_id?: string,
created_at?: string,
created_by?: string,
user_type?: standard | service | string,
friendly_name?: string,
description?: string,
end_date?: string,
locale?: string,
user_confirmed_lang?: boolean,
disable_api_access_token?: boolean,
disable_cac_upload?: boolean,
applications?: any[],
accounts?: {
id?: string,
name?: string,
active?: boolean,
service_period?: {
from?: string,
to?: string
},
friendly_identifier?: string,
admins?: {
id?: string,
name?: string,
email?: string
}[],
auth_config?: {
id?: string,
status?: string
}[],
sign_in_methods?: {
mfaStatus?: enabled | disabled | string,
signInMethod?: standard | sso | string,
status?: enabled | disabled | string,
clientAuthCertLoginEnabled?: boolean
}[],
oauth_clients?: {
id?: string,
name?: string,
status?: ENABLED | DISABLED | string,
oauthClientId?: string,
oauthClientAccountId?: string
}[],
locale?: string,
type?: standard | partner | string,
federated_account_id?: string,
packages?: {
package_code?: string,
application_code?: string
}[]
}[]
}[]
listUserRoles
accountManagerApi.listUserRoles
List user roles
Risk: read
await corsair.digicert.api.accountManagerApi.listUserRoles({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
application_code?: account_manager | ca_manager | device_manager | document_signing_manager | enterprise_manager | secure_software_manager,
account_id?: string
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
ca_manager | object[] | No | — |
account_manager | object[] | No | — |
secure_software_manager | object[] | No | — |
enterprise_manager | object[] | No | — |
device_manager | object[] | No | — |
document_signing_manager | object[] | No | — |
device_trust_manager | object[] | No | — |
ca_manager full type
ca_manager full type
{
id?: string,
name?: string,
display_name?: string,
description?: string,
type?: string,
status?: ACTIVE | ARCHIVED | string,
access_scope?: account | string
}[]
account_manager full type
account_manager full type
{
id?: string,
name?: string,
display_name?: string,
description?: string,
type?: string,
status?: ACTIVE | ARCHIVED | string,
access_scope?: account | string
}[]
secure_software_manager full type
secure_software_manager full type
{
id?: string,
name?: string,
display_name?: string,
description?: string,
type?: string,
status?: ACTIVE | ARCHIVED | string,
access_scope?: account | string
}[]
enterprise_manager full type
enterprise_manager full type
{
id?: string,
name?: string,
display_name?: string,
description?: string,
type?: string,
status?: ACTIVE | ARCHIVED | string,
access_scope?: account | string
}[]
device_manager full type
device_manager full type
{
id?: string,
name?: string,
display_name?: string,
description?: string,
type?: string,
status?: ACTIVE | ARCHIVED | string,
access_scope?: account | string
}[]
document_signing_manager full type
document_signing_manager full type
{
id?: string,
name?: string,
display_name?: string,
description?: string,
type?: string,
status?: ACTIVE | ARCHIVED | string,
access_scope?: account | string
}[]
device_trust_manager full type
device_trust_manager full type
{
id?: string,
name?: string,
display_name?: string,
description?: string,
type?: string,
status?: ACTIVE | ARCHIVED | string,
access_scope?: account | string
}[]
updateAccount
accountManagerApi.updateAccount
Update account
Risk: write
await corsair.digicert.api.accountManagerApi.updateAccount({
path: { account_id: 'example' },
body: {
name: 'example',
service_period: { to: 'example' },
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
account_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
name: string,
service_period: {
from?: string,
to: string
},
is_standard_login?: boolean,
mfa_enabled?: boolean,
locale?: string,
type?: standard | partner,
partner_account_id?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | string | No | — |
name | string | No | — |
active | boolean | No | — |
service_period | object | No | — |
friendly_identifier | string | No | — |
admins | object[] | No | — |
auth_config | object[] | No | — |
sign_in_methods | object[] | No | — |
oauth_clients | object[] | No | — |
locale | string | No | — |
type | standard | partner | string | No | — |
federated_account_id | string | No | — |
packages | object[] | No | — |
service_period full type
service_period full type
{
from?: string,
to?: string
}
admins full type
admins full type
{
id?: string,
name?: string,
email?: string
}[]
auth_config full type
auth_config full type
{
id?: string,
status?: string
}[]
sign_in_methods full type
sign_in_methods full type
{
mfaStatus?: enabled | disabled | string,
signInMethod?: standard | sso | string,
status?: enabled | disabled | string,
clientAuthCertLoginEnabled?: boolean
}[]
oauth_clients full type
oauth_clients full type
{
id?: string,
name?: string,
status?: ENABLED | DISABLED | string,
oauthClientId?: string,
oauthClientAccountId?: string
}[]
packages full type
packages full type
{
package_code?: string,
application_code?: string
}[]
updateApiToken
accountManagerApi.updateApiToken
Update API key
Risk: write
await corsair.digicert.api.accountManagerApi.updateApiToken({
path: { id: 'example' },
body: { name: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
name: string,
end_date?: string,
enabled?: boolean
}
| Name | Type | Required | Description |
|---|---|---|---|
id | string | No | — |
user_id | string | No | — |
name | string | No | — |
token | string | No | — |
end_date | string | No | — |
start_date | string | No | — |
active | boolean | No | — |
enabled | boolean | No | — |
masked_api_key | string | No | — |
updateUser
accountManagerApi.updateUser
Update user
Risk: write
await corsair.digicert.api.accountManagerApi.updateUser({
path: { user_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
user_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
user_type?: standard | service,
user_name: string,
first_name: string,
last_name: string,
end_date?: string,
friendly_name: string,
roles: string[],
permissions?: string[],
description?: string,
accounts: string[],
email: string,
locale?: string,
phone_number?: string,
password?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | string | No | — |
email | string | No | — |
status | ACTIVE | DELETED | PENDING | LOCKED | string | No | — |
access_scope | account | string | No | — |
primary_account_id | string | No | — |
created_at | string | No | — |
friendly_name | string | No | — |
description | string | No | — |
end_date | string | No | — |
api_token | object | No | — |
accounts | object[] | No | — |
applications | object[] | No | — |
api_token full type
api_token full type
{
id?: string,
user_id?: string,
name?: string,
token?: string,
end_date?: string,
start_date?: string,
active?: boolean,
enabled?: boolean,
masked_api_key?: string
}
accounts full type
accounts full type
{
id?: string,
name?: string,
active?: boolean,
service_period?: {
from?: string,
to?: string
},
friendly_identifier?: string,
admins?: {
id?: string,
name?: string,
email?: string
}[],
auth_config?: {
id?: string,
status?: string
}[],
sign_in_methods?: {
mfaStatus?: enabled | disabled | string,
signInMethod?: standard | sso | string,
status?: enabled | disabled | string,
clientAuthCertLoginEnabled?: boolean
}[],
oauth_clients?: {
id?: string,
name?: string,
status?: ENABLED | DISABLED | string,
oauthClientId?: string,
oauthClientAccountId?: string
}[],
locale?: string,
type?: standard | partner | string,
federated_account_id?: string,
packages?: {
package_code?: string,
application_code?: string
}[]
}[]
applications full type
applications full type
{
id?: string,
name?: string,
app_code?: account_manager | ca_manager | device_manager | enterprise_manager | secure_software_manager | document_signing_manager,
optional?: boolean,
app_name?: Account | CA | Trust Lifecycle | IOT Trust | Software Trust | Document Trust,
icon?: string,
url?: string,
context?: string,
short_app_code?: string,
permissions?: string[],
roles?: string[]
}[]
Certcentral Api
accountDetails
certcentralApi.accountDetails
Account details
Risk: read
await corsair.digicert.api.certcentralApi.accountDetails({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
make_renewal_calls | boolean | No | — |
express_install_enabled | boolean | No | — |
admin_email | string | No | — |
display_rep | boolean | No | — |
rep_name | string | No | — |
rep_phone | string | No | — |
rep_email | string | No | — |
balance_negative_limit | number | No | — |
pricing_model | string | No | — |
cert_transparency | string | No | — |
cert_central_type | string | No | — |
is_reseller_customer | boolean | No | — |
acmeExternalAccountBinding
certcentralApi.acmeExternalAccountBinding
ACME External Account Binding
Risk: write
await corsair.digicert.api.certcentralApi.acmeExternalAccountBinding({
body: {
name: 'example',
product_name_id: 'example',
validity_years: 1,
metadata_id: 1,
value: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
name?: string,
product_name_id?: string,
organization_id?: number,
validity_years?: number,
validity_days?: number,
profile_option?: string,
container_id?: number,
custom_fields?: JsonValue[],
metadata_id?: number,
value?: string,
ca_cert_id?: string,
order_validity_days?: number,
order_validity_years?: number,
sans?: JsonValue[],
allowed_order_count?: number
}
| Name | Type | Required | Description |
|---|---|---|---|
acme_directory_url | string | No | — |
ext_act_kid | string | No | — |
ext_act_hmac | string | No | — |
activateContainer
certcentralApi.activateContainer
Activate container
Risk: write
await corsair.digicert.api.certcentralApi.activateContainer({
path: { container_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | JsonValue | No | — |
path full type
path full type
{
container_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
activateDomain
certcentralApi.activateDomain
Activate domain
Risk: write
await corsair.digicert.api.certcentralApi.activateDomain({
path: { domain_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | JsonValue | No | — |
path full type
path full type
{
domain_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
activateDomainLocking
certcentralApi.activateDomainLocking
Activate domain locking
Risk: write
await corsair.digicert.api.certcentralApi.activateDomainLocking({
path: { domain_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | JsonValue | No | — |
path full type
path full type
{
domain_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
activateOrganization
certcentralApi.activateOrganization
Activate organization
Risk: write
await corsair.digicert.api.certcentralApi.activateOrganization({
path: { organization_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | JsonValue | No | — |
path full type
path full type
{
organization_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
addCustomField
certcentralApi.addCustomField
Add custom field
Risk: write
await corsair.digicert.api.certcentralApi.addCustomField({
body: { label: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
label: string,
is_required?: boolean,
is_active?: boolean,
data_type?: string,
show_in_receipt?: boolean
}
JsonValue
addDomain
certcentralApi.addDomain
Add domain
Risk: write
await corsair.digicert.api.certcentralApi.addDomain({
body: {
name: 'example',
organization: 'example',
id: 1,
validations: ['example'],
type: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
name?: string,
organization?: JsonValue,
id?: number,
validations?: JsonValue[],
type?: string,
dcv_method?: string,
locale?: string,
email_array?: JsonValue[],
keep_www?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
validation_emails | JsonValue | No | — |
name_scope | string | No | — |
base_emails | JsonValue[] | No | — |
email_array | JsonValue[] | No | — |
dcv_token | JsonValue | No | — |
token | string | No | — |
status | string | No | — |
expiration_date | string | No | — |
http_token_url | string | No | — |
addIpRestriction
certcentralApi.addIpRestriction
Add IP restriction
Risk: write
await corsair.digicert.api.certcentralApi.addIpRestriction({
path: { container_id: 'example' },
body: { ip_address: 'example', ip_address_end: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
container_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
ip_address: string,
ip_address_end: string,
user_id?: number,
api_key_id?: number,
description?: string
}
JsonValue
additionalEmails
certcentralApi.additionalEmails
Additional emails
Risk: write
await corsair.digicert.api.certcentralApi.additionalEmails({
path: { order_id: 'example' },
body: {
additional_emails: ['example'],
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
additional_emails: JsonValue[]
}
JsonValue
addNote
certcentralApi.addNote
Add note
Risk: write
await corsair.digicert.api.certcentralApi.addNote({
path: { certificate_id: 'example' },
body: { text: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
certificate_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
text: string
}
JsonValue
addNote_504f5354
certcentralApi.addNote_504f5354
Add note
Risk: write
await corsair.digicert.api.certcentralApi.addNote_504f5354({
path: { order_id: 'example' },
body: { text: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
text: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
date_created | string | No | — |
text | string | No | — |
user | JsonValue | No | — |
first_name | string | No | — |
last_name | string | No | — |
email | string | No | — |
addOrRemoveFunds
certcentralApi.addOrRemoveFunds
Add or remove funds
Risk: destructive
await corsair.digicert.api.certcentralApi.addOrRemoveFunds({
path: { subaccount_id: 'example' },
body: { amount: 1, transaction_type: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
subaccount_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
amount: number,
transaction_type: string
}
JsonValue
addServiceUserAddServiceUser
certcentralApi.addServiceUserAddServiceUser
Add service user — Add service user
Risk: write
await corsair.digicert.api.certcentralApi.addServiceUserAddServiceUser({
body: { is_api_only: true, email: 'jane.doe@example.com', api_name: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
is_api_only?: boolean,
email?: string,
api_name?: string,
restricted_to_role_id?: number,
container_id_assignments?: JsonValue[]
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
api_key | string | No | — |
addUserAddUser
certcentralApi.addUserAddUser
Add user — Add user
Risk: write
await corsair.digicert.api.certcentralApi.addUserAddUser({
body: {
username: 'example',
first_name: 'example',
last_name: 'example',
email: 'jane.doe@example.com',
access_roles: ['example'],
container_id_assignments: ['example'],
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
username: string,
first_name: string,
last_name: string,
email: string,
job_title?: string,
telephone?: string,
container?: JsonValue,
id?: number,
access_roles: JsonValue[],
container_id_assignments?: JsonValue[],
is_saml_sso_only?: boolean
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
allowlistIssuingCertificateAuthority
certcentralApi.allowlistIssuingCertificateAuthority
Allowlist issuing certificate authority
Risk: write
await corsair.digicert.api.certcentralApi.allowlistIssuingCertificateAuthority({
body: { issuer_brand: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
issuer_brand: string,
disable_email_notification_flag?: boolean,
trusted_ica_flag?: boolean
}
JsonValue
approveUserInvitation
certcentralApi.approveUserInvitation
Approve user invitation
Risk: write
await corsair.digicert.api.certcentralApi.approveUserInvitation({
path: { invitation_id: 'example' },
body: {
status: 'example',
requested_user: 'example',
container_id_assignments: ['example'],
access_roles: ['example'],
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
invitation_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
status?: string,
processor_comment?: string,
requested_user?: JsonValue,
container_id_assignments?: JsonValue[],
access_roles?: JsonValue[]
}
JsonValue
archiveCertificate
certcentralApi.archiveCertificate
Archive certificate
Risk: write
await corsair.digicert.api.certcentralApi.archiveCertificate({
path: { certificate_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | JsonValue | No | — |
path full type
path full type
{
certificate_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
authKeyDetails
certcentralApi.authKeyDetails
AuthKey details
Risk: read
await corsair.digicert.api.certcentralApi.authKeyDetails({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
balanceDetails
certcentralApi.balanceDetails
Balance details
Risk: read
await corsair.digicert.api.certcentralApi.balanceDetails({
path: { subaccount_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
subaccount_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
amount | number | No | — |
currency | string | No | — |
bulkAddFields
certcentralApi.bulkAddFields
Bulk add fields
Risk: write
await corsair.digicert.api.certcentralApi.bulkAddFields({
body: {
metadata: ['example'],
label: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
metadata?: JsonValue[],
label?: string,
is_required?: boolean,
is_active?: boolean,
data_type?: string
}
JsonValue
cancelUnitOrder
certcentralApi.cancelUnitOrder
Cancel unit order
Risk: destructive
await corsair.digicert.api.certcentralApi.cancelUnitOrder({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | JsonValue | No | — |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
cancelVoucherCode
certcentralApi.cancelVoucherCode
Cancel voucher code
Risk: destructive
await corsair.digicert.api.certcentralApi.cancelVoucherCode({
path: { id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | JsonValue | No | — |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
certificateChain
certcentralApi.certificateChain
Certificate chain
Risk: read
await corsair.digicert.api.certcentralApi.certificateChain({
path: { certificate_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
certificate_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
intermediates | JsonValue[] | No | — |
subject_common_name | string | No | — |
pem | string | No | — |
certificateFormatMap
certcentralApi.certificateFormatMap
Certificate format map
Risk: read
await corsair.digicert.api.certcentralApi.certificateFormatMap({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
name | string | No | — |
install_url | string | No | — |
csr_url | string | No | — |
best_format | string | No | — |
changeCtStatus
certcentralApi.changeCtStatus
Change CT status
Risk: write
await corsair.digicert.api.certcentralApi.changeCtStatus({
path: { order_id: 'example' },
body: { disable_ct: true },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
disable_ct: boolean
}
JsonValue
changeDcvMethod
certcentralApi.changeDcvMethod
Change DCV method
Risk: write
await corsair.digicert.api.certcentralApi.changeDcvMethod({
path: { domain_id: 'example' },
body: { dcv_method: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
domain_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
dcv_method: string,
locale?: string,
send_dcv_email_flag?: boolean,
email_array?: JsonValue[]
}
| Name | Type | Required | Description |
|---|---|---|---|
validation_emails | JsonValue | No | — |
name_scope | string | No | — |
base_emails | JsonValue[] | No | — |
email_array | JsonValue[] | No | — |
dcv_token | string | No | — |
token | string | No | — |
status | string | No | — |
expiration_date | string | No | — |
verification_value | string | No | — |
http_token_url | string | No | — |
changeOrderContainer
certcentralApi.changeOrderContainer
Change order container
Risk: write
await corsair.digicert.api.certcentralApi.changeOrderContainer({
path: { order_id: 'example', container_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | JsonValue | No | — |
path full type
path full type
{
order_id: string,
container_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
changeUserRole
certcentralApi.changeUserRole
Change user role
Risk: write
await corsair.digicert.api.certcentralApi.changeUserRole({
path: { user_id: 'example' },
body: {
access_roles: ['example'],
id: 1,
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
user_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
access_roles: JsonValue[],
id: number
}
JsonValue
checkCaaDomainLock
certcentralApi.checkCaaDomainLock
Check CAA (domain lock)
Risk: write
await corsair.digicert.api.certcentralApi.checkCaaDomainLock({
path: { domain_id: 'example' },
body: { account_token: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
domain_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account_token: string
}
| Name | Type | Required | Description |
|---|---|---|---|
status | string | No | — |
checkPermission
certcentralApi.checkPermission
Check permission
Risk: read
await corsair.digicert.api.certcentralApi.checkPermission({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
authorized | boolean | No | — |
permission | string | No | — |
configureOidcSso
certcentralApi.configureOidcSso
Configure OIDC SSO
Risk: write
await corsair.digicert.api.certcentralApi.configureOidcSso({
body: {
provider_url: 'example',
client_id: 'example',
client_secret: 'example',
friendly_name: 'example',
scope_parameter: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
provider_url: string,
client_id: string,
client_secret: string,
friendly_name: string,
scope_parameter: string,
discoverable?: boolean
}
JsonValue
containerInfo
certcentralApi.containerInfo
Container info
Risk: read
await corsair.digicert.api.certcentralApi.containerInfo({
path: { container_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
container_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
public_id | string | No | — |
name | string | No | — |
description | string | No | — |
parent_id | string | No | — |
template_id | string | No | — |
ekey | string | No | — |
has_logo | boolean | No | — |
is_active | boolean | No | — |
user_id_assignments | JsonValue[] | No | — |
allowed_domain_names | JsonValue[] | No | — |
organization_assignments | JsonValue[] | No | — |
status | string | No | — |
display_name | string | No | — |
containerPermissions
certcentralApi.containerPermissions
Container permissions
Risk: read
await corsair.digicert.api.certcentralApi.containerPermissions({
path: { permission: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
permission: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
contractDetails
certcentralApi.contractDetails
Contract details
Risk: read
await corsair.digicert.api.certcentralApi.contractDetails({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
createAuthKey
certcentralApi.createAuthKey
Create AuthKey
Risk: write
await corsair.digicert.api.certcentralApi.createAuthKey({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | JsonValue | No | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
auth_key_id | string | No | — |
auth_key | string | No | — |
expiration_datetime | string | No | — |
createContainer
certcentralApi.createContainer
Create container
Risk: write
await corsair.digicert.api.certcentralApi.createContainer({
path: { container_id: 'example' },
body: { name: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
container_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
name: string,
description?: string,
template_id?: number
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
createKey
certcentralApi.createKey
Create key
Risk: write
await corsair.digicert.api.certcentralApi.createKey({
path: { user_id: 'example' },
body: { name: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
user_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
name: string,
restricted_to_role_id?: number
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
api_key | string | No | — |
createOrganization
certcentralApi.createOrganization
Create organization
Risk: write
await corsair.digicert.api.certcentralApi.createOrganization({
body: {
name: 'example',
country: 'example',
address: 'example',
city: 'example',
state: 'example',
zip: 'example',
telephone: 'example',
organization_contact: 'example',
first_name: 'example',
last_name: 'example',
email: 'jane.doe@example.com',
type: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
name?: string,
assumed_name?: string,
country?: string,
address?: string,
address2?: string,
city?: string,
state?: string,
zip?: string,
telephone?: string,
organization_contact?: JsonValue,
first_name?: string,
last_name?: string,
job_title?: string,
email?: string,
telephone_extension?: string,
skip_duplicate_org_check?: boolean,
validations?: JsonValue[],
type?: string,
verified_users?: JsonValue[]
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
createSubaccount
certcentralApi.createSubaccount
Create subaccount
Risk: write
await corsair.digicert.api.certcentralApi.createSubaccount({
body: {
account_type: 'example',
allowed_grandchildren: ['example'],
user: 'example',
first_name: 'example',
last_name: 'example',
email: 'jane.doe@example.com',
organization: 'example',
name: 'example',
address: 'example',
zip: 'example',
city: 'example',
state: 'example',
country: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account_type?: string,
allowed_grandchildren?: JsonValue[],
account_manager_user_id?: number,
bill_parent?: boolean,
enforce_bill_parent?: boolean,
child_name?: string,
user?: JsonValue,
first_name?: string,
last_name?: string,
email?: string,
username?: string,
job_title?: string,
telephone?: string,
disable_renewal_notifications?: boolean,
organization?: JsonValue,
name?: string,
assumed_name?: string,
address?: string,
address2?: string,
zip?: string,
city?: string,
state?: string,
country?: string,
max_allowed_multi_year_plan_length?: number,
allow_parent_order_renewal?: boolean,
enable_ica_selection?: boolean,
custom_order_validity?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
account_type | string | No | — |
account_manager_user_id | number | No | — |
bill_parent | boolean | No | — |
organization | JsonValue | No | — |
status | string | No | — |
name | string | No | — |
assumed_name | string | No | — |
display_name | string | No | — |
is_active | boolean | No | — |
address | string | No | — |
address2 | string | No | — |
zip | string | No | — |
city | string | No | — |
state | string | No | — |
country | string | No | — |
telephone | string | No | — |
container | JsonValue | No | — |
user | JsonValue | No | — |
username | string | No | — |
account_id | number | No | — |
first_name | string | No | — |
last_name | string | No | — |
email | string | No | — |
job_title | string | No | — |
type | string | No | — |
api_key | string | No | — |
child_name | string | No | — |
max_allowed_multi_year_plan_length | number | No | — |
allow_parent_order_renewal | boolean | No | — |
enable_ica_selection | boolean | No | — |
createUnitOrder
certcentralApi.createUnitOrder
Create unit order
Risk: destructive
await corsair.digicert.api.certcentralApi.createUnitOrder({
body: {
unit_account_id: 1,
bundle: ['example'],
product_name_id: 'example',
units: 1,
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
unit_account_id?: number,
notes?: string,
bundle?: JsonValue[],
product_name_id?: string,
units?: number
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
createVerifiedContactDelegation
certcentralApi.createVerifiedContactDelegation
Create verified contact delegation
Risk: write
await corsair.digicert.api.certcentralApi.createVerifiedContactDelegation({
body: { user_id: 1, delegated_verified_contact_id: 1 },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
user_id: number,
delegated_verified_contact_id: number
}
| Name | Type | Required | Description |
|---|---|---|---|
status | string | No | — |
createVoucherOrder
certcentralApi.createVoucherOrder
Create voucher order
Risk: destructive
await corsair.digicert.api.certcentralApi.createVoucherOrder({
body: {
vouchers: ['example'],
product_name_id: 'example',
quantity: 1,
payment_method: 'example',
number: 'example',
expiration_month: 1,
expiration_year: 1,
cvv: 1,
cardholder_name: 'example',
address: 'example',
city: 'example',
country: 'example',
name: 'example',
organization_name: 'example',
email: 'jane.doe@example.com',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
vouchers?: JsonValue[],
product_name_id?: string,
no_of_fqdns?: number,
no_of_wildcards?: number,
validity_years?: number,
validity_days?: number,
quantity?: number,
shipping_method?: string,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: number,
expiration_year?: number,
cvv?: number,
cardholder_name?: string,
billing_address?: JsonValue,
address?: string,
address2?: string,
city?: string,
state?: string,
country?: string,
zip?: string,
billing_contact?: JsonValue,
name?: string,
organization_name?: string,
email?: string,
phone?: string,
notes?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
name | string | No | — |
status | string | No | — |
cost | number | No | — |
cost_plus_tax | number | No | — |
created_date | string | No | — |
expiration_date | string | No | — |
receipt_id | number | No | — |
invoice_id | number | No | — |
codes | JsonValue[] | No | — |
value | string | No | — |
product | JsonValue | No | — |
no_of_fqdns | number | No | — |
no_of_wildcards | number | No | — |
validity_years | number | No | — |
validity_days | number | No | — |
notes | string | No | — |
deactivateContainer
certcentralApi.deactivateContainer
Deactivate container
Risk: write
await corsair.digicert.api.certcentralApi.deactivateContainer({
path: { container_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | JsonValue | No | — |
path full type
path full type
{
container_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
deactivateDomain
certcentralApi.deactivateDomain
Deactivate domain
Risk: write
await corsair.digicert.api.certcentralApi.deactivateDomain({
path: { domain_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | JsonValue | No | — |
path full type
path full type
{
domain_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
deactivateDomainLocking
certcentralApi.deactivateDomainLocking
Deactivate domain locking
Risk: write
await corsair.digicert.api.certcentralApi.deactivateDomainLocking({
path: { domain_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | JsonValue | No | — |
path full type
path full type
{
domain_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
deactivateOrganization
certcentralApi.deactivateOrganization
Deactivate organization
Risk: write
await corsair.digicert.api.certcentralApi.deactivateOrganization({
path: { organization_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | JsonValue | No | — |
path full type
path full type
{
organization_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
deleteAuthKey
certcentralApi.deleteAuthKey
Delete AuthKey
Risk: destructive
await corsair.digicert.api.certcentralApi.deleteAuthKey({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
deleteCustomField
certcentralApi.deleteCustomField
Delete custom field
Risk: destructive
await corsair.digicert.api.certcentralApi.deleteCustomField({
path: { metadata_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
metadata_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
deleteCustomField_44454c45
certcentralApi.deleteCustomField_44454c45
Delete custom field
Risk: destructive
await corsair.digicert.api.certcentralApi.deleteCustomField_44454c45({
path: { order_id: 'example', metadata_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
order_id: string,
metadata_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
deleteDomain
certcentralApi.deleteDomain
Delete domain
Risk: destructive
await corsair.digicert.api.certcentralApi.deleteDomain({
path: { domain_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
domain_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
deleteIpRestriction
certcentralApi.deleteIpRestriction
Delete IP restriction
Risk: destructive
await corsair.digicert.api.certcentralApi.deleteIpRestriction({
path: { container_id: 'example', rule_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
container_id: string,
rule_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
deleteNoteDeleteNote
certcentralApi.deleteNoteDeleteNote
Delete note — Delete note
Risk: destructive
await corsair.digicert.api.certcentralApi.deleteNoteDeleteNote({
path: { order_id: 'example', note_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
order_id: string,
note_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
deleteOidcSsoConfiguration
certcentralApi.deleteOidcSsoConfiguration
Delete OIDC SSO configuration
Risk: destructive
await corsair.digicert.api.certcentralApi.deleteOidcSsoConfiguration({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
deleteOrderDeleteOrder
certcentralApi.deleteOrderDeleteOrder
Delete order — Permanently delete an eligible inactive order; set query.revoke to also revoke its certificate
Risk: destructive
await corsair.digicert.api.certcentralApi.deleteOrderDeleteOrder({
path: { order_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
revoke?: boolean
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
deleteOrganization
certcentralApi.deleteOrganization
Delete organization
Risk: destructive
await corsair.digicert.api.certcentralApi.deleteOrganization({
path: { organization_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
organization_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
deleteRenewalMessage
certcentralApi.deleteRenewalMessage
Delete renewal message
Risk: destructive
await corsair.digicert.api.certcentralApi.deleteRenewalMessage({
path: { order_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
deleteUser
certcentralApi.deleteUser
Delete user
Risk: destructive
await corsair.digicert.api.certcentralApi.deleteUser({
path: { user_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
user_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
deleteVerifiedContactDelegation
certcentralApi.deleteVerifiedContactDelegation
Delete verified contact delegation
Risk: destructive
await corsair.digicert.api.certcentralApi.deleteVerifiedContactDelegation({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
delegation_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
digiCertOrderId
certcentralApi.digiCertOrderId
DigiCert order ID
Risk: read
await corsair.digicert.api.certcentralApi.digiCertOrderId({
path: { legacy_order_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
legacy_order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
disableCtLogMonitoring
certcentralApi.disableCtLogMonitoring
Disable CT log monitoring
Risk: write
await corsair.digicert.api.certcentralApi.disableCtLogMonitoring({
path: { order_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | JsonValue | No | — |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
disableScanning
certcentralApi.disableScanning
Disable scanning
Risk: destructive
await corsair.digicert.api.certcentralApi.disableScanning({
path: { order_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
domainEmails
certcentralApi.domainEmails
Domain emails
Risk: read
await corsair.digicert.api.certcentralApi.domainEmails({
path: { domain_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
domain_id: string
}
query full type
query full type
{
consider_dcv_email_preferences?: boolean
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
name_scope | string | No | — |
base_emails | JsonValue[] | No | — |
dns_txt_emails | JsonValue[] | No | — |
email_array | JsonValue[] | No | — |
domainInfo
certcentralApi.domainInfo
Domain info
Risk: read
await corsair.digicert.api.certcentralApi.domainInfo({
path: { domain_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
domain_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
is_active | boolean | No | — |
status | string | No | — |
is_pending_validation | boolean | No | — |
name | string | No | — |
date_created | string | No | — |
domain_locking_status | string | No | — |
account_token | string | No | — |
dcv_approval_datetime | string | No | — |
dcv_expiration_datetime | string | No | — |
organization | JsonValue | No | — |
assumed_name | string | No | — |
display_name | string | No | — |
validations | JsonValue[] | No | — |
type | string | No | — |
description | string | No | — |
dcv_status | string | No | — |
dcv_method | string | No | — |
dcv_token | JsonValue | No | — |
token | string | No | — |
expiration_date | string | No | — |
higher_level_domains | JsonValue[] | No | — |
dcv_expiration | string | No | — |
ev | string | No | — |
ov | string | No | — |
ov_shortened | string | No | — |
ov_status | string | No | — |
ev_status | string | No | — |
dcv_approval_date | string | No | — |
container | JsonValue | No | — |
parent_id | number | No | — |
base_domain | string | No | — |
dcv_approval_method | string | No | — |
downloadCertificateByFormat
certcentralApi.downloadCertificateByFormat
Download certificate by format
Risk: read
await corsair.digicert.api.certcentralApi.downloadCertificateByFormat({
path: { certificate_id: 'example', format_type: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
certificate_id: string,
format_type: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
downloadCertificateByFormatOrderId
certcentralApi.downloadCertificateByFormatOrderId
Download certificate by format (order_id)
Risk: read
await corsair.digicert.api.certcentralApi.downloadCertificateByFormatOrderId({
path: { order_id: 'example', format_type: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
order_id: string,
format_type: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
downloadCertificateOrderId
certcentralApi.downloadCertificateOrderId
Download certificate (order_id)
Risk: read
await corsair.digicert.api.certcentralApi.downloadCertificateOrderId({
path: { order_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
downloadCertificateSerialNumber
certcentralApi.downloadCertificateSerialNumber
Download certificate (serial number)
Risk: read
await corsair.digicert.api.certcentralApi.downloadCertificateSerialNumber({
path: { order_id: 'example', serial_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
order_id: string,
serial_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
pem | string | No | — |
downloadResults
certcentralApi.downloadResults
Download results
Risk: read
await corsair.digicert.api.certcentralApi.downloadResults({
path: { order_id: 'example', domain_name: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
order_id: string,
domain_name: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
duplicateCertificate
certcentralApi.duplicateCertificate
Duplicate certificate
Risk: write
await corsair.digicert.api.certcentralApi.duplicateCertificate({
path: { order_id: 'example' },
body: {
certificate: 'example',
common_name: 'example',
csr: 'example',
signature_hash: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
common_name?: string,
dns_names?: JsonValue[],
csr?: string,
server_platform?: JsonValue,
signature_hash?: string,
ca_cert_id?: string,
custom_expiration_date?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
requests | JsonValue[] | No | — |
certificate_id | number | No | — |
certificate_chain | JsonValue[] | No | — |
subject_common_name | string | No | — |
pem | string | No | — |
dvSslChangeDcvMethod
certcentralApi.dvSslChangeDcvMethod
DV SSL: Change DCV method
Risk: write
await corsair.digicert.api.certcentralApi.dvSslChangeDcvMethod({
path: { order_id: 'example' },
body: { dcv_method: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
dcv_method: string
}
| Name | Type | Required | Description |
|---|---|---|---|
dcv_random_value | string | No | — |
expiration_date | string | No | — |
dvSslCheckDcv
certcentralApi.dvSslCheckDcv
DV SSL: Check DCV
Risk: write
await corsair.digicert.api.certcentralApi.dvSslCheckDcv({
path: { order_id: 'example' },
body: { dns_name: 'example', dcv_method: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
dns_name_validations?: JsonValue[],
dns_name?: string,
dcv_method?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
order_status | string | No | — |
certificate_id | number | No | — |
dcv_status | string | No | — |
dns_name_validations | JsonValue[] | No | — |
dns_name | string | No | — |
status | string | No | — |
dvSslResendEmails
certcentralApi.dvSslResendEmails
DV SSL: Resend emails
Risk: destructive
await corsair.digicert.api.certcentralApi.dvSslResendEmails({
path: { order_id: 'example' },
body: { domain: 'example', email: 'jane.doe@example.com' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
domain_approval_emails?: JsonValue[],
domain?: string,
email?: string,
email_domain?: string,
locale?: string
}
JsonValue
editContainer
certcentralApi.editContainer
Edit container
Risk: write
await corsair.digicert.api.certcentralApi.editContainer({
path: { container_id: 'example' },
body: { name: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
container_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
name: string,
description?: string
}
JsonValue
editCustomField
certcentralApi.editCustomField
Edit custom field
Risk: write
await corsair.digicert.api.certcentralApi.editCustomField({
path: { metadata_id: 'example' },
body: { label: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
metadata_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
label: string,
is_required?: boolean,
is_active?: boolean,
data_type?: string,
show_in_receipt?: boolean
}
JsonValue
editCustomFieldValue
certcentralApi.editCustomFieldValue
Edit custom field value
Risk: write
await corsair.digicert.api.certcentralApi.editCustomFieldValue({
path: { order_id: 'example' },
body: { metadata_id: 1, value: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
metadata_id: number,
value: string
}
JsonValue
editDomainsOnAPendingOrderOrReissue
certcentralApi.editDomainsOnAPendingOrderOrReissue
Edit domains on a pending order or reissue
Risk: write
await corsair.digicert.api.certcentralApi.editDomainsOnAPendingOrderOrReissue({
path: { order_id: 'example' },
body: { certificate: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
common_name?: string,
dns_names?: JsonValue[]
}
| Name | Type | Required | Description |
|---|---|---|---|
domains | JsonValue | No | — |
id | number | No | — |
name | string | No | — |
dns_name | string | No | — |
dcv_token | JsonValue | No | — |
editGuestAccessOrder
certcentralApi.editGuestAccessOrder
Edit guest access (order)
Risk: write
await corsair.digicert.api.certcentralApi.editGuestAccessOrder({
path: { order_id: 'example' },
body: { enable_guest_access: 1 },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
enable_guest_access: number
}
JsonValue
editKey
certcentralApi.editKey
Edit key
Risk: write
await corsair.digicert.api.certcentralApi.editKey({
path: { key_id: 'example' },
body: { name: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
key_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
name: string,
restricted_to_role_id?: number
}
JsonValue
editNote
certcentralApi.editNote
Edit note
Risk: write
await corsair.digicert.api.certcentralApi.editNote({
path: { order_id: 'example', note_id: 'example' },
body: { text: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
order_id: string,
note_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
text: string
}
JsonValue
editServiceUserEditServiceUser
certcentralApi.editServiceUserEditServiceUser
Edit service user — Edit service user
Risk: write
await corsair.digicert.api.certcentralApi.editServiceUserEditServiceUser({
path: { user_id: 'example' },
body: { email: 'jane.doe@example.com' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
user_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
email: string
}
JsonValue
editSubaccount
certcentralApi.editSubaccount
Edit subaccount
Risk: write
await corsair.digicert.api.certcentralApi.editSubaccount({
path: { subaccount_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
subaccount_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account_manager_user_id?: number,
bill_parent?: boolean,
child_name?: string,
allow_parent_order_renewal?: boolean,
allow_removing_account_manager?: boolean,
enable_ica_selection?: boolean
}
JsonValue
editUserEditUser
certcentralApi.editUserEditUser
Edit user — Edit user
Risk: write
await corsair.digicert.api.certcentralApi.editUserEditUser({
path: { user_id: 'example' },
body: { email: 'jane.doe@example.com' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
user_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
username?: string,
first_name?: string,
last_name?: string,
email: string,
job_title?: string,
telephone?: string,
is_saml_sso_only?: string
}
JsonValue
emailCertificate
certcentralApi.emailCertificate
Email certificate
Risk: destructive
await corsair.digicert.api.certcentralApi.emailCertificate({
path: { certificate_id: 'example' },
body: {
emails: ['example'],
certificate_collect_format: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
certificate_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
emails?: JsonValue[],
certificate_collect_format?: string,
custom_message?: string
}
JsonValue
emailSiteSeal
certcentralApi.emailSiteSeal
Email site seal
Risk: destructive
await corsair.digicert.api.certcentralApi.emailSiteSeal({
path: { order_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
recipient_email?: string
}
JsonValue
emailValidationStatus
certcentralApi.emailValidationStatus
Email validation status
Risk: read
await corsair.digicert.api.certcentralApi.emailValidationStatus({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
delivery_options | JsonValue[] | No | — |
emails | JsonValue[] | No | — |
email | string | No | — |
status | string | No | — |
date_emailed | string | No | — |
enableCtLogMonitoring
certcentralApi.enableCtLogMonitoring
Enable CT log monitoring
Risk: write
await corsair.digicert.api.certcentralApi.enableCtLogMonitoring({
path: { order_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | JsonValue | No | — |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
enableScanning
certcentralApi.enableScanning
Enable scanning
Risk: write
await corsair.digicert.api.certcentralApi.enableScanning({
path: { order_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | JsonValue | No | — |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
expiringDomainsCount
certcentralApi.expiringDomainsCount
Expiring domains count
Risk: read
await corsair.digicert.api.certcentralApi.expiringDomainsCount({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
number_of_expired_domains | string | No | — |
number_of_expiry_soon_domains | string | No | — |
number_of_domains_affected_by_mozilla_policy | string | No | — |
number_of_domains_recent_expired | string | No | — |
number_of_domains_expiring_within_30_days | string | No | — |
number_of_domains_expiring_from_31_to_60_days | string | No | — |
number_of_domains_expiring_from_61_to_90_days | string | No | — |
expiringOrdersAndCertificates
certcentralApi.expiringOrdersAndCertificates
Expiring orders and certificates
Risk: read
await corsair.digicert.api.certcentralApi.expiringOrdersAndCertificates({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
expiring_orders | JsonValue[] | No | — |
days_expiring | number | No | — |
order_count/countNote: If include_expiring_certs is true, returns as count instead of order_count. | number | No | — |
expiring_certs | JsonValue[] | No | — |
count | number | No | — |
generateDcvToken
certcentralApi.generateDcvToken
Generate DCV token
Risk: write
await corsair.digicert.api.certcentralApi.generateDcvToken({
path: { order_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | JsonValue | No | — |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
dcv_random_value | string | No | — |
expiration_date | string | No | — |
getAllowlistedIssuingCaBrandDetails
certcentralApi.getAllowlistedIssuingCaBrandDetails
Get allowlisted issuing CA brand details
Risk: read
await corsair.digicert.api.certcentralApi.getAllowlistedIssuingCaBrandDetails({
query: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | Record<string, JsonValue> | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
ct_issuer_brand_settings | JsonValue[] | No | — |
issuer_brand | string | No | — |
certificates_count | string | No | — |
disable_email_notification_flag | boolean | No | — |
trusted_ica_flag | boolean | No | — |
page | JsonValue | No | — |
total | number | No | — |
limit | number | No | — |
offset | number | No | — |
getCtLogDetailsForACertificate
certcentralApi.getCtLogDetailsForACertificate
Get CT log details for a certificate
Risk: read
await corsair.digicert.api.certcentralApi.getCtLogDetailsForACertificate({
path: { order_id: 'example', certificate_serial_number: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
order_id: string,
certificate_serial_number: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
serial | string | No | — |
issuer | string | No | — |
not_after | string | No | — |
not_before | string | No | — |
pem | string | No | — |
digicert_issued | boolean | No | — |
getCtLogMonitoringStatus
certcentralApi.getCtLogMonitoringStatus
Get CT log monitoring status
Risk: read
await corsair.digicert.api.certcentralApi.getCtLogMonitoringStatus({
path: { order_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
status | boolean | No | — |
getCtLogsOrderId
certcentralApi.getCtLogsOrderId
Get CT logs (order ID)
Risk: read
await corsair.digicert.api.certcentralApi.getCtLogsOrderId({
path: { order_id: 'example' },
query: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | Record<string, JsonValue> | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
order_id: string
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
ct_certificates | object[] | No | — |
page | JsonValue | No | — |
issuer_ca_list | JsonValue | No | — |
ct_certificates full type
ct_certificates full type
{
serial?: string,
digicert_issued?: boolean,
ctlogs?: {
logged_on?: string,
entry_no?: JsonValue,
log_name?: string,
operated_by?: string,
log_url?: string
}[],
not_after?: string,
not_before?: string,
subject?: string,
issuer?: string,
precert?: boolean,
hosts?: JsonValue,
issuer_ca?: string,
trusted_ica?: boolean,
key_algorithm?: string,
key_length?: number,
self_signed?: boolean,
signature_algorithm?: string,
cert_type?: string,
wildcard?: boolean
}[]
getEnabledStatus
certcentralApi.getEnabledStatus
Get enabled status
Risk: read
await corsair.digicert.api.certcentralApi.getEnabledStatus({
path: { order_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
status | string | No | — |
getKeyInfo
certcentralApi.getKeyInfo
Get key info
Risk: read
await corsair.digicert.api.certcentralApi.getKeyInfo({
path: { key_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
key_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
user | JsonValue | No | — |
first_name | string | No | — |
last_name | string | No | — |
status | string | No | — |
create_date | string | No | — |
last_used_date | string | No | — |
name | string | No | — |
is_legacy | boolean | No | — |
restricted_to_role_id | number | No | — |
acme_directory_url | string | No | — |
product_name_id | string | No | — |
product_name | string | No | — |
organization_id | string | No | — |
organizatin_name | string | No | — |
validity_days | string | No | — |
validity_years | string | No | — |
sans | JsonValue[] | No | — |
allowed_order_count | number | No | — |
used_order_count | number | No | — |
getNotificationSettings
certcentralApi.getNotificationSettings
Get notification settings
Risk: read
await corsair.digicert.api.certcentralApi.getNotificationSettings({
path: { order_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
setting | string | No | — |
getOrdersByAlternativeOrderId
certcentralApi.getOrdersByAlternativeOrderId
Get orders by alternative order ID
Risk: read
await corsair.digicert.api.certcentralApi.getOrdersByAlternativeOrderId({
path: { alternative_order_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
alternative_order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
orders | JsonValue[] | No | — |
order_id | number | No | — |
certificate_id | number | No | — |
status | string | No | — |
page | JsonValue | No | — |
getScanDetails
certcentralApi.getScanDetails
Get scan details
Risk: read
await corsair.digicert.api.certcentralApi.getScanDetails({
path: { order_id: 'example' },
query: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | Record<string, JsonValue> | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
order_id: string
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
domains_scan_details | JsonValue[] | No | — |
host_name | string | No | — |
scan_start_date | string | No | — |
scan_end_date | string | No | — |
vulnerability_status | string | No | — |
notification_status | string | No | — |
critical_vulnerabilities_count | number | No | — |
severe_vulnerabilities_count | number | No | — |
moderate_vulnerabilities_count | number | No | — |
is_download_available | boolean | No | — |
is_rescan_available | boolean | No | — |
is_site_enabled | boolean | No | — |
page | JsonValue | No | — |
getVmcOrCmcLogo
certcentralApi.getVmcOrCmcLogo
Get VMC or CMC logo
Risk: read
await corsair.digicert.api.certcentralApi.getVmcOrCmcLogo({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
logo | string | No | — |
getVoucherOrderDetails
certcentralApi.getVoucherOrderDetails
Get voucher order details
Risk: read
await corsair.digicert.api.certcentralApi.getVoucherOrderDetails({
path: { id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
name | string | No | — |
status | string | No | — |
cost | number | No | — |
currency | string | No | — |
created_date | string | No | — |
expiration_date | string | No | — |
can_cancel | boolean | No | — |
codes | JsonValue | No | — |
value | string | No | — |
product_name_id | string | No | — |
no_of_fqdns | number | No | — |
no_of_wildcards | number | No | — |
validity_years | number | No | — |
validity_days | number | No | — |
notes | string | No | — |
used_from | string | No | — |
valid_till | string | No | — |
guestAccessUrl
certcentralApi.guestAccessUrl
Guest access URL
Risk: read
await corsair.digicert.api.certcentralApi.guestAccessUrl({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
enabled | boolean | No | — |
guest_access_url | string | No | — |
inviteDetails
certcentralApi.inviteDetails
Invite details
Risk: read
await corsair.digicert.api.certcentralApi.inviteDetails({
path: { invite_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
invite_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
email | string | No | — |
subaccount_type | string | No | — |
invite_note | string | No | — |
date_created | string | No | — |
last_sent_date | string | No | — |
status | string | No | — |
listAllVoucherOrders
certcentralApi.listAllVoucherOrders
List all voucher orders
Risk: read
await corsair.digicert.api.certcentralApi.listAllVoucherOrders({
query: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | Record<string, JsonValue> | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
voucher_orders | JsonValue | No | — |
id | number | No | — |
status | string | No | — |
cost | number | No | — |
cost_plus_tax | number | No | — |
currency | string | No | — |
created_date | string | No | — |
expiration_date | string | No | — |
receipt_id | number | No | — |
invoice_id | number | No | — |
notes | string | No | — |
page | JsonValue | No | — |
listApiAccessRoles
certcentralApi.listApiAccessRoles
List API access roles
Risk: read
await corsair.digicert.api.certcentralApi.listApiAccessRoles({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
access_roles | JsonValue[] | No | — |
id | number | No | — |
name | string | No | — |
listApprovers
certcentralApi.listApprovers
List approvers
Risk: read
await corsair.digicert.api.certcentralApi.listApprovers({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
users | JsonValue[] | No | — |
user_id | string | No | — |
name | string | No | — |
first_name | string | No | — |
last_name | string | No | — |
job_title | string | No | — |
telephone | string | No | — |
email | string | No | — |
contacts | JsonValue[] | No | — |
listAuthKeys
certcentralApi.listAuthKeys
List AuthKeys
Risk: read
await corsair.digicert.api.certcentralApi.listAuthKeys({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
listBalanceHistory
certcentralApi.listBalanceHistory
List balance history
Risk: read
await corsair.digicert.api.certcentralApi.listBalanceHistory({
query: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | Record<string, JsonValue> | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
adjustments | object[] | No | — |
page | JsonValue | No | — |
adjustments full type
adjustments full type
{
id?: string,
container?: {
id?: number,
name?: string,
is_active?: boolean
},
credit?: string,
debit?: string,
transaction_type?: string,
receipt_id?: string,
transaction_date?: string,
balance_after?: string,
expiration_date?: string,
note?: string,
currency?: string
}[]
listCertificateNotes
certcentralApi.listCertificateNotes
List certificate notes
Risk: read
await corsair.digicert.api.certcentralApi.listCertificateNotes({
path: { certificate_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
certificate_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
notes | JsonValue[] | No | — |
date_created | string | No | — |
text | string | No | — |
user | JsonValue | No | — |
listChildContainers
certcentralApi.listChildContainers
List child containers
Risk: read
await corsair.digicert.api.certcentralApi.listChildContainers({
path: { container_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
container_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
containers | JsonValue[] | No | — |
id | number | No | — |
public_id | string | No | — |
name | string | No | — |
description | string | No | — |
parent_id | string | No | — |
template_id | string | No | — |
has_logo | boolean | No | — |
is_active | boolean | No | — |
allowed_domain_names | JsonValue[] | No | — |
listCodesForVoucherOrder
certcentralApi.listCodesForVoucherOrder
List codes for voucher order
Risk: read
await corsair.digicert.api.certcentralApi.listCodesForVoucherOrder({
path: { voucher_order_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
voucher_order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
codes | JsonValue[] | No | — |
id | number | No | — |
value | string | No | — |
product_name | string | No | — |
no_of_fqdns | number | No | — |
no_of_wildcards | string | No | — |
shipping_method | string | No | — |
validity_years | number | No | — |
validity_days | number | No | — |
status | string | No | — |
created_date | string | No | — |
voucher_order_id | number | No | — |
cert_request_date | string | No | — |
cert_validity_start_date | string | No | — |
cert_validity_end_date | string | No | — |
cert_organization | string | No | — |
cert_common_name | string | No | — |
certificate_order_id | string | No | — |
voucher_validity_end_date | string | No | — |
order_valid_from | string | No | — |
order_valid_till | string | No | — |
server_licenses | number | No | — |
listContainerOrganizations
certcentralApi.listContainerOrganizations
List container organizations
Risk: read
await corsair.digicert.api.certcentralApi.listContainerOrganizations({
path: { container_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
container_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
organizations | JsonValue[] | No | — |
id | number | No | — |
status | string | No | — |
name | string | No | — |
assumed_name | string | No | — |
display_name | string | No | — |
is_active | boolean | No | — |
address | string | No | — |
address2 | string | No | — |
zip | string | No | — |
city | string | No | — |
state | string | No | — |
country | string | No | — |
telephone | string | No | — |
validations | JsonValue[] | No | — |
listContainerRoles
certcentralApi.listContainerRoles
List container roles
Risk: read
await corsair.digicert.api.certcentralApi.listContainerRoles({
path: { container_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
container_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
access_roles | JsonValue[] | No | — |
id | number | No | — |
name | string | No | — |
listContainers
certcentralApi.listContainers
List containers
Risk: read
await corsair.digicert.api.certcentralApi.listContainers({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
containers | JsonValue[] | No | — |
id | number | No | — |
public_id | string | No | — |
name | string | No | — |
description | string | No | — |
parent_id | number | No | — |
template_id | number | No | — |
has_logo | boolean | No | — |
is_active | boolean | No | — |
user_id_assignments | JsonValue[] | No | — |
allowed_domain_names | JsonValue[] | No | — |
organization_assignments | JsonValue[] | No | — |
listCustomFields
certcentralApi.listCustomFields
List custom fields
Risk: read
await corsair.digicert.api.certcentralApi.listCustomFields({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
metadata | JsonValue[] | No | — |
id | number | No | — |
label | string | No | — |
is_required | boolean | No | — |
is_active | boolean | No | — |
data_type | string | No | — |
show_in_receipt | boolean | No | — |
listDcvMethods
certcentralApi.listDcvMethods
List DCV methods
Risk: read
await corsair.digicert.api.certcentralApi.listDcvMethods({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
methods | JsonValue[] | No | — |
name | string | No | — |
display_name | string | No | — |
description | string | No | — |
default | boolean | No | — |
listDomains
certcentralApi.listDomains
List domains
Risk: read
await corsair.digicert.api.certcentralApi.listDomains({
query: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | Record<string, JsonValue> | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
domains | JsonValue[] | No | — |
id | number | No | — |
is_active | boolean | No | — |
name | string | No | — |
dcv_approval_datetime | string | No | — |
dcv_expiration_datetime | string | No | — |
last_submitted_datetime | string | No | — |
date_created | string | No | — |
domain_locking_status | string | No | — |
account_token | string | No | — |
organization | JsonValue | No | — |
validations | JsonValue[] | No | — |
dcv_method | string | No | — |
dcv_expiration | string | No | — |
container | JsonValue | No | — |
base_domain | string | No | — |
dcv_approval_method | string | No | — |
page | JsonValue | No | — |
listDuplicates
certcentralApi.listDuplicates
List duplicates
Risk: read
await corsair.digicert.api.certcentralApi.listDuplicates({
path: { order_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
show_archived?: boolean
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
certificates | JsonValue[] | No | — |
id | number | No | — |
thumbprint | string | No | — |
serial_number | string | No | — |
common_name | string | No | — |
dns_names | JsonValue[] | No | — |
status | string | No | — |
date_created | string | No | — |
valid_from | string | No | — |
valid_till | string | No | — |
days_remaining | number | No | — |
csr | string | No | — |
server_platform | JsonValue | No | — |
signature_hash | string | No | — |
key_size | number | No | — |
ca_cert_id | string | No | — |
sub_id | string | No | — |
public_id | string | No | — |
archived | string | No | — |
user_id | number | No | — |
firstname | string | No | — |
lastname | string | No | — |
listInvites
certcentralApi.listInvites
List invites
Risk: read
await corsair.digicert.api.certcentralApi.listInvites({
query: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | Record<string, JsonValue> | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
subaccount_invites | JsonValue[] | No | — |
id | number | No | — |
email | string | No | — |
subaccount_type | string | No | — |
invite_note | string | No | — |
date_created | string | No | — |
last_sent_date | string | No | — |
status | string | No | — |
page | JsonValue | No | — |
listIpRestrictions
certcentralApi.listIpRestrictions
List IP restrictions
Risk: read
await corsair.digicert.api.certcentralApi.listIpRestrictions({
path: { container_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
container_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
ip_rules | JsonValue[] | No | — |
id | number | No | — |
date_created | string | No | — |
account_id | string | No | — |
container_id | number | No | — |
user_id | number | No | — |
api_key_id | number | No | — |
ip_address | string | No | — |
ip_address_end | string | No | — |
description | string | No | — |
listKeys
certcentralApi.listKeys
List keys
Risk: read
await corsair.digicert.api.certcentralApi.listKeys({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
api_keys | JsonValue[] | No | — |
acme_urls | JsonValue[] | No | — |
listOrderNotes
certcentralApi.listOrderNotes
List order notes
Risk: read
await corsair.digicert.api.certcentralApi.listOrderNotes({
path: { order_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
notes | JsonValue[] | No | — |
id | number | No | — |
date_created | string | No | — |
text | string | No | — |
user | JsonValue | No | — |
listPermissions
certcentralApi.listPermissions
List permissions
Risk: read
await corsair.digicert.api.certcentralApi.listPermissions({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
authorizations | JsonValue[] | No | — |
authorized | boolean | No | — |
permission | string | No | — |
listPurchaseHistory
certcentralApi.listPurchaseHistory
List purchase history
Risk: read
await corsair.digicert.api.certcentralApi.listPurchaseHistory({
query: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | Record<string, JsonValue> | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
order_transactions | object[] | No | — |
page | JsonValue | No | — |
order_transactions full type
order_transactions full type
{
id?: string,
container?: JsonValue,
order_id?: string,
receipt_id?: string,
amount?: string,
payment_type?: string,
transaction_date?: string,
transaction_type?: string,
product_name?: string
}[]
listReissues
certcentralApi.listReissues
List reissues
Risk: read
await corsair.digicert.api.certcentralApi.listReissues({
path: { order_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
show_archived?: boolean
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
certificates | JsonValue[] | No | — |
id | number | No | — |
thumbprint | string | No | — |
serial_number | string | No | — |
common_name | string | No | — |
dns_names | JsonValue[] | No | — |
status | string | No | — |
date_created | string | No | — |
date_issued | string | No | — |
valid_till | string | No | — |
days_remaining | number | No | — |
csr | string | No | — |
key_size | number | No | — |
archived | number | No | — |
user_id | number | No | — |
email | string | No | — |
firstname | string | No | — |
lastname | string | No | — |
receipt_id | string | No | — |
purchased_dns_names | string | No | — |
purchased_wildcard_names | string | No | — |
listReplacementBenefits
certcentralApi.listReplacementBenefits
List replacement benefits
Risk: write
await corsair.digicert.api.certcentralApi.listReplacementBenefits({
body: {
domains: ['example'],
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
domains: JsonValue[]
}
| Name | Type | Required | Description |
|---|---|---|---|
certificates | JsonValue[] | No | — |
subject | string | No | — |
san_list | JsonValue[] | No | — |
serial_number | string | No | — |
issuer_ca | string | No | — |
issuer_brand | string | No | — |
not_before | string | No | — |
not_after | string | No | — |
validation_type | string | No | — |
matched_domains_count | number | No | — |
matched_domains | JsonValue[] | No | — |
certificate_replacement_benefits | JsonValue[] | No | — |
page | JsonValue | No | — |
listRequests
certcentralApi.listRequests
List requests
Risk: read
await corsair.digicert.api.certcentralApi.listRequests({
query: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | Record<string, JsonValue> | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
requests | JsonValue[] | No | — |
id | number | No | — |
date | string | No | — |
type | string | No | — |
status | string | No | — |
requester | JsonValue | No | — |
order | JsonValue | No | — |
page | JsonValue | No | — |
listServiceUsers
certcentralApi.listServiceUsers
List service users
Risk: read
await corsair.digicert.api.certcentralApi.listServiceUsers({
query: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | Record<string, JsonValue> | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
users | JsonValue[] | No | — |
id | number | No | — |
username | string | No | — |
account_id | number | No | — |
first_name | string | No | — |
last_name | string | No | — |
email | string | No | — |
status | string | No | — |
container | JsonValue | No | — |
access_roles | JsonValue[] | No | — |
type | string | No | — |
has_container_assignments | boolean | No | — |
container_assignments | JsonValue[] | No | — |
page | JsonValue | No | — |
listSubaccountDomains
certcentralApi.listSubaccountDomains
List subaccount domains
Risk: read
await corsair.digicert.api.certcentralApi.listSubaccountDomains({
path: { subaccount_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | Record<string, JsonValue> | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
subaccount_id: string
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
domains | JsonValue[] | No | — |
id | number | No | — |
is_active | boolean | No | — |
name | string | No | — |
dcv_approval_datetime | string | No | — |
last_submitted_datetime | string | No | — |
date_created | string | No | — |
organization | JsonValue | No | — |
validations | JsonValue[] | No | — |
dcv_method | string | No | — |
dcv_expiration | string | No | — |
container | JsonValue | No | — |
page | JsonValue | No | — |
listSubaccountOrders
certcentralApi.listSubaccountOrders
List subaccount orders
Risk: read
await corsair.digicert.api.certcentralApi.listSubaccountOrders({
query: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | Record<string, JsonValue> | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
orders | JsonValue[] | No | — |
id | number | No | — |
certificate | JsonValue | No | — |
subaccount | JsonValue | No | — |
product | JsonValue | No | — |
order_price | JsonValue | No | — |
status | string | No | — |
number_of_sans | number | No | — |
date_created | string | No | — |
date_issued | string | No | — |
validity_years | number | No | — |
order_prices | JsonValue[] | No | — |
page | JsonValue | No | — |
listSubaccountOrganizations
certcentralApi.listSubaccountOrganizations
List subaccount organizations
Risk: read
await corsair.digicert.api.certcentralApi.listSubaccountOrganizations({
path: { subaccount_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | Record<string, JsonValue> | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
subaccount_id: string
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
organizations | JsonValue[] | No | — |
id | number | No | — |
status | string | No | — |
name | string | No | — |
display_name | string | No | — |
validations | JsonValue[] | No | — |
page | JsonValue | No | — |
listSubaccountProductLimits
certcentralApi.listSubaccountProductLimits
List subaccount product limits
Risk: read
await corsair.digicert.api.certcentralApi.listSubaccountProductLimits({
path: { subaccount_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
subaccount_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
product_limits | JsonValue[] | No | — |
product_name_id | string | No | — |
listSubaccountProducts
certcentralApi.listSubaccountProducts
List subaccount products
Risk: read
await corsair.digicert.api.certcentralApi.listSubaccountProducts({
path: { subaccount_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
subaccount_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
currency | string | No | — |
pricing_method | string | No | — |
balance_negative_limit | number | No | — |
products | JsonValue[] | No | — |
product_name_id | string | No | — |
product_name | string | No | — |
product_shim_map | JsonValue[] | No | — |
prices | JsonValue[] | No | — |
unit | JsonValue | No | — |
listSubaccounts
certcentralApi.listSubaccounts
List subaccounts
Risk: read
await corsair.digicert.api.certcentralApi.listSubaccounts({
query: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | Record<string, JsonValue> | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
child_accounts | JsonValue[] | No | — |
account_id | number | No | — |
account_type | string | No | — |
organization_name | string | No | — |
date_created | string | No | — |
account_manager | string | No | — |
page | JsonValue | No | — |
listTemplates
certcentralApi.listTemplates
List templates
Risk: read
await corsair.digicert.api.certcentralApi.listTemplates({
path: { container_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
container_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
container_templates | JsonValue[] | No | — |
id | number | No | — |
name | string | No | — |
date_created | string | No | — |
listUnitOrders
certcentralApi.listUnitOrders
List unit orders
Risk: read
await corsair.digicert.api.certcentralApi.listUnitOrders({
query: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | Record<string, JsonValue> | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
orders | JsonValue[] | No | — |
id | number | No | — |
unit_account_id | number | No | — |
unit_account_name | string | No | — |
cost | number | No | — |
currency | string | No | — |
status | string | No | — |
expiration_date | string | No | — |
created_date | string | No | — |
page | JsonValue | No | — |
listUsedVoucherCodes
certcentralApi.listUsedVoucherCodes
List used voucher codes
Risk: read
await corsair.digicert.api.certcentralApi.listUsedVoucherCodes({
query: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | Record<string, JsonValue> | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
codes | JsonValue[] | No | — |
id | number | No | — |
value | string | No | — |
product_name | string | No | — |
no_of_fqdns | number | No | — |
no_of_wildcards | string | No | — |
shipping_method | string | No | — |
validity_years | number | No | — |
validity_days | number | No | — |
status | string | No | — |
created_date | string | No | — |
voucher_order_id | number | No | — |
cert_request_date | string | No | — |
cert_validity_start_date | string | No | — |
cert_validity_end_date | string | No | — |
cert_organization | string | No | — |
cert_common_name | string | No | — |
certificate_order_id | string | No | — |
voucher_validity_end_date | string | No | — |
order_valid_from | string | No | — |
order_valid_till | string | No | — |
server_licenses | number | No | — |
listUserInvitations
certcentralApi.listUserInvitations
List user invitations
Risk: read
await corsair.digicert.api.certcentralApi.listUserInvitations({
query: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | Record<string, JsonValue> | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
invites | JsonValue[] | No | — |
id | number | No | — |
date_created | string | No | — |
date_accepted | string | No | — |
last_sent_date | string | No | — |
status | string | No | — |
email | string | No | — |
container_id | number | No | — |
user | JsonValue | No | — |
requested_user | JsonValue | No | — |
page | JsonValue | No | — |
total | number | No | — |
listVerifiedContactDelegations
certcentralApi.listVerifiedContactDelegations
List verified contact delegations
Risk: read
await corsair.digicert.api.certcentralApi.listVerifiedContactDelegations({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
user_id?: number
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
delegations | JsonValue[] | No | — |
id | number | No | — |
user_id | number | No | — |
delegated_verified_contact_id | number | No | — |
verified_contact_first_name | string | No | — |
verified_contact_last_name | string | No | — |
verified_contact_email | string | No | — |
organization_id | number | No | — |
status | string | No | — |
email_last_sent | string | No | — |
date_created | string | No | — |
requested_by_user_id | number | No | — |
delegation_group_id | string | No | — |
listVerifiedContactsThatCanDelegate
certcentralApi.listVerifiedContactsThatCanDelegate
List verified contacts that can delegate
Risk: read
await corsair.digicert.api.certcentralApi.listVerifiedContactsThatCanDelegate({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
contacts | JsonValue[] | No | — |
id | number | No | — |
first_name | string | No | — |
last_name | string | No | — |
name | string | No | — |
email | string | No | — |
moveOrders
certcentralApi.moveOrders
Move orders
Risk: write
await corsair.digicert.api.certcentralApi.moveOrders({
path: { target_account_id: 1 },
body: { order_ids: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
target_account_id: number
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
target_org_id?: number,
order_ids: string,
move_custom_fields?: boolean
}
| Name | Type | Required | Description |
|---|---|---|---|
move_request_id | number | No | — |
oidcSsoConfigurationDetails
certcentralApi.oidcSsoConfigurationDetails
OIDC SSO configuration details
Risk: read
await corsair.digicert.api.certcentralApi.oidcSsoConfigurationDetails({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
provider_url | string | No | — |
friendly_name | string | No | — |
slug_name | string | No | — |
client_id | string | No | — |
client_secret | string | No | — |
discoverable | boolean | No | — |
scope_parameter | string | No | — |
date_created | string | No | — |
orderAatlNaturalPersonCertificate
certcentralApi.orderAatlNaturalPersonCertificate
Order AATL Natural Person Certificate
Risk: destructive
await corsair.digicert.api.certcentralApi.orderAatlNaturalPersonCertificate({
body: {
certificate: 'example',
usage_designation: 'example',
cs_provisioning_method: 'example',
name: 'example',
addr1: 'example',
addr2: 'example',
city: 'example',
state: 'example',
zip: 'example',
country: 'example',
method: 'example',
csa_agreed_to: true,
order_validity: 'example',
years: 1,
individual: 'example',
first_name: 'example',
last_name: 'example',
email: 'jane.doe@example.com',
telephone: 'example',
payment_method: 'example',
credit_card: 'example',
number: 'example',
expiration_month: 'example',
expiration_year: 'example',
cvv: 'example',
cardholder_name: 'example',
set_as_default: 'example',
address: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
usage_designation?: JsonValue,
cs_provisioning_method?: string,
ship_info?: JsonValue,
name?: string,
addr1?: string,
addr2?: string,
city?: string,
state?: string,
zip?: string,
country?: string,
method?: string,
csr?: string,
key_size?: number,
csr_key_type?: string,
signature_hash?: string,
comments?: string,
additional_emails?: JsonValue[],
user_id_assignments?: JsonValue[],
csa_agreed_to?: boolean,
promo_code?: string,
order_validity?: JsonValue,
years?: number,
days?: number,
custom_expiration_date?: string,
common_name_indicator?: string,
individual?: JsonValue,
first_name?: string,
last_name?: string,
pseudonym?: string,
email?: string,
telephone?: string,
id?: number,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: string,
expiration_year?: string,
cvv?: string,
cardholder_name?: string,
save_credit_card?: string,
set_as_default?: string,
billing_address?: JsonValue,
address?: string,
address2?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
requests | JsonValue[] | No | — |
status | string | No | — |
certificate_id | number | No | — |
orderAatlNaturalPersonInOrganisationCertificate
certcentralApi.orderAatlNaturalPersonInOrganisationCertificate
Order AATL Natural Person in Organisation Certificate
Risk: destructive
await corsair.digicert.api.certcentralApi.orderAatlNaturalPersonInOrganisationCertificate({
body: {
certificate: 'example',
usage_designation: 'example',
cs_provisioning_method: 'example',
name: 'example',
addr1: 'example',
addr2: 'example',
city: 'example',
state: 'example',
zip: 'example',
country: 'example',
method: 'example',
csa_agreed_to: true,
order_validity: 'example',
years: 1,
individual: 'example',
first_name: 'example',
last_name: 'example',
email: 'jane.doe@example.com',
telephone: 'example',
organization: 'example',
contacts: ['example'],
payment_method: 'example',
credit_card: 'example',
number: 'example',
expiration_month: 'example',
expiration_year: 'example',
cvv: 'example',
cardholder_name: 'example',
set_as_default: 'example',
address: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
usage_designation?: JsonValue,
cs_provisioning_method?: string,
ship_info?: JsonValue,
name?: string,
addr1?: string,
addr2?: string,
city?: string,
state?: string,
zip?: string,
country?: string,
method?: string,
csr?: string,
key_size?: number,
csr_key_type?: string,
signature_hash?: string,
comments?: string,
additional_emails?: JsonValue[],
csa_agreed_to?: boolean,
promo_code?: string,
order_validity?: JsonValue,
years?: number,
days?: number,
custom_expiration_date?: string,
common_name_indicator?: string,
individual?: JsonValue,
first_name?: string,
last_name?: string,
pseudonym?: string,
email?: string,
telephone?: string,
id?: number,
organization?: JsonValue,
contacts?: JsonValue[],
container?: JsonValue,
skip_approval?: boolean,
auto_renew?: number,
custom_renewal_message?: string,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: string,
expiration_year?: string,
cvv?: string,
cardholder_name?: string,
save_credit_card?: string,
set_as_default?: string,
billing_address?: JsonValue,
address?: string,
address2?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
organization | JsonValue | No | — |
requests | JsonValue[] | No | — |
status | string | No | — |
certificate_id | number | No | — |
orderAatlOrganizationEsealCertificate
certcentralApi.orderAatlOrganizationEsealCertificate
Order AATL Organization eseal Certificate
Risk: destructive
await corsair.digicert.api.certcentralApi.orderAatlOrganizationEsealCertificate({
body: {
certificate: 'example',
usage_designation: 'example',
cs_provisioning_method: 'example',
name: 'example',
addr1: 'example',
addr2: 'example',
city: 'example',
state: 'example',
zip: 'example',
country: 'example',
method: 'example',
csa_agreed_to: true,
order_validity: 'example',
years: 1,
requester: 'example',
first_name: 'example',
last_name: 'example',
email: 'jane.doe@example.com',
telephone: 'example',
organization: 'example',
id: 1,
contacts: ['example'],
payment_method: 'example',
credit_card: 'example',
number: 'example',
expiration_month: 'example',
expiration_year: 'example',
cvv: 'example',
cardholder_name: 'example',
set_as_default: 'example',
address: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
usage_designation?: JsonValue,
cs_provisioning_method?: string,
ship_info?: JsonValue,
name?: string,
addr1?: string,
addr2?: string,
city?: string,
state?: string,
zip?: string,
country?: string,
method?: string,
csr?: string,
key_size?: number,
csr_key_type?: string,
signature_hash?: string,
comments?: string,
additional_emails?: JsonValue[],
csa_agreed_to?: boolean,
promo_code?: string,
order_validity?: JsonValue,
years?: number,
days?: number,
custom_expiration_date?: string,
requester?: JsonValue,
first_name?: string,
last_name?: string,
email?: string,
telephone?: string,
organization?: JsonValue,
id?: number,
contacts?: JsonValue[],
container?: JsonValue,
skip_approval?: boolean,
auto_renew?: number,
custom_renewal_message?: string,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: string,
expiration_year?: string,
cvv?: string,
cardholder_name?: string,
save_credit_card?: string,
set_as_default?: string,
billing_address?: JsonValue,
address?: string,
address2?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
organization | JsonValue | No | — |
requests | JsonValue[] | No | — |
status | string | No | — |
certificate_id | number | No | — |
orderBasicEvOrderBasicEv
certcentralApi.orderBasicEvOrderBasicEv
Order Basic EV — Order Basic EV
Risk: destructive
await corsair.digicert.api.certcentralApi.orderBasicEvOrderBasicEv({
body: {
certificate: 'example',
common_name: 'example',
csr: 'example',
signature_hash: 'example',
order_validity: 'example',
years: 1,
number: 'example',
expiration_month: 1,
expiration_year: 1,
cvv: 1,
cardholder_name: 'example',
address: 'example',
city: 'example',
country: 'example',
first_name: 'example',
last_name: 'example',
email: 'jane.doe@example.com',
organization: 'example',
id: 1,
metadata_id: 1,
value: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
common_name?: string,
dns_names?: JsonValue[],
csr?: string,
signature_hash?: string,
organization_units?: JsonValue[],
server_platform?: JsonValue,
cert_validity?: JsonValue,
profile_option?: string,
ca_cert_id?: string,
renewed_thumbprint?: string,
order_validity?: JsonValue,
years?: number,
days?: number,
custom_expiration_date?: string,
comments?: string,
apply_cr_discount?: boolean,
serial_number?: string,
auto_renew?: number,
auto_reissue?: number,
custom_renewal_message?: string,
disable_renewal_notifications?: boolean,
additional_emails?: JsonValue[],
locale?: string,
renewal_of_order_id?: number,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: number,
expiration_year?: number,
cvv?: number,
cardholder_name?: string,
billing_address?: JsonValue,
address?: string,
address2?: string,
city?: string,
state?: string,
country?: string,
zip?: string,
vat_number?: string,
dcv_method?: string,
skip_approval?: boolean,
disable_ct?: boolean,
organization_contact?: JsonValue,
first_name?: string,
last_name?: string,
email?: string,
job_title?: string,
telephone?: string,
telephone_extension?: string,
technical_contact?: JsonValue,
organization?: JsonValue,
id?: number,
skip_duplicate_org_check?: boolean,
contacts?: JsonValue[],
container?: JsonValue,
custom_fields?: JsonValue[],
metadata_id?: number,
value?: string,
alternative_order_id?: string,
enable_guest_access?: number,
certificate_dcv_scope?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
dcv_random_value | string | No | — |
organization | JsonValue | No | — |
domains | JsonValue[] | No | — |
name | number | No | — |
dns_name | string | No | — |
dcv_token | JsonValue | No | — |
requests | JsonValue[] | No | — |
status | string | No | — |
certificate_id | number | No | — |
certificate_chain | JsonValue[] | No | — |
subject_common_name | string | No | — |
pem | string | No | — |
orderBasicOv
certcentralApi.orderBasicOv
Order Basic OV
Risk: destructive
await corsair.digicert.api.certcentralApi.orderBasicOv({
body: {
certificate: 'example',
common_name: 'example',
csr: 'example',
signature_hash: 'example',
order_validity: 'example',
years: 1,
number: 'example',
expiration_month: 1,
expiration_year: 1,
cvv: 1,
cardholder_name: 'example',
address: 'example',
city: 'example',
country: 'example',
first_name: 'example',
last_name: 'example',
email: 'jane.doe@example.com',
organization: 'example',
id: 1,
metadata_id: 1,
value: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
common_name?: string,
dns_names?: JsonValue[],
csr?: string,
signature_hash?: string,
organization_units?: JsonValue[],
server_platform?: JsonValue,
cert_validity?: JsonValue,
profile_option?: string,
ca_cert_id?: string,
renewed_thumbprint?: string,
order_validity?: JsonValue,
years?: number,
days?: number,
custom_expiration_date?: string,
comments?: string,
apply_cr_discount?: boolean,
serial_number?: string,
auto_renew?: number,
auto_reissue?: number,
custom_renewal_message?: string,
disable_renewal_notifications?: boolean,
additional_emails?: JsonValue[],
locale?: string,
renewal_of_order_id?: number,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: number,
expiration_year?: number,
cvv?: number,
cardholder_name?: string,
billing_address?: JsonValue,
address?: string,
address2?: string,
city?: string,
state?: string,
country?: string,
zip?: string,
vat_number?: string,
dcv_method?: string,
skip_approval?: boolean,
disable_ct?: boolean,
organization_contact?: JsonValue,
first_name?: string,
last_name?: string,
email?: string,
job_title?: string,
telephone?: string,
telephone_extension?: string,
technical_contact?: JsonValue,
organization?: JsonValue,
id?: number,
skip_duplicate_org_check?: boolean,
contacts?: JsonValue[],
container?: JsonValue,
custom_fields?: JsonValue[],
metadata_id?: number,
value?: string,
alternative_order_id?: string,
enable_guest_access?: number,
certificate_dcv_scope?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
dcv_random_value | string | No | — |
organization | JsonValue | No | — |
domains | JsonValue[] | No | — |
name | number | No | — |
dns_name | string | No | — |
dcv_token | JsonValue | No | — |
requests | JsonValue[] | No | — |
status | string | No | — |
certificate_id | number | No | — |
certificate_chain | JsonValue[] | No | — |
subject_common_name | string | No | — |
pem | string | No | — |
orderClientCertificate
certcentralApi.orderClientCertificate
Order client certificate
Risk: destructive
await corsair.digicert.api.certcentralApi.orderClientCertificate({
path: { client_certificate_id: 'example' },
body: {
certificate: 'example',
emails: ['example'],
signature_hash: 'example',
first_name: 'example',
last_name: 'example',
email: 'jane.doe@example.com',
id: 1,
order_validity: 'example',
years: 1,
metadata_id: 1,
value: 'example',
number: 'example',
expiration_month: 1,
expiration_year: 1,
cvv: 1,
cardholder_name: 'example',
address: 'example',
city: 'example',
country: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
client_certificate_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
common_name?: string,
emails?: JsonValue[],
signature_hash?: string,
organization_units?: JsonValue[],
csr?: string,
ca_cert_id?: string,
auto_renew?: number,
renewal_of_order_id?: number,
skip_approval?: boolean,
organization_contact?: JsonValue,
first_name?: string,
last_name?: string,
email?: string,
job_title?: string,
telephone?: string,
telephone_extension?: string,
technical_contact?: JsonValue,
organization?: JsonValue,
id?: number,
contacts?: JsonValue[],
skip_duplicate_org_check?: boolean,
container?: JsonValue,
order_validity?: JsonValue,
years?: number,
days?: number,
custom_expiration_date?: string,
validity_years?: number,
custom_fields?: JsonValue,
metadata_id?: number,
value?: string,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: number,
expiration_year?: number,
cvv?: number,
cardholder_name?: string,
billing_address?: JsonValue,
address?: string,
address2?: string,
city?: string,
state?: string,
country?: string,
zip?: string,
vat_number?: string,
alternative_order_id?: string,
enable_guest_access?: number
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
organization | JsonValue | No | — |
requests | JsonValue[] | No | — |
status | string | No | — |
certificate_id | number | No | — |
orderCodeSigningCertificate
certcentralApi.orderCodeSigningCertificate
Order code signing certificate
Risk: destructive
await corsair.digicert.api.certcentralApi.orderCodeSigningCertificate({
path: { code_signing_certificate_id: 'example' },
body: {
certificate: 'example',
signature_hash: 'example',
first_name: 'example',
last_name: 'example',
email: 'jane.doe@example.com',
organization: 'example',
order_validity: 'example',
years: 1,
addr1: 'example',
method: 'example',
metadata_id: 1,
value: 'example',
number: 'example',
expiration_month: 1,
expiration_year: 1,
cvv: 1,
cardholder_name: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
code_signing_certificate_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
csr?: string,
signature_hash?: string,
ca_cert_id?: string,
server_platform?: JsonValue,
organization_units?: JsonValue[],
auto_renew?: number,
additional_emails?: JsonValue[],
renewal_of_order_id?: number,
skip_approval?: boolean,
organization_contact?: JsonValue,
first_name?: string,
last_name?: string,
email?: string,
job_title?: string,
telephone?: string,
telephone_extension?: string,
technical_contact?: JsonValue,
organization?: JsonValue,
id?: number,
name?: string,
assumed_name?: string,
country?: string,
address?: string,
address2?: string,
city?: string,
state?: string,
zip?: string,
contacts?: string,
skip_duplicate_org_check?: boolean,
container?: JsonValue,
order_validity?: JsonValue,
years?: number,
days?: number,
custom_expiration_date?: string,
cs_provisioning_method?: string,
ship_info?: JsonValue,
addr1?: string,
addr2?: string,
method?: string,
subject?: JsonValue,
custom_fields?: JsonValue,
metadata_id?: number,
value?: string,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: number,
expiration_year?: number,
cvv?: number,
cardholder_name?: string,
billing_address?: JsonValue,
vat_number?: string,
alternative_order_id?: string,
enable_guest_access?: number
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
organization | JsonValue | No | — |
requests | JsonValue[] | No | — |
status | string | No | — |
certificate_id | number | No | — |
orderCommonMarkCertificateCmc
certcentralApi.orderCommonMarkCertificateCmc
Order Common Mark Certificate (CMC)
Risk: destructive
await corsair.digicert.api.certcentralApi.orderCommonMarkCertificateCmc({
body: {
certificate: 'example',
order_validity: 'example',
years: 1,
number: 'example',
expiration_month: 1,
expiration_year: 1,
cvv: 1,
cardholder_name: 'example',
address: 'example',
city: 'example',
country: 'example',
first_name: 'example',
last_name: 'example',
email: 'jane.doe@example.com',
organization: 'example',
metadata_id: 1,
value: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
dns_names?: JsonValue[],
vmc?: JsonValue,
logo?: string,
enable_hosting?: boolean,
renewed_thumbprint?: string,
order_validity?: JsonValue,
years?: number,
comments?: string,
auto_renew?: number,
custom_renewal_message?: string,
disable_renewal_notifications?: boolean,
additional_emails?: JsonValue[],
locale?: string,
renewal_of_order_id?: number,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: number,
expiration_year?: number,
cvv?: number,
cardholder_name?: string,
billing_address?: JsonValue,
address?: string,
address2?: string,
city?: string,
state?: string,
country?: string,
zip?: string,
vat_number?: string,
dcv_method?: string,
skip_approval?: boolean,
organization_contact?: JsonValue,
first_name?: string,
last_name?: string,
email?: string,
job_title?: string,
telephone?: string,
telephone_extension?: string,
technical_contact?: JsonValue,
organization?: JsonValue,
id?: number,
skip_duplicate_org_check?: boolean,
contacts?: JsonValue[],
container?: JsonValue,
custom_fields?: JsonValue[],
metadata_id?: number,
value?: string,
alternative_order_id?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
domains | JsonValue[] | No | — |
name | number | No | — |
dns_name | string | No | — |
dcv_token | JsonValue | No | — |
requests | JsonValue[] | No | — |
status | string | No | — |
certificate_id | number | No | — |
vmc | JsonValue | No | — |
logo_id | number | No | — |
orderDocumentSigningCertificate
certcentralApi.orderDocumentSigningCertificate
Order document signing certificate
Risk: destructive
await corsair.digicert.api.certcentralApi.orderDocumentSigningCertificate({
path: { document_certificate_id: 'example' },
body: {
certificate: 'example',
signature_hash: 'example',
order_validity: 'example',
years: 1,
first_name: 'example',
last_name: 'example',
email: 'jane.doe@example.com',
organization: 'example',
id: 1,
name: 'example',
addr1: 'example',
city: 'example',
state: 'example',
zip: 'example',
country: 'example',
method: 'example',
subject: 'example',
phone: 'example',
metadata_id: 1,
value: 'example',
number: 'example',
expiration_month: 1,
expiration_year: 1,
cvv: 1,
cardholder_name: 'example',
address: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
document_certificate_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
csr?: string,
server_platform?: JsonValue,
signature_hash?: string,
cs_provisioning_method?: string,
use_org_as_common_name?: boolean,
order_validity?: JsonValue,
years?: number,
validity_years?: number,
comments?: string,
organization_contact?: JsonValue,
first_name?: string,
last_name?: string,
email?: string,
job_title?: string,
telephone?: string,
telephone_extension?: string,
technical_contact?: JsonValue,
organization?: JsonValue,
id?: number,
contacts?: JsonValue[],
skip_duplicate_org_check?: boolean,
container?: JsonValue,
ship_info?: JsonValue,
name?: string,
addr1?: string,
addr2?: string,
city?: string,
state?: string,
zip?: string,
country?: string,
method?: string,
subject?: JsonValue,
phone?: string,
custom_fields?: JsonValue,
metadata_id?: number,
value?: string,
user_id_assignments?: JsonValue[],
skip_approval?: boolean,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: number,
expiration_year?: number,
cvv?: number,
cardholder_name?: string,
billing_address?: JsonValue,
address?: string,
address2?: string,
vat_number?: string,
alternative_order_id?: string,
enable_guest_access?: number
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
organization | JsonValue | No | — |
requests | JsonValue[] | No | — |
status | string | No | — |
certificate_id | number | No | — |
orderDocumentSigningForEmployee
certcentralApi.orderDocumentSigningForEmployee
Order Document Signing for Employee
Risk: destructive
await corsair.digicert.api.certcentralApi.orderDocumentSigningForEmployee({
body: {
certificate: 'example',
usage_designation: 'example',
cs_provisioning_method: 'example',
name: 'example',
addr1: 'example',
addr2: 'example',
city: 'example',
state: 'example',
zip: 'example',
country: 'example',
method: 'example',
organization: 'example',
id: 1,
contacts: ['example'],
csa_agreed_to: true,
subject: 'example',
given_name: 'example',
surname: 'example',
job_title: 'example',
phone: 'example',
email: 'jane.doe@example.com',
order_validity: 'example',
years: 1,
payment_method: 'example',
credit_card: 'example',
number: 'example',
expiration_month: 'example',
expiration_year: 'example',
cvv: 'example',
cardholder_name: 'example',
set_as_default: 'example',
address: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
server_platform?: JsonValue,
ca_cert_id?: string,
usage_designation?: JsonValue,
cs_provisioning_method?: string,
ship_info?: JsonValue,
name?: string,
addr1?: string,
addr2?: string,
city?: string,
state?: string,
zip?: string,
country?: string,
method?: string,
csr?: string,
key_size?: number,
csr_key_type?: string,
signature_hash?: string,
comments?: string,
organization?: JsonValue,
id?: number,
contacts?: JsonValue[],
container?: JsonValue,
renewal_of_order_id?: number,
custom_renewal_message?: string,
additional_emails?: JsonValue[],
user_id_assignments?: JsonValue[],
csa_agreed_to?: boolean,
promo_code?: string,
subject?: JsonValue,
given_name?: string,
surname?: string,
job_title?: string,
phone?: string,
email?: string,
order_validity?: JsonValue,
years?: number,
days?: number,
custom_expiration_date?: string,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: string,
expiration_year?: string,
cvv?: string,
cardholder_name?: string,
save_credit_card?: string,
set_as_default?: string,
billing_address?: JsonValue,
address?: string,
address2?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
organization | JsonValue | No | — |
requests | JsonValue[] | No | — |
status | string | No | — |
certificate_id | number | No | — |
orderDocumentSigningForIndividual
certcentralApi.orderDocumentSigningForIndividual
Order Document Signing for Individual
Risk: destructive
await corsair.digicert.api.certcentralApi.orderDocumentSigningForIndividual({
body: {
certificate: 'example',
usage_designation: 'example',
cs_provisioning_method: 'example',
name: 'example',
addr1: 'example',
addr2: 'example',
city: 'example',
state: 'example',
zip: 'example',
country: 'example',
method: 'example',
csa_agreed_to: true,
order_validity: 'example',
years: 1,
individual: 'example',
first_name: 'example',
last_name: 'example',
email: 'jane.doe@example.com',
telephone: 'example',
payment_method: 'example',
credit_card: 'example',
number: 'example',
expiration_month: 'example',
expiration_year: 'example',
cvv: 'example',
cardholder_name: 'example',
set_as_default: 'example',
address: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
server_platform?: JsonValue,
ca_cert_id?: string,
usage_designation?: JsonValue,
cs_provisioning_method?: string,
ship_info?: JsonValue,
name?: string,
addr1?: string,
addr2?: string,
city?: string,
state?: string,
zip?: string,
country?: string,
method?: string,
csr?: string,
key_size?: number,
csr_key_type?: string,
signature_hash?: string,
comments?: string,
renewal_of_order_id?: number,
custom_renewal_message?: string,
additional_emails?: JsonValue[],
user_id_assignments?: JsonValue[],
csa_agreed_to?: boolean,
promo_code?: string,
order_validity?: JsonValue,
years?: number,
days?: number,
custom_expiration_date?: string,
individual?: JsonValue,
first_name?: string,
last_name?: string,
email?: string,
telephone?: string,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: string,
expiration_year?: string,
cvv?: string,
cardholder_name?: string,
save_credit_card?: string,
set_as_default?: string,
billing_address?: JsonValue,
address?: string,
address2?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
organization | JsonValue | No | — |
requests | JsonValue[] | No | — |
status | string | No | — |
certificate_id | number | No | — |
orderDocumentSigningForOrganization
certcentralApi.orderDocumentSigningForOrganization
Order Document Signing for Organization
Risk: destructive
await corsair.digicert.api.certcentralApi.orderDocumentSigningForOrganization({
body: {
certificate: 'example',
usage_designation: 'example',
cs_provisioning_method: 'example',
name: 'example',
addr1: 'example',
addr2: 'example',
city: 'example',
state: 'example',
zip: 'example',
country: 'example',
method: 'example',
organization: 'example',
id: 1,
contacts: ['example'],
csa_agreed_to: true,
order_validity: 'example',
years: 1,
payment_method: 'example',
credit_card: 'example',
number: 'example',
expiration_month: 'example',
expiration_year: 'example',
cvv: 'example',
cardholder_name: 'example',
set_as_default: 'example',
address: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
server_platform?: JsonValue,
ca_cert_id?: string,
usage_designation?: JsonValue,
cs_provisioning_method?: string,
ship_info?: JsonValue,
name?: string,
addr1?: string,
addr2?: string,
city?: string,
state?: string,
zip?: string,
country?: string,
method?: string,
csr?: string,
key_size?: number,
csr_key_type?: string,
signature_hash?: string,
comments?: string,
organization?: JsonValue,
id?: number,
contacts?: JsonValue[],
container?: JsonValue,
renewal_of_order_id?: number,
custom_renewal_message?: string,
additional_emails?: JsonValue[],
user_id_assignments?: JsonValue[],
csa_agreed_to?: boolean,
promo_code?: string,
order_validity?: JsonValue,
years?: number,
days?: number,
custom_expiration_date?: string,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: string,
expiration_year?: string,
cvv?: string,
cardholder_name?: string,
save_credit_card?: string,
set_as_default?: string,
billing_address?: JsonValue,
address?: string,
address2?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
organization | JsonValue | No | — |
requests | JsonValue[] | No | — |
status | string | No | — |
certificate_id | number | No | — |
orderDvSsl
certcentralApi.orderDvSsl
Order DV SSL
Risk: destructive
await corsair.digicert.api.certcentralApi.orderDvSsl({
path: { dv_ssl_certificate_id: 'example' },
body: {
certificate: 'example',
common_name: 'example',
csr: 'example',
order_validity: 'example',
years: 1,
number: 'example',
expiration_month: 1,
expiration_year: 1,
cvv: 1,
cardholder_name: 'example',
address: 'example',
city: 'example',
country: 'example',
dns_name: 'example',
email_domain: 'jane.doe@example.com',
id: 1,
metadata_id: 1,
value: 'example',
first_name: 'example',
last_name: 'example',
telephone: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
dv_ssl_certificate_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
common_name?: string,
dns_names?: JsonValue[],
csr?: string,
profile_option?: string,
organization_units?: JsonValue[],
server_platform?: JsonValue,
cert_validity?: JsonValue,
ca_cert_id?: string,
renewed_thumbprint?: string,
order_validity?: JsonValue,
years?: number,
days?: number,
custom_expiration_date?: string,
comments?: string,
apply_cr_discount?: boolean,
serial_number?: string,
auto_renew?: number,
auto_reissue?: number,
custom_renewal_message?: string,
disable_renewal_notifications?: boolean,
additional_emails?: JsonValue[],
renewal_of_order_id?: number,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: number,
expiration_year?: number,
cvv?: number,
cardholder_name?: string,
billing_address?: JsonValue,
address?: string,
address2?: string,
city?: string,
state?: string,
country?: string,
zip?: string,
vat_number?: string,
dcv_method?: string,
dcv_emails?: JsonValue[],
use_auth_key?: boolean,
auth_key_id?: string,
dns_name?: string,
email_domain?: string,
email?: string,
locale?: string,
skip_approval?: boolean,
disable_ct?: number,
container?: JsonValue,
id?: number,
custom_fields?: JsonValue[],
metadata_id?: number,
value?: string,
technical_contact?: JsonValue,
first_name?: string,
last_name?: string,
telephone?: string,
job_title?: string,
alternative_order_id?: string,
enable_guest_access?: number,
certificate_dcv_scope?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
certificate_id | number | No | — |
dcv_random_value | string | No | — |
certificate_chain | JsonValue[] | No | — |
subject_common_name | string | No | — |
pem | string | No | — |
requests | JsonValue[] | No | — |
status | string | No | — |
orderEuQualifiedESeal
certcentralApi.orderEuQualifiedESeal
Order EU Qualified eSeal
Risk: destructive
await corsair.digicert.api.certcentralApi.orderEuQualifiedESeal({
body: {
certificate: 'example',
signature_hash: 'example',
profile_option: 'example',
csa_agreed_to: true,
provisioning_method: 'example',
name: 'example',
addr1: 'example',
addr2: 'example',
city: 'example',
state: 'example',
zip: 'example',
country: 'example',
method: 'example',
organization: 'example',
id: 1,
contacts: ['example'],
payment_method: 'example',
credit_card: 'example',
number: 'example',
expiration_month: 'example',
expiration_year: 'example',
cvv: 'example',
cardholder_name: 'example',
set_as_default: 'example',
address: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
signature_hash?: string,
profile_option?: string,
is_rsassa_pss?: boolean,
csa_agreed_to?: boolean,
provisioning_method?: string,
ship_info?: JsonValue,
name?: string,
addr1?: string,
addr2?: string,
city?: string,
state?: string,
zip?: string,
country?: string,
method?: string,
csr?: string,
organization?: JsonValue,
id?: number,
contacts?: JsonValue[],
cert_validity?: JsonValue,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: string,
expiration_year?: string,
cvv?: string,
cardholder_name?: string,
save_credit_card?: string,
set_as_default?: string,
billing_address?: JsonValue,
address?: string,
address2?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
organization | JsonValue | No | — |
requests | JsonValue[] | No | — |
status | string | No | — |
certificate_id | number | No | — |
orderEuQualifiedESealPsd2
certcentralApi.orderEuQualifiedESealPsd2
Order EU Qualified eSeal PSD2
Risk: destructive
await corsair.digicert.api.certcentralApi.orderEuQualifiedESealPsd2({
body: {
certificate: 'example',
signature_hash: 'example',
profile_option: 'example',
psp_roles: ['example'],
csa_agreed_to: true,
provisioning_method: 'example',
name: 'example',
addr1: 'example',
addr2: 'example',
city: 'example',
state: 'example',
zip: 'example',
country: 'example',
method: 'example',
organization: 'example',
id: 1,
contacts: ['example'],
payment_method: 'example',
credit_card: 'example',
number: 'example',
expiration_month: 'example',
expiration_year: 'example',
cvv: 'example',
cardholder_name: 'example',
set_as_default: 'example',
address: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
signature_hash?: string,
profile_option?: string,
psp_roles?: JsonValue[],
is_rsassa_pss?: boolean,
csa_agreed_to?: boolean,
provisioning_method?: string,
ship_info?: JsonValue,
name?: string,
addr1?: string,
addr2?: string,
city?: string,
state?: string,
zip?: string,
country?: string,
method?: string,
csr?: string,
organization?: JsonValue,
id?: number,
contacts?: JsonValue[],
cert_validity?: JsonValue,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: string,
expiration_year?: string,
cvv?: string,
cardholder_name?: string,
save_credit_card?: string,
set_as_default?: string,
sca_token?: string,
billing_address?: JsonValue,
address?: string,
address2?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
organization | JsonValue | No | — |
requests | JsonValue[] | No | — |
status | string | No | — |
certificate_id | number | No | — |
orderEuQualifiedPersonal
certcentralApi.orderEuQualifiedPersonal
Order EU Qualified Personal
Risk: destructive
await corsair.digicert.api.certcentralApi.orderEuQualifiedPersonal({
body: {
certificate: 'example',
signature_hash: 'example',
profile_option: 'example',
common_name_indicator: 'example',
individual: 'example',
first_name: 'example',
last_name: 'example',
email: 'jane.doe@example.com',
telephone: 'example',
country: 'example',
state: 'example',
provisioning_method: 'example',
name: 'example',
addr1: 'example',
addr2: 'example',
method: 'example',
id: 1,
metadata_id: 1,
value: 'example',
payment_method: 'example',
credit_card: 'example',
number: 'example',
expiration_month: 'example',
expiration_year: 'example',
cvv: 'example',
cardholder_name: 'example',
set_as_default: 'example',
address: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
signature_hash?: string,
profile_option?: string,
common_name_indicator?: string,
individual?: JsonValue,
first_name?: string,
last_name?: string,
pseudonym?: string,
email?: string,
telephone?: string,
country?: string,
state?: string,
city?: string,
zip?: string,
provisioning_method?: string,
ship_info?: JsonValue,
name?: string,
addr1?: string,
addr2?: string,
method?: string,
csr?: string,
container?: JsonValue,
id?: number,
custom_fields?: JsonValue[],
metadata_id?: number,
value?: string,
alternative_order_id?: string,
enable_guest_access?: number,
renewed_thumbprint?: string,
cert_validity?: JsonValue,
comments?: string,
skip_approval?: boolean,
auto_renew?: number,
custom_renewal_message?: string,
disable_renewal_notifications?: boolean,
additional_emails?: JsonValue[],
locale?: string,
renewal_of_order_id?: number,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: string,
expiration_year?: string,
cvv?: string,
cardholder_name?: string,
save_credit_card?: string,
set_as_default?: string,
billing_address?: JsonValue,
address?: string,
address2?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
requests | JsonValue[] | No | — |
status | string | No | — |
certificate_id | number | No | — |
orderEuQualifiedPersonalOrganisation
certcentralApi.orderEuQualifiedPersonalOrganisation
Order EU Qualified Personal Organisation
Risk: destructive
await corsair.digicert.api.certcentralApi.orderEuQualifiedPersonalOrganisation({
body: {
certificate: 'example',
signature_hash: 'example',
profile_option: 'example',
common_name_indictator: 'example',
individual: 'example',
provisioning_method: 'example',
name: 'example',
addr1: 'example',
addr2: 'example',
city: 'example',
state: 'example',
zip: 'example',
organization: 'example',
id: 1,
contacts: ['example'],
metadata_id: 1,
value: 'example',
payment_method: 'example',
credit_card: 'example',
number: 'example',
expiration_month: 'example',
expiration_year: 'example',
cvv: 'example',
cardholder_name: 'example',
set_as_default: 'example',
address: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
signature_hash?: string,
profile_option?: string,
common_name_indictator?: string,
individual?: JsonValue,
provisioning_method?: string,
ship_info?: JsonValue,
name?: string,
addr1?: string,
addr2?: string,
city?: string,
state?: string,
zip?: string,
country?: string,
method?: string,
csr?: string,
organization?: JsonValue,
id?: number,
contacts?: JsonValue[],
container?: JsonValue,
custom_fields?: JsonValue[],
metadata_id?: number,
value?: string,
alternative_order_id?: string,
enable_guest_access?: number,
renewed_thumbprint?: string,
cert_validity?: JsonValue,
comments?: string,
skip_approval?: boolean,
auto_renew?: number,
custom_renewal_message?: string,
disable_renewal_notifications?: boolean,
additional_emails?: JsonValue[],
locale?: string,
renewal_of_order_id?: number,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: string,
expiration_year?: string,
cvv?: string,
cardholder_name?: string,
save_credit_card?: string,
set_as_default?: string,
billing_address?: JsonValue,
address?: string,
address2?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
organization | JsonValue | No | — |
requests | JsonValue[] | No | — |
status | string | No | — |
certificate_id | number | No | — |
orderEuQualifiedWebsiteAuthenticationCertificate
certcentralApi.orderEuQualifiedWebsiteAuthenticationCertificate
Order EU Qualified Website Authentication Certificate
Risk: destructive
await corsair.digicert.api.certcentralApi.orderEuQualifiedWebsiteAuthenticationCertificate({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: string,
common_name?: string,
service_name?: string,
dns_names?: string,
csr?: string,
profile_option?: string,
signature_hash?: string,
dcv_method?: string,
organization?: string,
id?: string,
contacts?: string,
server_platform?: string,
renewed_thumbprint-or-renewal_of_order_id?: string,
custom_expiration_date?: string,
cert_validity?: string,
payment_method?: string,
credit_card?: string,
number?: string,
expiration_month?: string,
expiration_year?: string,
cvv?: string,
cardholder_name?: string,
save_credit_card?: string,
set_as_default?: string,
billing_address?: string,
address?: string,
address2?: string,
city?: string,
state?: string,
country?: string,
zip?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
organization | JsonValue | No | — |
requests | JsonValue[] | No | — |
status | string | No | — |
certificate_id | number | No | — |
orderEuQualifiedWebsiteAuthenticationPsd2Certificate
certcentralApi.orderEuQualifiedWebsiteAuthenticationPsd2Certificate
Order EU Qualified Website Authentication PSD2 Certificate
Risk: destructive
await corsair.digicert.api.certcentralApi.orderEuQualifiedWebsiteAuthenticationPsd2Certificate({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: string,
common_name?: string,
service_name?: string,
dns_names?: string,
csr?: string,
signature_hash?: string,
psp_roles?: string,
dcv_method?: string,
organization?: string,
id?: string,
contacts?: string,
pseudonym?: string,
server_platform?: string,
profile_option?: string,
renewed_thumbprint-or-renewal_of_order_id?: string,
custom_expiration_date?: string,
cert_validity?: string,
payment_method?: string,
credit_card?: string,
number?: string,
expiration_month?: string,
expiration_year?: string,
cvv?: string,
cardholder_name?: string,
save_credit_card?: string,
set_as_default?: string,
sca_token?: string,
billing_address?: string,
address?: string,
address2?: string,
city?: string,
state?: string,
country?: string,
zip?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
organization | JsonValue | No | — |
requests | JsonValue[] | No | — |
status | string | No | — |
certificate_id | number | No | — |
orderGeoTrustDvSsl
certcentralApi.orderGeoTrustDvSsl
Order GeoTrust DV SSL
Risk: destructive
await corsair.digicert.api.certcentralApi.orderGeoTrustDvSsl({
body: {
certificate: 'example',
common_name: 'example',
csr: 'example',
signature_hash: 'example',
order_validity: 'example',
years: 1,
number: 'example',
expiration_month: 1,
expiration_year: 1,
cvv: 1,
cardholder_name: 'example',
address: 'example',
city: 'example',
country: 'example',
dns_name: 'example',
email_domain: 'jane.doe@example.com',
id: 1,
metadata_id: 1,
value: 'example',
first_name: 'example',
last_name: 'example',
telephone: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
common_name?: string,
dns_names?: JsonValue[],
csr?: string,
signature_hash?: string,
profile_option?: string,
organization_units?: JsonValue[],
server_platform?: JsonValue,
cert_validity?: JsonValue,
ca_cert_id?: string,
renewed_thumbprint?: string,
order_validity?: JsonValue,
years?: number,
days?: number,
custom_expiration_date?: string,
comments?: string,
apply_cr_discount?: boolean,
serial_number?: string,
auto_renew?: number,
auto_reissue?: number,
custom_renewal_message?: string,
disable_renewal_notifications?: boolean,
additional_emails?: JsonValue[],
renewal_of_order_id?: number,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: number,
expiration_year?: number,
cvv?: number,
cardholder_name?: string,
billing_address?: JsonValue,
address?: string,
address2?: string,
city?: string,
state?: string,
country?: string,
zip?: string,
vat_number?: string,
dcv_method?: string,
dcv_emails?: JsonValue[],
use_auth_key?: boolean,
auth_key_id?: string,
dns_name?: string,
email_domain?: string,
email?: string,
locale?: string,
skip_approval?: boolean,
disable_ct?: boolean,
container?: JsonValue,
id?: number,
custom_fields?: JsonValue[],
metadata_id?: number,
value?: string,
technical_contact?: JsonValue,
first_name?: string,
last_name?: string,
telephone?: string,
job_title?: string,
alternative_order_id?: string,
enable_guest_access?: number,
certificate_dcv_scope?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
certificate_id | number | No | — |
dcv_random_value | string | No | — |
certificate_chain | JsonValue[] | No | — |
subject_common_name | string | No | — |
pem | string | No | — |
requests | JsonValue[] | No | — |
status | string | No | — |
orderInfo
certcentralApi.orderInfo
Order info
Risk: read
await corsair.digicert.api.certcentralApi.orderInfo({
path: { order_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
include_caa_status?: boolean
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
certificate | JsonValue | No | — |
thumbprint | string | No | — |
serial_number | string | No | — |
common_name | string | No | — |
cert_validity | JsonValue | No | — |
emails | JsonValue[] | No | — |
dns_names | JsonValue[] | No | — |
date_created | string | No | — |
date_issued | string | No | — |
valid_from | string | No | — |
valid_till | string | No | — |
days_remaining | number | No | — |
csr | string | No | — |
organization | JsonValue | No | — |
organization_units | JsonValue[] | No | — |
server_platform | JsonValue | No | — |
signature_hash | string | No | — |
key_size | number | No | — |
ca_cert | JsonValue | No | — |
additional_emails | JsonValue[] | No | — |
status | string | No | — |
is_renewal | boolean | No | — |
is_renewed | boolean | No | — |
renewed_order_id | number | No | — |
was_renewed_by_order_id | number | No | — |
name | string | No | — |
assumed_name | string | No | — |
display_name | string | No | — |
city | string | No | — |
state | string | No | — |
country | string | No | — |
telephone | string | No | — |
validity_years | string | No | — |
order_valid_from | string | No | — |
order_valid_till | string | No | — |
order_validity | JsonValue | No | — |
years | number | No | — |
days | number | No | — |
custom_expiration_date | string | No | — |
disable_renewal_notifications | boolean | No | — |
auto_renew | number | No | — |
auto_reissue | number | No | — |
container | JsonValue | No | — |
is_active | boolean | No | — |
product | JsonValue | No | — |
name_id | string | No | — |
type | string | No | — |
validation_type | string | No | — |
validation_name | string | No | — |
validation_description | string | No | — |
csr_required | boolean | No | — |
organization_contact | JsonValue | No | — |
technical_contact | JsonValue | No | — |
user | JsonValue | No | — |
purchased_dns_names | number | No | — |
requests | JsonValue[] | No | — |
date | string | No | — |
comments | string | No | — |
receipt_id | number | No | — |
subject | JsonValue | No | — |
email | string | No | — |
cs_provisioning_method | string | No | — |
ship_info | JsonValue | No | — |
addr1 | string | No | — |
addr2 | string | No | — |
zip | string | No | — |
method | string | No | — |
hardware_init_code | string | No | — |
public_id | string | No | — |
allow_duplicates | boolean | No | — |
duplicates_count | number | No | — |
reissues_count | number | No | — |
price | number | No | — |
currency | string | No | — |
prices | JsonValue[] | No | — |
user_assignments | JsonValue[] | No | — |
is_out_of_contract | boolean | No | — |
payment_method | string | No | — |
payment_profile | JsonValue | No | — |
product_name_id | string | No | — |
custom_fields | JsonValue[] | No | — |
metadata_id | number | No | — |
label | string | No | — |
value | string | No | — |
disable_issuance_email | boolean | No | — |
disable_ct | boolean | No | — |
alternative_order_id | string | No | — |
api_key | JsonValue | No | — |
key_type | string | No | — |
benefits | JsonValue | No | — |
actual_price | string | No | — |
discount_percent | string | No | — |
benefits_data | JsonValue | No | — |
is_multi_year_plan | string | No | — |
order_approval_complete | boolean | No | — |
approver | JsonValue | No | — |
first_name | string | No | — |
last_name | string | No | — |
is_guest_access_enabled | boolean | No | — |
vmc | JsonValue | No | — |
logo_id | number | No | — |
logo | string | No | — |
enable_hosting | boolean | No | — |
hosted_logo_location | string | No | — |
hosted_cert_location | string | No | — |
mark_type | JsonValue | No | — |
mark_type_data | JsonValue | No | — |
trademark_country_code | string | No | — |
trademark_registration_number | string | No | — |
orderMultiYearPlanOrderMultiYearPlan
certcentralApi.orderMultiYearPlanOrderMultiYearPlan
Order Multi-year Plan — Order Multi-year Plan
Risk: destructive
await corsair.digicert.api.certcentralApi.orderMultiYearPlanOrderMultiYearPlan({
body: {
certificate: 'example',
common_name: 'example',
csr: 'example',
signature_hash: 'example',
order_validity: 'example',
years: 1,
number: 'example',
expiration_month: 1,
expiration_year: 1,
cvv: 1,
cardholder_name: 'example',
address: 'example',
city: 'example',
country: 'example',
first_name: 'example',
last_name: 'example',
email: 'jane.doe@example.com',
organization: 'example',
metadata_id: 1,
value: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
common_name?: string,
dns_names?: JsonValue[],
csr?: string,
signature_hash?: string,
organization_units?: JsonValue[],
server_platform?: JsonValue,
cert_validity?: JsonValue,
profile_option?: string,
ca_cert_id?: string,
renewed_thumbprint?: string,
order_validity?: JsonValue,
years?: number,
days?: number,
custom_expiration_date?: string,
comments?: string,
auto_renew?: number,
auto_reissue?: number,
custom_renewal_message?: string,
disable_renewal_notifications?: boolean,
additional_emails?: JsonValue[],
locale?: string,
renewal_of_order_id?: number,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: number,
expiration_year?: number,
cvv?: number,
cardholder_name?: string,
billing_address?: JsonValue,
address?: string,
address2?: string,
city?: string,
state?: string,
country?: string,
zip?: string,
vat_number?: string,
dcv_method?: string,
skip_approval?: boolean,
disable_ct?: boolean,
organization_contact?: JsonValue,
first_name?: string,
last_name?: string,
email?: string,
job_title?: string,
telephone?: string,
telephone_extension?: string,
technical_contact?: JsonValue,
organization?: JsonValue,
id?: number,
skip_duplicate_org_check?: boolean,
contacts?: JsonValue[],
container?: JsonValue,
custom_fields?: JsonValue[],
metadata_id?: number,
value?: string,
alternative_order_id?: string,
enable_guest_access?: number,
use_auth_key?: boolean,
certificate_dcv_scope?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
dcv_random_value | string | No | — |
organization | JsonValue | No | — |
domains | JsonValue[] | No | — |
name | number | No | — |
dns_name | string | No | — |
dcv_token | JsonValue | No | — |
requests | JsonValue[] | No | — |
status | string | No | — |
certificate_id | number | No | — |
certificate_chain | JsonValue[] | No | — |
subject_common_name | string | No | — |
pem | string | No | — |
orderOvEvSslOrderOvEvSsl
certcentralApi.orderOvEvSslOrderOvEvSsl
Order OV/EV SSL — Order OV/EV SSL
Risk: destructive
await corsair.digicert.api.certcentralApi.orderOvEvSslOrderOvEvSsl({
path: { ssl_certificate_id: 'example' },
body: {
certificate: 'example',
common_name: 'example',
csr: 'example',
signature_hash: 'example',
order_validity: 'example',
years: 1,
number: 'example',
expiration_month: 1,
expiration_year: 1,
cvv: 1,
cardholder_name: 'example',
address: 'example',
city: 'example',
country: 'example',
first_name: 'example',
last_name: 'example',
email: 'jane.doe@example.com',
organization: 'example',
id: 1,
metadata_id: 1,
value: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
ssl_certificate_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
common_name?: string,
dns_names?: JsonValue[],
csr?: string,
signature_hash?: string,
organization_units?: JsonValue[],
server_platform?: JsonValue,
cert_validity?: JsonValue,
profile_option?: string,
renewed_thumbprint?: string,
order_validity?: JsonValue,
years?: number,
days?: number,
custom_expiration_date?: string,
comments?: string,
apply_cr_discount?: boolean,
serial_number?: string,
auto_renew?: number,
auto_reissue?: number,
custom_renewal_message?: string,
disable_renewal_notifications?: boolean,
additional_emails?: JsonValue[],
renewal_of_order_id?: number,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: number,
expiration_year?: number,
cvv?: number,
cardholder_name?: string,
billing_address?: JsonValue,
address?: string,
address2?: string,
city?: string,
state?: string,
country?: string,
zip?: string,
vat_number?: string,
dcv_method?: string,
skip_approval?: boolean,
disable_ct?: boolean,
organization_contact?: JsonValue,
first_name?: string,
last_name?: string,
email?: string,
job_title?: string,
telephone?: string,
telephone_extension?: string,
technical_contact?: JsonValue,
organization?: JsonValue,
id?: number,
skip_duplicate_org_check?: boolean,
contacts?: JsonValue[],
container?: JsonValue,
custom_fields?: JsonValue[],
metadata_id?: number,
value?: string,
alternative_order_id?: string,
enable_guest_access?: number,
certificate_dcv_scope?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
dcv_random_value | string | No | — |
organization | JsonValue | No | — |
domains | JsonValue[] | No | — |
name | number | No | — |
dns_name | string | No | — |
dcv_token | JsonValue | No | — |
requests | JsonValue[] | No | — |
status | string | No | — |
certificate_id | number | No | — |
certificate_chain | JsonValue[] | No | — |
subject_common_name | string | No | — |
pem | string | No | — |
orderPkioAuthenticationOrEncryptionCitizen
certcentralApi.orderPkioAuthenticationOrEncryptionCitizen
Order PKIo Authentication or Encryption - Citizen
Risk: destructive
await corsair.digicert.api.certcentralApi.orderPkioAuthenticationOrEncryptionCitizen({
body: {
certificate: 'example',
signature_hash: 'example',
profile_option: 'example',
individual: 'example',
csa_agreed_to: true,
provisioning_method: 'example',
ship_info: 'example',
name: 'example',
addr1: 'example',
addr2: 'example',
city: 'example',
state: 'example',
zip: 'example',
country: 'example',
method: 'example',
payment_method: 'example',
credit_card: 'example',
number: 'example',
expiration_month: 'example',
expiration_year: 'example',
cvv: 'example',
cardholder_name: 'example',
set_as_default: 'example',
address: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
signature_hash?: string,
profile_option?: string,
is_rsassa_pss?: boolean,
individual?: JsonValue,
csa_agreed_to?: boolean,
provisioning_method?: string,
ship_info?: JsonValue,
name?: string,
addr1?: string,
addr2?: string,
city?: string,
state?: string,
zip?: string,
country?: string,
method?: string,
order_validity?: JsonValue,
years?: number,
days?: number,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: string,
expiration_year?: string,
cvv?: string,
cardholder_name?: string,
save_credit_card?: string,
set_as_default?: string,
billing_address?: JsonValue,
address?: string,
address2?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
certificate_id | number | No | — |
orderPkioAuthenticationOrEncryptionOrganisationPerson
certcentralApi.orderPkioAuthenticationOrEncryptionOrganisationPerson
Order PKIo Authentication or Encryption - Organisation Person
Risk: destructive
await corsair.digicert.api.certcentralApi.orderPkioAuthenticationOrEncryptionOrganisationPerson({
body: {
certificate: 'example',
signature_hash: 'example',
profile_option: 'example',
individual: 'example',
csa_agreed_to: true,
cs_provisioning_method: 'example',
name: 'example',
addr1: 'example',
addr2: 'example',
city: 'example',
state: 'example',
zip: 'example',
country: 'example',
method: 'example',
organization: 'example',
id: 1,
contacts: ['example'],
payment_method: 'example',
credit_card: 'example',
number: 'example',
expiration_month: 'example',
expiration_year: 'example',
cvv: 'example',
cardholder_name: 'example',
set_as_default: 'example',
address: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
signature_hash?: string,
profile_option?: string,
is_rsassa_pss?: boolean,
individual?: JsonValue,
csa_agreed_to?: boolean,
cs_provisioning_method?: string,
ship_info?: JsonValue,
name?: string,
addr1?: string,
addr2?: string,
city?: string,
state?: string,
zip?: string,
country?: string,
method?: string,
organization?: JsonValue,
id?: number,
contacts?: JsonValue[],
order_validity?: JsonValue,
years?: number,
days?: number,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: string,
expiration_year?: string,
cvv?: string,
cardholder_name?: string,
save_credit_card?: string,
set_as_default?: string,
billing_address?: JsonValue,
address?: string,
address2?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
certificate_id | number | No | — |
organization | JsonValue | No | — |
orderPkioAuthenticationOrEncryptionOrganisationServices
certcentralApi.orderPkioAuthenticationOrEncryptionOrganisationServices
Order PKIo Authentication or Encryption - Organisation Services
Risk: destructive
await corsair.digicert.api.certcentralApi.orderPkioAuthenticationOrEncryptionOrganisationServices({
body: {
certificate: 'example',
signature_hash: 'example',
profile_option: 'example',
csa_agreed_to: true,
provisioning_method: 'example',
name: 'example',
addr1: 'example',
addr2: 'example',
city: 'example',
state: 'example',
zip: 'example',
country: 'example',
method: 'example',
organization: 'example',
id: 1,
contacts: ['example'],
payment_method: 'example',
credit_card: 'example',
number: 'example',
expiration_month: 'example',
expiration_year: 'example',
cvv: 'example',
cardholder_name: 'example',
set_as_default: 'example',
address: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
signature_hash?: string,
profile_option?: string,
is_rsassa_pss?: boolean,
csa_agreed_to?: boolean,
provisioning_method?: string,
ship_info?: JsonValue,
name?: string,
addr1?: string,
addr2?: string,
city?: string,
state?: string,
zip?: string,
country?: string,
method?: string,
organization?: JsonValue,
id?: number,
contacts?: JsonValue[],
order_validity?: JsonValue,
years?: number,
days?: number,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: string,
expiration_year?: string,
cvv?: string,
cardholder_name?: string,
save_credit_card?: string,
set_as_default?: string,
billing_address?: JsonValue,
address?: string,
address2?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
certificate_id | number | No | — |
organization | JsonValue | No | — |
orderPkioAuthenticationOrEncryptionPrivatePerson
certcentralApi.orderPkioAuthenticationOrEncryptionPrivatePerson
Order PKIo Authentication or Encryption - Private Person
Risk: destructive
await corsair.digicert.api.certcentralApi.orderPkioAuthenticationOrEncryptionPrivatePerson({
body: {
certificate: 'example',
signature_hash: 'example',
profile_option: 'example',
individual: 'example',
csa_agreed_to: true,
provisioning_method: 'example',
name: 'example',
addr1: 'example',
addr2: 'example',
city: 'example',
state: 'example',
zip: 'example',
country: 'example',
method: 'example',
organization: 'example',
id: 1,
contacts: ['example'],
payment_method: 'example',
credit_card: 'example',
number: 'example',
expiration_month: 'example',
expiration_year: 'example',
cvv: 'example',
cardholder_name: 'example',
set_as_default: 'example',
address: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
signature_hash?: string,
profile_option?: string,
is_rsassa_pss?: boolean,
individual?: JsonValue,
csa_agreed_to?: boolean,
provisioning_method?: string,
ship_info?: JsonValue,
name?: string,
addr1?: string,
addr2?: string,
city?: string,
state?: string,
zip?: string,
country?: string,
method?: string,
organization?: JsonValue,
id?: number,
contacts?: JsonValue[],
order_validity?: JsonValue,
years?: number,
days?: number,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: string,
expiration_year?: string,
cvv?: string,
cardholder_name?: string,
save_credit_card?: string,
set_as_default?: string,
billing_address?: JsonValue,
address?: string,
address2?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
certificate_id | number | No | — |
organization | JsonValue | No | — |
orderPkioAuthenticationOrEncryptionPrivateProfessional
certcentralApi.orderPkioAuthenticationOrEncryptionPrivateProfessional
Order PKIo Authentication or Encryption - Private Professional
Risk: destructive
await corsair.digicert.api.certcentralApi.orderPkioAuthenticationOrEncryptionPrivateProfessional({
body: {
certificate: 'example',
signature_hash: 'example',
profile_option: 'example',
individual: 'example',
csa_agreed_to: true,
provisioning_method: 'example',
name: 'example',
addr1: 'example',
addr2: 'example',
city: 'example',
state: 'example',
zip: 'example',
country: 'example',
method: 'example',
payment_method: 'example',
credit_card: 'example',
number: 'example',
expiration_month: 'example',
expiration_year: 'example',
cvv: 'example',
cardholder_name: 'example',
set_as_default: 'example',
address: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
signature_hash?: string,
profile_option?: string,
is_rsassa_pss?: boolean,
individual?: JsonValue,
csa_agreed_to?: boolean,
provisioning_method?: string,
ship_info?: JsonValue,
name?: string,
addr1?: string,
addr2?: string,
city?: string,
state?: string,
zip?: string,
country?: string,
method?: string,
order_validity?: JsonValue,
years?: number,
days?: number,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: string,
expiration_year?: string,
cvv?: string,
cardholder_name?: string,
save_credit_card?: string,
set_as_default?: string,
billing_address?: JsonValue,
address?: string,
address2?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
certificate_id | number | No | — |
orderPkioAuthenticationOrEncryptionProfessional
certcentralApi.orderPkioAuthenticationOrEncryptionProfessional
Order PKIo Authentication or Encryption - Professional
Risk: destructive
await corsair.digicert.api.certcentralApi.orderPkioAuthenticationOrEncryptionProfessional({
body: {
certificate: 'example',
signature_hash: 'example',
profile_option: 'example',
individual: 'example',
csa_agreed_to: true,
cs_provisioning_method: 'example',
name: 'example',
addr1: 'example',
addr2: 'example',
city: 'example',
state: 'example',
zip: 'example',
country: 'example',
method: 'example',
payment_method: 'example',
credit_card: 'example',
number: 'example',
expiration_month: 'example',
expiration_year: 'example',
cvv: 'example',
cardholder_name: 'example',
set_as_default: 'example',
address: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
signature_hash?: string,
profile_option?: string,
is_rsassa_pss?: boolean,
individual?: JsonValue,
csa_agreed_to?: boolean,
cs_provisioning_method?: string,
ship_info?: JsonValue,
name?: string,
addr1?: string,
addr2?: string,
city?: string,
state?: string,
zip?: string,
country?: string,
method?: string,
order_validity?: JsonValue,
years?: number,
days?: number,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: string,
expiration_year?: string,
cvv?: string,
cardholder_name?: string,
save_credit_card?: string,
set_as_default?: string,
billing_address?: JsonValue,
address?: string,
address2?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
certificate_id | number | No | — |
orderPkioCitizenSigning
certcentralApi.orderPkioCitizenSigning
Order PKIo Citizen - Signing
Risk: destructive
await corsair.digicert.api.certcentralApi.orderPkioCitizenSigning({
body: {
certificate: 'example',
signature_hash: 'example',
profile_option: 'example',
individual: 'example',
csa_agreed_to: true,
provisioning_method: 'example',
name: 'example',
addr1: 'example',
addr2: 'example',
city: 'example',
state: 'example',
zip: 'example',
country: 'example',
method: 'example',
payment_method: 'example',
credit_card: 'example',
number: 'example',
expiration_month: 'example',
expiration_year: 'example',
cvv: 'example',
cardholder_name: 'example',
set_as_default: 'example',
address: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
signature_hash?: string,
profile_option?: string,
is_rsassa_pss?: boolean,
individual?: JsonValue,
csa_agreed_to?: boolean,
provisioning_method?: string,
ship_info?: JsonValue,
name?: string,
addr1?: string,
addr2?: string,
city?: string,
state?: string,
zip?: string,
country?: string,
method?: string,
order_validity?: JsonValue,
years?: number,
days?: number,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: string,
expiration_year?: string,
cvv?: string,
cardholder_name?: string,
save_credit_card?: string,
set_as_default?: string,
billing_address?: JsonValue,
address?: string,
address2?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
certificate_id | number | No | — |
orderPkioPersonalOrganisationSigning
certcentralApi.orderPkioPersonalOrganisationSigning
Order PKIo Personal Organisation - Signing
Risk: destructive
await corsair.digicert.api.certcentralApi.orderPkioPersonalOrganisationSigning({
body: {
certificate: 'example',
signature_hash: 'example',
profile_option: 'example',
individual: 'example',
csa_agreed_to: true,
provisioning_method: 'example',
name: 'example',
addr1: 'example',
addr2: 'example',
city: 'example',
state: 'example',
zip: 'example',
country: 'example',
method: 'example',
organization: 'example',
id: 1,
contacts: ['example'],
payment_method: 'example',
credit_card: 'example',
number: 'example',
expiration_month: 'example',
expiration_year: 'example',
cvv: 'example',
cardholder_name: 'example',
set_as_default: 'example',
address: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
signature_hash?: string,
profile_option?: string,
is_rsassa_pss?: boolean,
individual?: JsonValue,
csa_agreed_to?: boolean,
provisioning_method?: string,
ship_info?: JsonValue,
name?: string,
addr1?: string,
addr2?: string,
city?: string,
state?: string,
zip?: string,
country?: string,
method?: string,
organization?: JsonValue,
id?: number,
contacts?: JsonValue[],
order_validity?: JsonValue,
years?: number,
days?: number,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: string,
expiration_year?: string,
cvv?: string,
cardholder_name?: string,
save_credit_card?: string,
set_as_default?: string,
billing_address?: JsonValue,
address?: string,
address2?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
organization | JsonValue | No | — |
requests | JsonValue[] | No | — |
status | string | No | — |
certificate_id | number | No | — |
orderPkioPrivatePersonSigningOrderPkioPrivatePersonSigning
certcentralApi.orderPkioPrivatePersonSigningOrderPkioPrivatePersonSigning
Order PKIo Private Person - Signing — Order PKIo Private Person - Signing
Risk: destructive
await corsair.digicert.api.certcentralApi.orderPkioPrivatePersonSigningOrderPkioPrivatePersonSigning({
body: {
certificate: 'example',
signature_hash: 'example',
individual: 'example',
id: 1,
csa_agreed_to: true,
provisioning_method: 'example',
name: 'example',
addr1: 'example',
addr2: 'example',
city: 'example',
state: 'example',
zip: 'example',
country: 'example',
method: 'example',
organization: 'example',
contacts: ['example'],
payment_method: 'example',
credit_card: 'example',
number: 'example',
expiration_month: 'example',
expiration_year: 'example',
cvv: 'example',
cardholder_name: 'example',
set_as_default: 'example',
address: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
signature_hash?: string,
profile_option?: string,
is_rsassa_pss?: boolean,
individual?: JsonValue,
container?: JsonValue,
id?: number,
csa_agreed_to?: boolean,
provisioning_method?: string,
ship_info?: JsonValue,
name?: string,
addr1?: string,
addr2?: string,
city?: string,
state?: string,
zip?: string,
country?: string,
method?: string,
organization?: JsonValue,
contacts?: JsonValue[],
order_validity?: JsonValue,
years?: number,
days?: number,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: string,
expiration_year?: string,
cvv?: string,
cardholder_name?: string,
save_credit_card?: string,
set_as_default?: string,
billing_address?: JsonValue,
address?: string,
address2?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
certificate_id | number | No | — |
organization | JsonValue | No | — |
orderPkioPrivateProfessionalSigningOrderPkioPrivateProfessionalSigning
certcentralApi.orderPkioPrivateProfessionalSigningOrderPkioPrivateProfessionalSigning
Order PKIo Private Professional - Signing — Order PKIo Private Professional - Signing
Risk: destructive
await corsair.digicert.api.certcentralApi.orderPkioPrivateProfessionalSigningOrderPkioPrivateProfessionalSigning({
body: {
certificate: 'example',
signature_hash: 'example',
individual: 'example',
id: 1,
csa_agreed_to: true,
provisioning_method: 'example',
name: 'example',
addr1: 'example',
addr2: 'example',
city: 'example',
state: 'example',
zip: 'example',
country: 'example',
method: 'example',
organization: 'example',
contacts: ['example'],
payment_method: 'example',
credit_card: 'example',
number: 'example',
expiration_month: 'example',
expiration_year: 'example',
cvv: 'example',
cardholder_name: 'example',
set_as_default: 'example',
address: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
signature_hash?: string,
profile_option?: string,
is_rsassa_pss?: boolean,
individual?: JsonValue,
container?: JsonValue,
id?: number,
csa_agreed_to?: boolean,
provisioning_method?: string,
ship_info?: JsonValue,
name?: string,
addr1?: string,
addr2?: string,
city?: string,
state?: string,
zip?: string,
country?: string,
method?: string,
organization?: JsonValue,
contacts?: JsonValue[],
order_validity?: JsonValue,
years?: number,
days?: number,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: string,
expiration_year?: string,
cvv?: string,
cardholder_name?: string,
save_credit_card?: string,
set_as_default?: string,
billing_address?: JsonValue,
address?: string,
address2?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
certificate_id | number | No | — |
organization | JsonValue | No | — |
orderPkioPrivateServicesServer
certcentralApi.orderPkioPrivateServicesServer
Order PKIo Private Services Server
Risk: destructive
await corsair.digicert.api.certcentralApi.orderPkioPrivateServicesServer({
body: {
certificate: 'example',
signature_hash: 'example',
csr: 'example',
csa_agreed_to: true,
id: 1,
organization: 'example',
contacts: ['example'],
payment_method: 'example',
credit_card: 'example',
number: 'example',
expiration_month: 'example',
expiration_year: 'example',
cvv: 'example',
cardholder_name: 'example',
set_as_default: 'example',
address: 'example',
city: 'example',
country: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
signature_hash?: string,
oin?: number,
exclude_oin?: boolean,
common_name?: string,
dns_names?: JsonValue[],
server_platform?: JsonValue,
csr?: string,
disable_generate_in_browser_email?: boolean,
csa_agreed_to?: boolean,
dcv_method?: string,
certificate_dcv_scope?: string,
use_qvtl_domain?: string,
container?: JsonValue,
id?: number,
organization?: JsonValue,
contacts?: JsonValue[],
order_validity?: JsonValue,
years?: number,
days?: number,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: string,
expiration_year?: string,
cvv?: string,
cardholder_name?: string,
save_credit_card?: string,
set_as_default?: string,
billing_address?: JsonValue,
address?: string,
address2?: string,
city?: string,
state?: string,
country?: string,
zip?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
domains | JsonValue | No | — |
name | string | No | — |
dns_name | string | No | — |
certificate_id | number | No | — |
orderPkioProfessionalSigning
certcentralApi.orderPkioProfessionalSigning
Order PKIo Professional - Signing
Risk: destructive
await corsair.digicert.api.certcentralApi.orderPkioProfessionalSigning({
body: {
certificate: 'example',
signature_hash: 'example',
profile_option: 'example',
individual: 'example',
csa_agreed_to: true,
provisioning_method: 'example',
name: 'example',
addr1: 'example',
addr2: 'example',
city: 'example',
state: 'example',
zip: 'example',
country: 'example',
method: 'example',
payment_method: 'example',
credit_card: 'example',
number: 'example',
expiration_month: 'example',
expiration_year: 'example',
cvv: 'example',
cardholder_name: 'example',
set_as_default: 'example',
address: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
signature_hash?: string,
profile_option?: string,
is_rsassa_pss?: boolean,
individual?: JsonValue,
csa_agreed_to?: boolean,
provisioning_method?: string,
ship_info?: JsonValue,
name?: string,
addr1?: string,
addr2?: string,
city?: string,
state?: string,
zip?: string,
country?: string,
method?: string,
order_validity?: JsonValue,
years?: number,
days?: number,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: string,
expiration_year?: string,
cvv?: string,
cardholder_name?: string,
save_credit_card?: string,
set_as_default?: string,
billing_address?: JsonValue,
address?: string,
address2?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
certificate_id | number | No | — |
orderPkioQualifiedESeal
certcentralApi.orderPkioQualifiedESeal
Order PKIo Qualified eSeal
Risk: destructive
await corsair.digicert.api.certcentralApi.orderPkioQualifiedESeal({
body: {
certificate: 'example',
signature_hash: 'example',
profile_option: 'example',
csa_agreed_to: true,
provisioning_method: 'example',
name: 'example',
addr1: 'example',
addr2: 'example',
city: 'example',
state: 'example',
zip: 'example',
country: 'example',
method: 'example',
organization: 'example',
id: 1,
contacts: ['example'],
payment_method: 'example',
credit_card: 'example',
number: 'example',
expiration_month: 'example',
expiration_year: 'example',
cvv: 'example',
cardholder_name: 'example',
set_as_default: 'example',
address: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
signature_hash?: string,
profile_option?: string,
is_rsassa_pss?: boolean,
csa_agreed_to?: boolean,
provisioning_method?: string,
ship_info?: JsonValue,
name?: string,
addr1?: string,
addr2?: string,
city?: string,
state?: string,
zip?: string,
country?: string,
method?: string,
organization?: JsonValue,
id?: number,
contacts?: JsonValue[],
order_validity?: JsonValue,
years?: number,
days?: number,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: string,
expiration_year?: string,
cvv?: string,
cardholder_name?: string,
save_credit_card?: string,
set_as_default?: string,
billing_address?: JsonValue,
address?: string,
address2?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
organization | JsonValue | No | — |
requests | JsonValue[] | No | — |
status | string | No | — |
certificate_id | number | No | — |
orderPrivateSsl
certcentralApi.orderPrivateSsl
Order Private SSL
Risk: destructive
await corsair.digicert.api.certcentralApi.orderPrivateSsl({
path: { private_ssl_certificate_id: 'example' },
body: {
certificate: 'example',
common_name: 'example',
csr: 'example',
signature_hash: 'example',
order_validity: 'example',
years: 1,
number: 'example',
expiration_month: 1,
expiration_year: 1,
cvv: 1,
cardholder_name: 'example',
address: 'example',
city: 'example',
country: 'example',
first_name: 'example',
last_name: 'example',
email: 'jane.doe@example.com',
organization: 'example',
id: 1,
metadata_id: 1,
value: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
private_ssl_certificate_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
common_name?: string,
dns_names?: JsonValue[],
csr?: string,
signature_hash?: string,
ca_cert_id?: string,
organization_units?: JsonValue[],
server_platform?: JsonValue,
profile_option?: string,
renewed_thumbprint?: string,
order_validity?: JsonValue,
years?: number,
days?: number,
custom_expiration_date?: string,
validity_years?: number,
validity_days?: number,
comments?: string,
auto_renew?: number,
custom_renewal_message?: string,
disable_renewal_notifications?: boolean,
additional_emails?: JsonValue[],
renewal_of_order_id?: number,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: number,
expiration_year?: number,
cvv?: number,
cardholder_name?: string,
billing_address?: JsonValue,
address?: string,
address2?: string,
city?: string,
state?: string,
country?: string,
zip?: string,
vat_number?: string,
skip_approval?: boolean,
disable_ct?: boolean,
organization_contact?: JsonValue,
first_name?: string,
last_name?: string,
email?: string,
job_title?: string,
telephone?: string,
telephone_extension?: string,
technical_contact?: JsonValue,
organization?: JsonValue,
id?: number,
contacts?: JsonValue[],
skip_duplicate_org_check?: boolean,
container?: JsonValue,
custom_fields?: JsonValue[],
metadata_id?: number,
value?: string,
alternative_order_id?: string,
enable_guest_access?: number
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
organization | JsonValue | No | — |
domains | JsonValue[] | No | — |
name | number | No | — |
requests | JsonValue[] | No | — |
status | string | No | — |
certificate_id | number | No | — |
certificate_chain | JsonValue[] | No | — |
subject_common_name | string | No | — |
pem | string | No | — |
orderReport
certcentralApi.orderReport
Order report
Risk: read
await corsair.digicert.api.certcentralApi.orderReport({
query: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | Record<string, JsonValue> | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
orderSecureEmailCertificate
certcentralApi.orderSecureEmailCertificate
Order secure email certificate
Risk: destructive
await corsair.digicert.api.certcentralApi.orderSecureEmailCertificate({
body: {
certificate: 'example',
emails: ['example'],
usage_designation: 'example',
signature_hash: 'example',
order_validity: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
csr?: string,
key_size?: number,
csr_key_type?: string,
is_rsassa_pss?: boolean,
emails?: JsonValue[],
user_principle_name?: JsonValue[],
common_name_indicator?: string,
individual?: JsonValue,
usage_designation?: JsonValue,
signature_hash?: string,
ca_cert_id?: string,
profile_type?: string,
auto_renew?: number,
renewal_of_order_id?: number,
skip_approval?: boolean,
organization?: JsonValue,
id?: number,
contacts?: JsonValue[],
skip_duplicate_org_check?: boolean,
container?: JsonValue,
order_validity?: JsonValue,
years?: number
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
requests | JsonValue[] | No | — |
status | string | No | — |
certificate_id | number | No | — |
orderSecureSiteEv
certcentralApi.orderSecureSiteEv
Order Secure Site EV
Risk: destructive
await corsair.digicert.api.certcentralApi.orderSecureSiteEv({
body: {
certificate: 'example',
common_name: 'example',
csr: 'example',
signature_hash: 'example',
order_validity: 'example',
years: 1,
number: 'example',
expiration_month: 1,
expiration_year: 1,
cvv: 1,
cardholder_name: 'example',
address: 'example',
city: 'example',
country: 'example',
first_name: 'example',
last_name: 'example',
email: 'jane.doe@example.com',
organization: 'example',
metadata_id: 1,
value: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
common_name?: string,
dns_names?: JsonValue[],
csr?: string,
signature_hash?: string,
organization_units?: JsonValue[],
server_platform?: JsonValue,
cert_validity?: JsonValue,
profile_option?: string,
ca_cert_id?: string,
renewed_thumbprint?: string,
order_validity?: JsonValue,
years?: number,
days?: number,
custom_expiration_date?: string,
comments?: string,
apply_cr_discount?: boolean,
serial_number?: string,
auto_renew?: number,
auto_reissue?: number,
custom_renewal_message?: string,
disable_renewal_notifications?: boolean,
additional_emails?: JsonValue[],
locale?: string,
server_licenses?: number,
renewal_of_order_id?: number,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: number,
expiration_year?: number,
cvv?: number,
cardholder_name?: string,
billing_address?: JsonValue,
address?: string,
address2?: string,
city?: string,
state?: string,
country?: string,
zip?: string,
vat_number?: string,
dcv_method?: string,
skip_approval?: boolean,
disable_ct?: boolean,
organization_contact?: JsonValue,
first_name?: string,
last_name?: string,
email?: string,
job_title?: string,
telephone?: string,
telephone_extension?: string,
technical_contact?: JsonValue,
organization?: JsonValue,
id?: number,
skip_duplicate_org_check?: boolean,
contacts?: JsonValue[],
container?: JsonValue,
custom_fields?: JsonValue[],
metadata_id?: number,
value?: string,
alternative_order_id?: string,
enable_guest_access?: number,
certificate_dcv_scope?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
dcv_random_value | string | No | — |
organization | JsonValue | No | — |
domains | JsonValue[] | No | — |
name | number | No | — |
dns_name | string | No | — |
dcv_token | JsonValue | No | — |
requests | JsonValue[] | No | — |
status | string | No | — |
certificate_id | number | No | — |
certificate_chain | JsonValue[] | No | — |
subject_common_name | string | No | — |
pem | string | No | — |
orderSecureSiteOv
certcentralApi.orderSecureSiteOv
Order Secure Site OV
Risk: destructive
await corsair.digicert.api.certcentralApi.orderSecureSiteOv({
body: {
certificate: 'example',
common_name: 'example',
csr: 'example',
signature_hash: 'example',
order_validity: 'example',
years: 1,
number: 'example',
expiration_month: 1,
expiration_year: 1,
cvv: 1,
cardholder_name: 'example',
address: 'example',
city: 'example',
country: 'example',
first_name: 'example',
last_name: 'example',
email: 'jane.doe@example.com',
organization: 'example',
id: 1,
metadata_id: 1,
value: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
common_name?: string,
dns_names?: JsonValue[],
csr?: string,
signature_hash?: string,
organization_units?: JsonValue[],
server_platform?: JsonValue,
cert_validity?: JsonValue,
profile_option?: string,
ca_cert_id?: string,
renewed_thumbprint?: string,
order_validity?: JsonValue,
years?: number,
days?: number,
custom_expiration_date?: string,
comments?: string,
apply_cr_discount?: boolean,
serial_number?: string,
auto_renew?: number,
auto_reissue?: number,
custom_renewal_message?: string,
disable_renewal_notifications?: boolean,
additional_emails?: JsonValue[],
locale?: string,
server_licenses?: number,
renewal_of_order_id?: number,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: number,
expiration_year?: number,
cvv?: number,
cardholder_name?: string,
billing_address?: JsonValue,
address?: string,
address2?: string,
city?: string,
state?: string,
country?: string,
zip?: string,
vat_number?: string,
dcv_method?: string,
skip_approval?: boolean,
disable_ct?: boolean,
organization_contact?: JsonValue,
first_name?: string,
last_name?: string,
email?: string,
job_title?: string,
telephone?: string,
telephone_extension?: string,
technical_contact?: JsonValue,
organization?: JsonValue,
id?: number,
skip_duplicate_org_check?: boolean,
contacts?: JsonValue[],
container?: JsonValue,
custom_fields?: JsonValue[],
metadata_id?: number,
value?: string,
alternative_order_id?: string,
enable_guest_access?: number,
certificate_dcv_scope?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
dcv_random_value | string | No | — |
organization | JsonValue | No | — |
domains | JsonValue[] | No | — |
name | number | No | — |
dns_name | string | No | — |
dcv_token | JsonValue | No | — |
requests | JsonValue[] | No | — |
status | string | No | — |
certificate_id | number | No | — |
certificate_chain | JsonValue[] | No | — |
subject_common_name | string | No | — |
pem | string | No | — |
orderSecureSiteProEvSsl
certcentralApi.orderSecureSiteProEvSsl
Order Secure Site Pro EV SSL
Risk: destructive
await corsair.digicert.api.certcentralApi.orderSecureSiteProEvSsl({
body: {
certificate: 'example',
common_name: 'example',
csr: 'example',
signature_hash: 'example',
order_validity: 'example',
years: 1,
number: 'example',
expiration_month: 1,
expiration_year: 1,
cvv: 1,
cardholder_name: 'example',
address: 'example',
city: 'example',
country: 'example',
first_name: 'example',
last_name: 'example',
email: 'jane.doe@example.com',
organization: 'example',
id: 1,
metadata_id: 1,
value: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
common_name?: string,
dns_names?: JsonValue[],
csr?: string,
signature_hash?: string,
organization_units?: JsonValue[],
server_platform?: JsonValue,
cert_validity?: JsonValue,
profile_option?: string,
ca_cert_id?: string,
renewed_thumbprint?: string,
order_validity?: JsonValue,
years?: number,
days?: number,
custom_expiration_date?: string,
comments?: string,
apply_cr_discount?: boolean,
serial_number?: string,
auto_renew?: number,
auto_reissue?: number,
custom_renewal_message?: string,
disable_renewal_notifications?: boolean,
additional_emails?: JsonValue[],
locale?: string,
server_licenses?: number,
renewal_of_order_id?: number,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: number,
expiration_year?: number,
cvv?: number,
cardholder_name?: string,
billing_address?: JsonValue,
address?: string,
address2?: string,
city?: string,
state?: string,
country?: string,
zip?: string,
vat_number?: string,
dcv_method?: string,
skip_approval?: boolean,
disable_ct?: boolean,
organization_contact?: JsonValue,
first_name?: string,
last_name?: string,
email?: string,
job_title?: string,
telephone?: string,
telephone_extension?: string,
technical_contact?: JsonValue,
organization?: JsonValue,
id?: number,
skip_duplicate_org_check?: boolean,
contacts?: JsonValue[],
container?: JsonValue,
custom_fields?: JsonValue[],
metadata_id?: number,
value?: string,
alternative_order_id?: string,
enable_guest_access?: number,
certificate_dcv_scope?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
dcv_random_value | string | No | — |
organization | JsonValue | No | — |
domains | JsonValue[] | No | — |
name | number | No | — |
dns_name | string | No | — |
dcv_token | JsonValue | No | — |
requests | JsonValue[] | No | — |
status | string | No | — |
certificate_id | number | No | — |
certificate_chain | JsonValue[] | No | — |
subject_common_name | string | No | — |
pem | string | No | — |
orderSecureSiteProSsl
certcentralApi.orderSecureSiteProSsl
Order Secure Site Pro SSL
Risk: destructive
await corsair.digicert.api.certcentralApi.orderSecureSiteProSsl({
body: {
certificate: 'example',
common_name: 'example',
csr: 'example',
signature_hash: 'example',
order_validity: 'example',
years: 1,
number: 'example',
expiration_month: 1,
expiration_year: 1,
cvv: 1,
cardholder_name: 'example',
address: 'example',
city: 'example',
country: 'example',
first_name: 'example',
last_name: 'example',
email: 'jane.doe@example.com',
organization: 'example',
id: 1,
metadata_id: 1,
value: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
common_name?: string,
dns_names?: JsonValue[],
csr?: string,
signature_hash?: string,
organization_units?: JsonValue[],
server_platform?: JsonValue,
cert_validity?: JsonValue,
profile_option?: string,
ca_cert_id?: string,
renewed_thumbprint?: string,
order_validity?: JsonValue,
years?: number,
days?: number,
custom_expiration_date?: string,
comments?: string,
apply_cr_discount?: boolean,
serial_number?: string,
auto_renew?: number,
auto_reissue?: number,
custom_renewal_message?: string,
disable_renewal_notifications?: boolean,
additional_emails?: JsonValue[],
locale?: string,
server_licenses?: number,
renewal_of_order_id?: number,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: number,
expiration_year?: number,
cvv?: number,
cardholder_name?: string,
billing_address?: JsonValue,
address?: string,
address2?: string,
city?: string,
state?: string,
country?: string,
zip?: string,
vat_number?: string,
dcv_method?: string,
skip_approval?: boolean,
disable_ct?: boolean,
organization_contact?: JsonValue,
first_name?: string,
last_name?: string,
email?: string,
job_title?: string,
telephone?: string,
telephone_extension?: string,
technical_contact?: JsonValue,
organization?: JsonValue,
id?: number,
skip_duplicate_org_check?: boolean,
contacts?: JsonValue[],
container?: JsonValue,
custom_fields?: JsonValue[],
metadata_id?: number,
value?: string,
alternative_order_id?: string,
enable_guest_access?: number,
certificate_dcv_scope?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
dcv_random_value | string | No | — |
organization | JsonValue | No | — |
domains | JsonValue[] | No | — |
name | number | No | — |
dns_name | string | No | — |
dcv_token | JsonValue | No | — |
requests | JsonValue[] | No | — |
status | string | No | — |
certificate_id | number | No | — |
certificate_chain | JsonValue[] | No | — |
subject_common_name | string | No | — |
pem | string | No | — |
orderSecureSiteSslOrderSecureSiteSsl
certcentralApi.orderSecureSiteSslOrderSecureSiteSsl
Order Secure Site SSL — Order Secure Site SSL
Risk: destructive
await corsair.digicert.api.certcentralApi.orderSecureSiteSslOrderSecureSiteSsl({
path: { ssl_certificate_id: 'example' },
body: {
certificate: 'example',
common_name: 'example',
csr: 'example',
signature_hash: 'example',
order_validity: 'example',
years: 1,
number: 'example',
expiration_month: 1,
expiration_year: 1,
cvv: 1,
cardholder_name: 'example',
address: 'example',
city: 'example',
country: 'example',
first_name: 'example',
last_name: 'example',
email: 'jane.doe@example.com',
organization: 'example',
id: 1,
metadata_id: 1,
value: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
ssl_certificate_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
common_name?: string,
dns_names?: JsonValue[],
csr?: string,
signature_hash?: string,
organization_units?: JsonValue[],
server_platform?: JsonValue,
cert_validity?: JsonValue,
profile_option?: string,
renewed_thumbprint?: string,
order_validity?: JsonValue,
years?: number,
days?: number,
custom_expiration_date?: string,
comments?: string,
apply_cr_discount?: boolean,
serial_number?: string,
auto_renew?: number,
auto_reissue?: number,
custom_renewal_message?: string,
disable_renewal_notifications?: boolean,
additional_emails?: JsonValue[],
locale?: string,
renewal_of_order_id?: number,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: number,
expiration_year?: number,
cvv?: number,
cardholder_name?: string,
billing_address?: JsonValue,
address?: string,
address2?: string,
city?: string,
state?: string,
country?: string,
zip?: string,
vat_number?: string,
dcv_method?: string,
skip_approval?: boolean,
disable_ct?: boolean,
organization_contact?: JsonValue,
first_name?: string,
last_name?: string,
email?: string,
job_title?: string,
telephone?: string,
telephone_extension?: string,
technical_contact?: JsonValue,
organization?: JsonValue,
id?: number,
contacts?: JsonValue[],
skip_duplicate_org_check?: boolean,
container?: JsonValue,
custom_fields?: JsonValue[],
metadata_id?: number,
value?: string,
alternative_order_id?: string,
enable_guest_access?: number,
certificate_dcv_scope?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
dcv_random_value | string | No | — |
organization | JsonValue | No | — |
domains | JsonValue[] | No | — |
name | number | No | — |
dns_name | string | No | — |
dcv_token | JsonValue | No | — |
requests | JsonValue[] | No | — |
status | string | No | — |
certificate_id | number | No | — |
certificate_chain | JsonValue[] | No | — |
subject_common_name | string | No | — |
pem | string | No | — |
orderSslTypeHint
certcentralApi.orderSslTypeHint
Order SSL (type_hint)
Risk: destructive
await corsair.digicert.api.certcentralApi.orderSslTypeHint({
body: {
certificate: 'example',
common_name: 'example',
csr: 'example',
signature_hash: 'example',
order_validity: 'example',
years: 1,
first_name: 'example',
last_name: 'example',
email: 'jane.doe@example.com',
organization: 'example',
id: 1,
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
common_name?: string,
dns_names?: JsonValue[],
csr?: string,
signature_hash?: string,
profile_option?: string,
ca_cert_id?: string,
organization_units?: JsonValue[],
server_platform?: JsonValue,
cert_validity?: JsonValue,
renewed_thumbprint?: string,
order_validity?: JsonValue,
years?: number,
days?: number,
custom_expiration_date?: string,
comments?: string,
apply_cr_discount?: boolean,
serial_number?: string,
product?: JsonValue,
type_hint?: string,
auto_renew?: number,
auto_reissue?: number,
disable_renewal_notifications?: boolean,
additional_emails?: JsonValue[],
renewal_of_order_id?: number,
dcv_method?: string,
skip_approval?: boolean,
disable_ct?: boolean,
organization_contact?: JsonValue,
first_name?: string,
last_name?: string,
email?: string,
job_title?: string,
telephone?: string,
telephone_extension?: string,
technical_contact?: JsonValue,
organization?: JsonValue,
id?: number,
contacts?: JsonValue[],
skip_duplicate_org_check?: boolean,
container?: JsonValue,
alternative_order_id?: string,
enable_guest_access?: number,
certificate_dcv_scope?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
dcv_random_value | string | No | — |
organization | JsonValue | No | — |
domains | JsonValue[] | No | — |
name | number | No | — |
dns_name | string | No | — |
dcv_token | JsonValue | No | — |
requests | JsonValue[] | No | — |
status | string | No | — |
certificate_id | number | No | — |
certificate_chain | JsonValue[] | No | — |
subject_common_name | string | No | — |
pem | string | No | — |
orderSwissClientAuthenticationCertificate
certcentralApi.orderSwissClientAuthenticationCertificate
Order Swiss Client Authentication Certificate
Risk: destructive
await corsair.digicert.api.certcentralApi.orderSwissClientAuthenticationCertificate({
body: {
certificate: 'example',
emails: ['example'],
signature_hash: 'example',
id: 1,
csa_agreed_to: true,
order_validity: 'example',
years: 1,
payment_method: 'example',
credit_card: 'example',
number: 'example',
expiration_month: 'example',
expiration_year: 'example',
cvv: 'example',
cardholder_name: 'example',
set_as_default: 'example',
address: 'example',
city: 'example',
country: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
emails?: JsonValue[],
signature_hash?: string,
dns_names?: JsonValue[],
csr?: string,
ca_cert_id?: string,
auto_renew?: number,
renewal_of_order_id?: number,
id?: number,
user_id_assignments?: JsonValue[],
csa_agreed_to?: boolean,
order_validity?: JsonValue,
years?: number,
days?: number,
custom_expiration_date?: string,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: string,
expiration_year?: string,
cvv?: string,
cardholder_name?: string,
save_credit_card?: string,
set_as_default?: string,
billing_address?: JsonValue,
address?: string,
address2?: string,
city?: string,
state?: string,
country?: string,
zip?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
requests | JsonValue[] | No | — |
status | string | No | — |
certificate_id | number | No | — |
organization | JsonValue | No | — |
orderSwissQualifiedCertificateForIndividual
certcentralApi.orderSwissQualifiedCertificateForIndividual
Order Swiss Qualified Certificate for Individual
Risk: destructive
await corsair.digicert.api.certcentralApi.orderSwissQualifiedCertificateForIndividual({
body: {
certificate: 'example',
signature_hash: 'example',
individual: 'example',
csa_agreed_to: true,
provisioning_method: 'example',
name: 'example',
addr1: 'example',
addr2: 'example',
city: 'example',
state: 'example',
zip: 'example',
country: 'example',
method: 'example',
requester: 'example',
first_name: 'example',
last_name: 'example',
email: 'jane.doe@example.com',
telephone: 'example',
job_title: 'example',
payment_method: 'example',
credit_card: 'example',
number: 'example',
expiration_month: 'example',
expiration_year: 'example',
cvv: 'example',
cardholder_name: 'example',
set_as_default: 'example',
address: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
signature_hash?: string,
profile_option?: string,
is_rsassa_pss?: boolean,
individual?: JsonValue,
csa_agreed_to?: boolean,
provisioning_method?: string,
ship_info?: JsonValue,
name?: string,
addr1?: string,
addr2?: string,
city?: string,
state?: string,
zip?: string,
country?: string,
method?: string,
requester?: JsonValue,
first_name?: string,
last_name?: string,
email?: string,
telephone?: string,
job_title?: string,
cert_validity?: JsonValue,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: string,
expiration_year?: string,
cvv?: string,
cardholder_name?: string,
save_credit_card?: string,
set_as_default?: string,
billing_address?: JsonValue,
address?: string,
address2?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
certificate_id | number | No | — |
orderSwissQualifiedCertificateForIndividualInOrganisation
certcentralApi.orderSwissQualifiedCertificateForIndividualInOrganisation
Order Swiss Qualified Certificate for Individual in Organisation
Risk: destructive
await corsair.digicert.api.certcentralApi.orderSwissQualifiedCertificateForIndividualInOrganisation({
body: {
certificate: 'example',
signature_hash: 'example',
individual: 'example',
csa_agreed_to: true,
provisioning_method: 'example',
name: 'example',
addr1: 'example',
addr2: 'example',
city: 'example',
state: 'example',
zip: 'example',
country: 'example',
method: 'example',
requester: 'example',
first_name: 'example',
last_name: 'example',
email: 'jane.doe@example.com',
telephone: 'example',
job_title: 'example',
organization: 'example',
id: 1,
contacts: ['example'],
payment_method: 'example',
credit_card: 'example',
number: 'example',
expiration_month: 'example',
expiration_year: 'example',
cvv: 'example',
cardholder_name: 'example',
set_as_default: 'example',
address: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
signature_hash?: string,
profile_option?: string,
is_rsassa_pss?: boolean,
individual?: JsonValue,
csa_agreed_to?: boolean,
provisioning_method?: string,
ship_info?: JsonValue,
name?: string,
addr1?: string,
addr2?: string,
city?: string,
state?: string,
zip?: string,
country?: string,
method?: string,
requester?: JsonValue,
first_name?: string,
last_name?: string,
email?: string,
telephone?: string,
job_title?: string,
organization?: JsonValue,
id?: number,
contacts?: JsonValue[],
cert_validity?: JsonValue,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: string,
expiration_year?: string,
cvv?: string,
cardholder_name?: string,
save_credit_card?: string,
set_as_default?: string,
billing_address?: JsonValue,
address?: string,
address2?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
certificate_id | number | No | — |
organization | JsonValue | No | — |
orderSwissRegulatedCertificateForIndividual
certcentralApi.orderSwissRegulatedCertificateForIndividual
Order Swiss Regulated Certificate for Individual
Risk: destructive
await corsair.digicert.api.certcentralApi.orderSwissRegulatedCertificateForIndividual({
body: {
certificate: 'example',
signature_hash: 'example',
individual: 'example',
csa_agreed_to: true,
provisioning_method: 'example',
name: 'example',
addr1: 'example',
addr2: 'example',
city: 'example',
state: 'example',
zip: 'example',
country: 'example',
method: 'example',
requester: 'example',
first_name: 'example',
last_name: 'example',
email: 'jane.doe@example.com',
telephone: 'example',
job_title: 'example',
payment_method: 'example',
credit_card: 'example',
number: 'example',
expiration_month: 'example',
expiration_year: 'example',
cvv: 'example',
cardholder_name: 'example',
set_as_default: 'example',
address: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
signature_hash?: string,
profile_option?: string,
is_rsassa_pss?: boolean,
individual?: JsonValue,
csa_agreed_to?: boolean,
provisioning_method?: string,
ship_info?: JsonValue,
name?: string,
addr1?: string,
addr2?: string,
city?: string,
state?: string,
zip?: string,
country?: string,
method?: string,
requester?: JsonValue,
first_name?: string,
last_name?: string,
email?: string,
telephone?: string,
job_title?: string,
cert_validity?: JsonValue,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: string,
expiration_year?: string,
cvv?: string,
cardholder_name?: string,
save_credit_card?: string,
set_as_default?: string,
billing_address?: JsonValue,
address?: string,
address2?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
certificate_id | number | No | — |
organization | JsonValue | No | — |
orderSwissRegulatedCertificateForIndividualInOrganisation
certcentralApi.orderSwissRegulatedCertificateForIndividualInOrganisation
Order Swiss Regulated Certificate for Individual in Organisation
Risk: destructive
await corsair.digicert.api.certcentralApi.orderSwissRegulatedCertificateForIndividualInOrganisation({
body: {
certificate: 'example',
signature_hash: 'example',
individual: 'example',
id: 1,
csa_agreed_to: true,
provisioning_method: 'example',
name: 'example',
addr1: 'example',
addr2: 'example',
city: 'example',
state: 'example',
zip: 'example',
country: 'example',
method: 'example',
requester: 'example',
first_name: 'example',
last_name: 'example',
email: 'jane.doe@example.com',
telephone: 'example',
job_title: 'example',
organization: 'example',
contacts: ['example'],
payment_method: 'example',
credit_card: 'example',
number: 'example',
expiration_month: 'example',
expiration_year: 'example',
cvv: 'example',
cardholder_name: 'example',
set_as_default: 'example',
address: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
signature_hash?: string,
profile_option?: string,
is_rsassa_pss?: boolean,
individual?: JsonValue,
container?: JsonValue,
id?: number,
csa_agreed_to?: boolean,
provisioning_method?: string,
ship_info?: JsonValue,
name?: string,
addr1?: string,
addr2?: string,
city?: string,
state?: string,
zip?: string,
country?: string,
method?: string,
requester?: JsonValue,
first_name?: string,
last_name?: string,
email?: string,
telephone?: string,
job_title?: string,
organization?: JsonValue,
contacts?: JsonValue[],
cert_validity?: JsonValue,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: string,
expiration_year?: string,
cvv?: string,
cardholder_name?: string,
save_credit_card?: string,
set_as_default?: string,
billing_address?: JsonValue,
address?: string,
address2?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
certificate_id | number | No | — |
organization | JsonValue | No | — |
orderSwissRegulatedCertificateForOrganisation
certcentralApi.orderSwissRegulatedCertificateForOrganisation
Order Swiss Regulated Certificate for Organisation
Risk: destructive
await corsair.digicert.api.certcentralApi.orderSwissRegulatedCertificateForOrganisation({
body: {
certificate: 'example',
signature_hash: 'example',
id: 1,
csa_agreed_to: true,
provisioning_method: 'example',
name: 'example',
addr1: 'example',
addr2: 'example',
city: 'example',
state: 'example',
zip: 'example',
country: 'example',
method: 'example',
requester: 'example',
first_name: 'example',
last_name: 'example',
email: 'jane.doe@example.com',
telephone: 'example',
job_title: 'example',
organization: 'example',
contacts: ['example'],
payment_method: 'example',
credit_card: 'example',
number: 'example',
expiration_month: 'example',
expiration_year: 'example',
cvv: 'example',
cardholder_name: 'example',
set_as_default: 'example',
address: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
signature_hash?: string,
profile_option?: string,
is_rsassa_pss?: boolean,
container?: JsonValue,
id?: number,
csa_agreed_to?: boolean,
provisioning_method?: string,
ship_info?: JsonValue,
name?: string,
addr1?: string,
addr2?: string,
city?: string,
state?: string,
zip?: string,
country?: string,
method?: string,
requester?: JsonValue,
first_name?: string,
last_name?: string,
email?: string,
telephone?: string,
job_title?: string,
organization?: JsonValue,
contacts?: JsonValue[],
cert_validity?: JsonValue,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: string,
expiration_year?: string,
cvv?: string,
cardholder_name?: string,
save_credit_card?: string,
set_as_default?: string,
billing_address?: JsonValue,
address?: string,
address2?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
certificate_id | number | No | — |
organization | JsonValue | No | — |
orderValidationStatus
certcentralApi.orderValidationStatus
Order validation status
Risk: read
await corsair.digicert.api.certcentralApi.orderValidationStatus({
path: { order_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
include_risk_check?: boolean
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
order_id | string | No | — |
order_status | string | No | — |
order_name_scope | string | No | — |
order_dcv_method | string | No | — |
organization_id | string | No | — |
organization_name | string | No | — |
organization_validations | JsonValue[] | No | — |
type | string | No | — |
name | string | No | — |
description | string | No | — |
date_created | string | No | — |
validated_until | string | No | — |
status | string | No | — |
verified_contacts | JsonValue[] | No | — |
verification_details | JsonValue | No | — |
dns_name_validations | JsonValue[] | No | — |
domain_id | string | No | — |
risk_status | string | No | — |
method | string | No | — |
name_scope | string | No | — |
dns_names | JsonValue[] | No | — |
base_domain | string | No | — |
orderVerifiedMarkCertificateVmc
certcentralApi.orderVerifiedMarkCertificateVmc
Order Verified Mark Certificate (VMC)
Risk: destructive
await corsair.digicert.api.certcentralApi.orderVerifiedMarkCertificateVmc({
body: {
certificate: 'example',
order_validity: 'example',
years: 1,
number: 'example',
expiration_month: 1,
expiration_year: 1,
cvv: 1,
cardholder_name: 'example',
address: 'example',
city: 'example',
country: 'example',
first_name: 'example',
last_name: 'example',
email: 'jane.doe@example.com',
organization: 'example',
metadata_id: 1,
value: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
dns_names?: JsonValue[],
vmc?: JsonValue,
logo?: string,
enable_hosting?: boolean,
mark_type?: string,
mark_type_data?: JsonValue,
trademark_country_code?: string,
trademark_registration_number?: string,
renewed_thumbprint?: string,
order_validity?: JsonValue,
years?: number,
comments?: string,
auto_renew?: number,
custom_renewal_message?: string,
disable_renewal_notifications?: boolean,
additional_emails?: JsonValue[],
locale?: string,
renewal_of_order_id?: number,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: number,
expiration_year?: number,
cvv?: number,
cardholder_name?: string,
billing_address?: JsonValue,
address?: string,
address2?: string,
city?: string,
state?: string,
country?: string,
zip?: string,
vat_number?: string,
dcv_method?: string,
skip_approval?: boolean,
organization_contact?: JsonValue,
first_name?: string,
last_name?: string,
email?: string,
job_title?: string,
telephone?: string,
telephone_extension?: string,
technical_contact?: JsonValue,
organization?: JsonValue,
id?: number,
skip_duplicate_org_check?: boolean,
contacts?: JsonValue[],
container?: JsonValue,
custom_fields?: JsonValue[],
metadata_id?: number,
value?: string,
alternative_order_id?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
domains | JsonValue[] | No | — |
name | number | No | — |
dns_name | string | No | — |
dcv_token | JsonValue | No | — |
requests | JsonValue[] | No | — |
status | string | No | — |
certificate_id | number | No | — |
vmc | JsonValue | No | — |
logo_id | number | No | — |
orderX9PkiForTls
certcentralApi.orderX9PkiForTls
Order X9 PKI for TLS
Risk: destructive
await corsair.digicert.api.certcentralApi.orderX9PkiForTls({
body: {
certificate: 'example',
common_name: 'example',
csr: 'example',
signature_hash: 'example',
id: 1,
csa_agreed_to: true,
organization: 'example',
first_name: 'example',
last_name: 'example',
email: 'jane.doe@example.com',
order_validity: 'example',
years: 1,
number: 'example',
expiration_month: 1,
expiration_year: 1,
cvv: 1,
cardholder_name: 'example',
address: 'example',
city: 'example',
country: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
common_name?: string,
dns_names?: JsonValue[],
csr?: string,
signature_hash?: string,
server_platform?: JsonValue,
comments?: string,
container?: JsonValue,
id?: number,
auto_renew?: number,
custom_renewal_message?: string,
renewal_of_order_id?: number,
key_usages?: JsonValue[],
extended_key_usages?: JsonValue[],
ca_cert_id?: string,
renewed_thumbprint?: string,
csa_agreed_to?: boolean,
promo_code?: string,
dcv_method?: string,
certificate_dcv_scope?: string,
skip_approval?: boolean,
additional_emails?: JsonValue[],
locale?: string,
organization?: JsonValue,
contacts?: JsonValue[],
organization_contact?: JsonValue,
first_name?: string,
last_name?: string,
email?: string,
job_title?: string,
telephone?: string,
technical_contact?: JsonValue,
order_validity?: JsonValue,
years?: number,
days?: number,
custom_expiration_date?: string,
payment_method?: string,
credit_card?: JsonValue,
number?: string,
expiration_month?: number,
expiration_year?: number,
cvv?: number,
cardholder_name?: string,
billing_address?: JsonValue,
address?: string,
address2?: string,
city?: string,
state?: string,
country?: string,
zip?: string,
vat_number?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
dcv_random_value | string | No | — |
organization | JsonValue | No | — |
domains | JsonValue[] | No | — |
name | number | No | — |
dns_name | string | No | — |
dcv_token | JsonValue | No | — |
requests | JsonValue[] | No | — |
status | string | No | — |
certificate_id | number | No | — |
certificate_chain | JsonValue[] | No | — |
subject_common_name | string | No | — |
pem | string | No | — |
organizationAndTechnicalContactInfo
certcentralApi.organizationAndTechnicalContactInfo
Organization and technical contact info
Risk: read
await corsair.digicert.api.certcentralApi.organizationAndTechnicalContactInfo({
path: { organization_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
organization_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
organization_contact | JsonValue | No | — |
first_name | string | No | — |
last_name | string | No | — |
email | string | No | — |
job_title | string | No | — |
telephone | string | No | — |
telephone_extension | string | No | — |
language_id | string | No | — |
name | string | No | — |
contact_type | string | No | — |
technical_contact | JsonValue | No | — |
organizationInfo
certcentralApi.organizationInfo
Organization info
Risk: read
await corsair.digicert.api.certcentralApi.organizationInfo({
path: { organization_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
organization_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
status | string | No | — |
name | string | No | — |
assumed_name | string | No | — |
display_name | string | No | — |
is_active | boolean | No | — |
address | string | No | — |
address2 | string | No | — |
zip | string | No | — |
city | string | No | — |
state | string | No | — |
country | string | No | — |
telephone | string | No | — |
container | JsonValue | No | — |
parent_id | string | No | — |
organization_contact | JsonValue | No | — |
first_name | string | No | — |
last_name | string | No | — |
email | string | No | — |
job_title | string | No | — |
telephone_extension | string | No | — |
verified_contacts | JsonValue[] | No | — |
verified_roles | JsonValue[] | No | — |
ev_approvers | JsonValue[] | No | — |
extended_validation | JsonValue | No | — |
container_id_assignments | JsonValue[] | No | — |
ovEvSslCheckDcv
certcentralApi.ovEvSslCheckDcv
OV/EV SSL: Check DCV
Risk: write
await corsair.digicert.api.certcentralApi.ovEvSslCheckDcv({
path: { domain_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | JsonValue | No | — |
path full type
path full type
{
domain_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
status | string | No | — |
ovEvSslGenerateDcvToken
certcentralApi.ovEvSslGenerateDcvToken
OV/EV SSL: Generate DCV token
Risk: write
await corsair.digicert.api.certcentralApi.ovEvSslGenerateDcvToken({
path: { domain_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
domain_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
validations?: JsonValue[],
type?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
token | string | No | — |
expiration_date | string | No | — |
http_token_url | string | No | — |
verification_value | string | No | — |
parentContainerInfo
certcentralApi.parentContainerInfo
Parent container info
Risk: read
await corsair.digicert.api.certcentralApi.parentContainerInfo({
path: { container_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
container_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
public_id | string | No | — |
name | string | No | — |
description | string | No | — |
parent_id | number | No | — |
template_id | number | No | — |
has_logo | boolean | No | — |
is_active | boolean | No | — |
allowed_domain_names | JsonValue[] | No | — |
priceEstimate
certcentralApi.priceEstimate
Price estimate
Risk: write
await corsair.digicert.api.certcentralApi.priceEstimate({
body: {
certificate: 'example',
dns_names: ['example'],
order_validity: 'example',
years: 1,
days: 1,
validity_years: 1,
product_name_id: 'example',
country: 'example',
city: 'example',
state: 'example',
zip: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
dns_names?: JsonValue[],
order_validity?: JsonValue,
years?: number,
days?: number,
custom_expiration_date?: string,
validity_years?: number,
is_out_of_contract?: number,
product_name_id?: string,
billing_address?: JsonValue,
country?: string,
city?: string,
state?: string,
zip?: string,
renewal_of_order_valid_till?: string,
addons?: JsonValue[]
}
| Name | Type | Required | Description |
|---|---|---|---|
base_price | number | No | — |
total_price | number | No | — |
addons_price | number | No | — |
addons_price_details | JsonValue[] | No | — |
subtotal | number | No | — |
product_id | number | No | — |
units | number | No | — |
price | string | No | — |
fqdns | JsonValue | No | — |
wildcards | JsonValue | No | — |
balance | number | No | — |
currency | string | No | — |
tax | number | No | — |
tax_error | boolean | No | — |
pricingList
certcentralApi.pricingList
Pricing list
Risk: read
await corsair.digicert.api.certcentralApi.pricingList({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
standard_prices | JsonValue[] | No | — |
group_name | string | No | — |
name_id | string | No | — |
name | string | No | — |
prices | JsonValue[] | No | — |
productInfo
certcentralApi.productInfo
Product info
Risk: read
await corsair.digicert.api.certcentralApi.productInfo({
path: { name_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
name_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
group_name | string | No | — |
name_id | string | No | — |
name | string | No | — |
type | string | No | — |
validation_type | string | No | — |
duplicates_allowed | boolean | No | — |
allowed_validity_years | JsonValue[] | No | — |
allowed_order_validity_years | JsonValue[] | No | — |
max_multi_year_order_validity_years | number | No | — |
signature_hash_types | JsonValue | No | — |
allowed_hash_types | JsonValue[] | No | — |
default_hash_type_id | string | No | — |
allowed_ca_certs | JsonValue[] | No | — |
id | string | No | — |
chain_info | string | No | — |
default_intermediate | string | No | — |
additional_dns_names_allowed | boolean | No | — |
increased_compatibility_allowed | boolean | No | — |
custom_expiration_date_allowed | boolean | No | — |
custom_order_expiration_date_allowed | boolean | No | — |
csr_required | boolean | No | — |
allow_auto_renew | boolean | No | — |
allow_auto_reissue | boolean | No | — |
server_platforms | JsonValue[] | No | — |
install_url | string | No | — |
csr_url | string | No | — |
best_format | string | No | — |
license_agreement | string | No | — |
productLimits
certcentralApi.productLimits
Product limits
Risk: read
await corsair.digicert.api.certcentralApi.productLimits({
path: { container-id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
container-id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
is_limited | boolean | No | — |
limited_container_ids | JsonValue[] | No | — |
product_limits | JsonValue[] | No | — |
container_id | number | No | — |
role_id | number | No | — |
product_name_id | string | No | — |
allowed_hashes | JsonValue[] | No | — |
allowed_intermediates | JsonValue[] | No | — |
allowed_lifetimes | JsonValue[] | No | — |
allowed_order_lifetimes | JsonValue[] | No | — |
allow_auto_renew | boolean | No | — |
allow_auto_reissue | boolean | No | — |
default_intermediate | string | No | — |
allowed_wildcards | boolean | No | — |
ct_log_option | string | No | — |
productList
certcentralApi.productList
Product list
Risk: read
await corsair.digicert.api.certcentralApi.productList({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
products | JsonValue[] | No | — |
group_name | string | No | — |
name_id | string | No | — |
name | string | No | — |
type | string | No | — |
allowed_container_ids | JsonValue[] | No | — |
allowed_validity_years | JsonValue[] | No | — |
allowed_order_validity_years | JsonValue[] | No | — |
signature_hash_types | JsonValue | No | — |
allowed_ca_certs | JsonValue[] | No | — |
csr_required | boolean | No | — |
purchaseKeyLockerSignatures
certcentralApi.purchaseKeyLockerSignatures
Purchase KeyLocker signatures
Risk: destructive
await corsair.digicert.api.certcentralApi.purchaseKeyLockerSignatures({
path: { order_id: 'example' },
body: { signature_units: 1, payment_method: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
signature_units: number,
payment_method: string
}
JsonValue
receiptInfo
certcentralApi.receiptInfo
Receipt info
Risk: read
await corsair.digicert.api.certcentralApi.receiptInfo({
path: { receipt_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
receipt_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | string | No | — |
date_time | string | No | — |
acct_amount | string | No | — |
gross_amount | string | No | — |
tax_amount | string | No | — |
currency | string | No | — |
cc_amount | string | No | — |
cc_last4 | string | No | — |
cc_exp_date | string | No | — |
cc_type | string | No | — |
bill_name | string | No | — |
bill_addr1 | string | No | — |
bill_city | string | No | — |
bill_state | string | No | — |
bill_zip | string | No | — |
bill_country | string | No | — |
bill_email | string | No | — |
billing_entity_id | number | No | — |
vat_number | string | No | — |
payment_method | string | No | — |
transaction_type | string | No | — |
recentOrganizations
certcentralApi.recentOrganizations
Recent organizations
Risk: read
await corsair.digicert.api.certcentralApi.recentOrganizations({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
organization_ids | JsonValue[] | No | — |
reissueCertificate
certcentralApi.reissueCertificate
Reissue certificate
Risk: destructive
await corsair.digicert.api.certcentralApi.reissueCertificate({
path: { order_id: 'example' },
body: {
certificate: 'example',
signature_hash: 'example',
name: 'example',
addr1: 'example',
city: 'example',
state: 'example',
zip: 'example',
country: 'example',
method: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate?: JsonValue,
csr?: string,
common_name?: string,
dns_names?: JsonValue[],
emails?: JsonValue[],
user_principle_name?: JsonValue[],
common_name_indicator?: string,
individual?: JsonValue,
usage_designation?: JsonValue,
is_rsassa_pss?: boolean,
server_platform?: JsonValue,
cert_validity?: JsonValue,
signature_hash?: string,
profile_option?: string,
ca_cert_id?: string,
dcv_method?: string,
comments?: string,
skip_approval?: boolean,
certificate_dcv_scope?: string,
use_auth_key?: boolean,
cs_provisioning_method?: string,
ship_info?: JsonValue,
name?: string,
addr1?: string,
addr2?: string,
city?: string,
state?: string,
zip?: string,
country?: string,
method?: string,
subject?: JsonValue,
serial_number?: string,
pseudonym?: string,
job_title?: string,
include_pseudonym?: boolean,
include_email?: boolean,
include_given_name_surname?: boolean,
store_reissue_as_duplicate?: boolean
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
certificate_id | number | No | — |
dcv_random_value | string | No | — |
requests | JsonValue[] | No | — |
requestInfo
certcentralApi.requestInfo
Request info
Risk: read
await corsair.digicert.api.certcentralApi.requestInfo({
path: { request_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
request_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
date | string | No | — |
type | string | No | — |
status | string | No | — |
date_processed | string | No | — |
requester | JsonValue | No | — |
reviewer | JsonValue | No | — |
processor | JsonValue | No | — |
order | JsonValue | No | — |
unsubmitted_domains | JsonValue[] | No | — |
renewal_of_order_valid_till | string | No | — |
comments | string | No | — |
requestSummary
certcentralApi.requestSummary
Request summary
Risk: read
await corsair.digicert.api.certcentralApi.requestSummary({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
request | JsonValue | No | — |
total | number | No | — |
types | JsonValue[] | No | — |
rescanDomain
certcentralApi.rescanDomain
Rescan domain
Risk: write
await corsair.digicert.api.certcentralApi.rescanDomain({
path: { order_id: 'example', domain: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | JsonValue | No | — |
path full type
path full type
{
order_id: string,
domain: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
resendCreateUserEmail
certcentralApi.resendCreateUserEmail
Resend create user email
Risk: destructive
await corsair.digicert.api.certcentralApi.resendCreateUserEmail({
path: { user_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
user_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
resendDcvEmail
certcentralApi.resendDcvEmail
Resend DCV email
Risk: destructive
await corsair.digicert.api.certcentralApi.resendDcvEmail({
path: { domain_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
domain_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
name_scope?: string,
locale?: string,
email_array?: JsonValue[]
}
JsonValue
resendInvite
certcentralApi.resendInvite
Resend invite
Risk: destructive
await corsair.digicert.api.certcentralApi.resendInvite({
path: { invite_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
invite_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
invite_note?: string
}
JsonValue
resendOrderApprovalEmail
certcentralApi.resendOrderApprovalEmail
Resend order approval email
Risk: destructive
await corsair.digicert.api.certcentralApi.resendOrderApprovalEmail({
path: { order_id: 'example' },
body: {
emails: ['example'],
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
emails: JsonValue[]
}
JsonValue
resendVerifiedContactDelegationEmail
certcentralApi.resendVerifiedContactDelegationEmail
Resend verified contact delegation email
Risk: destructive
await corsair.digicert.api.certcentralApi.resendVerifiedContactDelegationEmail({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | JsonValue | No | — |
path full type
path full type
{
delegation_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
restoreCertificate
certcentralApi.restoreCertificate
Restore certificate
Risk: write
await corsair.digicert.api.certcentralApi.restoreCertificate({
path: { certificate_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | JsonValue | No | — |
path full type
path full type
{
certificate_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
revokeCertificate
certcentralApi.revokeCertificate
Revoke certificate
Risk: destructive
await corsair.digicert.api.certcentralApi.revokeCertificate({
path: { certificate_identifier: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
certificate_identifier: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
revocation_reason?: string,
comment?: string,
skip_approval?: boolean
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
date | string | No | — |
type | string | No | — |
status | string | No | — |
requester | JsonValue | No | — |
first_name | string | No | — |
last_name | string | No | — |
email | string | No | — |
comments | string | No | — |
revokeOrderCertificates
certcentralApi.revokeOrderCertificates
Revoke order certificates
Risk: destructive
await corsair.digicert.api.certcentralApi.revokeOrderCertificates({
path: { order_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
revocation_reason?: string,
comment?: string,
skip_approval?: boolean
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
date | string | No | — |
type | string | No | — |
status | string | No | — |
requester | JsonValue | No | — |
first_name | string | No | — |
last_name | string | No | — |
email | string | No | — |
comments | string | No | — |
samlEntityDetails
certcentralApi.samlEntityDetails
SAML entity details
Risk: read
await corsair.digicert.api.certcentralApi.samlEntityDetails({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | string | No | — |
account_id | string | No | — |
xml_metadata | string | No | — |
source_url | string | No | — |
idp_entity_id | string | No | — |
attribute_mapping | string | No | — |
friendly_name | string | No | — |
friendly_slug | string | No | — |
date_created | string | No | — |
last_signon_date | string | No | — |
username_attribute | string | No | — |
type | string | No | — |
sendInvite
certcentralApi.sendInvite
Send invite
Risk: destructive
await corsair.digicert.api.certcentralApi.sendInvite({
body: {
emails: ['example'],
subaccount_type: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
emails: JsonValue[],
subaccount_type: string,
invite_note?: string
}
JsonValue
setSubaccountProducts
certcentralApi.setSubaccountProducts
Set subaccount products
Risk: write
await corsair.digicert.api.certcentralApi.setSubaccountProducts({
path: { subaccount_id: 'example' },
body: {
products: ['example'],
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
subaccount_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
currency?: string,
pricing_method?: string,
balance_negative_limit?: number,
products?: JsonValue[],
product_name_id?: string,
prices?: JsonValue[]
}
JsonValue
siteSealSettings
certcentralApi.siteSealSettings
Site seal settings
Risk: read
await corsair.digicert.api.certcentralApi.siteSealSettings({
path: { order_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
order_id | number | No | — |
product_name_id | string | No | — |
seal_hash | string | No | — |
seal_number | string | No | — |
seal_size | string | No | — |
seal_hover | boolean | No | — |
seal_autoplay | boolean | No | — |
seal_use_logo | boolean | No | — |
display_malware_scan | boolean | No | — |
display_ct_log | boolean | No | — |
display_pci_scan | boolean | No | — |
display_blocklist_check | boolean | No | — |
display_verified_customer | boolean | No | — |
eligible_ct_log | boolean | No | — |
eligible_blocklist_check | boolean | No | — |
eligible_pci_scan | boolean | No | — |
ct_log_enabled | boolean | No | — |
pci_scan_enabled | boolean | No | — |
seal_code | string | No | — |
seal_logo | string | No | — |
statusChangeList
certcentralApi.statusChangeList
Status change list
Risk: read
await corsair.digicert.api.certcentralApi.statusChangeList({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
minutes?: number,
seconds?: number,
filters[
status_last_updated
]?: string
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
orders | JsonValue[] | No | — |
order_id | number | No | — |
certificate_id | number | No | — |
status | string | No | — |
subaccountInfo
certcentralApi.subaccountInfo
Subaccount info
Risk: read
await corsair.digicert.api.certcentralApi.subaccountInfo({
path: { subaccount_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
subaccount_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
account_id | number | No | — |
account_type | string | No | — |
organization_name | string | No | — |
child_name | string | No | — |
date_created | string | No | — |
parent_account_id | string | No | — |
billing_account_name | string | No | — |
billing_account_id | number | No | — |
account_manager | string | No | — |
bill_parent | boolean | No | — |
enforce_bill_parent | boolean | No | — |
master_user | JsonValue | No | — |
first_name | string | No | — |
last_name | string | No | — |
email | string | No | — |
job_title | string | No | — |
telephone | string | No | — |
i18n_language_id | string | No | — |
container_id | string | No | — |
organization | JsonValue | No | — |
id | number | No | — |
status | string | No | — |
name | string | No | — |
address | string | No | — |
zip | string | No | — |
city | string | No | — |
state | string | No | — |
country | string | No | — |
is_active | boolean | No | — |
container | JsonValue | No | — |
billing_contact | JsonValue | No | — |
phone | string | No | — |
max_allowed_multi_year_plan_length | number | No | — |
allow_parent_order_renewal | boolean | No | — |
subaccountOrderInfo
certcentralApi.subaccountOrderInfo
Subaccount order info
Risk: read
await corsair.digicert.api.certcentralApi.subaccountOrderInfo({
path: { order_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
include_validation_status?: boolean,
include_cs_provisioning_method?: boolean
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
certificate | JsonValue | No | — |
thumbprint | string | No | — |
serial_number | string | No | — |
common_name | string | No | — |
dns_names | JsonValue[] | No | — |
valid_till | string | No | — |
organization_units | JsonValue[] | No | — |
signature_hash | string | No | — |
ca_cert | JsonValue | No | — |
organization | JsonValue | No | — |
name | string | No | — |
assumed_name | string | No | — |
display_name | string | No | — |
subaccount | JsonValue | No | — |
account_id | number | No | — |
account_type | string | No | — |
organization_name | string | No | — |
product | JsonValue | No | — |
name_id | string | No | — |
type | string | No | — |
order_price | JsonValue | No | — |
cost | number | No | — |
currency | string | No | — |
status | string | No | — |
number_of_sans | number | No | — |
date_created | string | No | — |
date_issued | string | No | — |
is_multi_year_plan | string | No | — |
order_valid_from | string | No | — |
order_valid_till | string | No | — |
validity_years | number | No | — |
order_prices | JsonValue[] | No | — |
subaccount_order_validations | JsonValue | No | — |
order_name_scope | string | No | — |
order_dcv_method | string | No | — |
organization_validations | JsonValue[] | No | — |
dns_name_validations | JsonValue[] | No | — |
cs_provisioning_method | string | No | — |
subaccountReport
certcentralApi.subaccountReport
Subaccount report
Risk: read
await corsair.digicert.api.certcentralApi.subaccountReport({
path: { subaccount_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
subaccount_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
subaccount_price | JsonValue | No | — |
cost | number | No | — |
currency | string | No | — |
order_price | JsonValue | No | — |
order_prices | JsonValue[] | No | — |
submitForValidation
certcentralApi.submitForValidation
Submit for validation
Risk: write
await corsair.digicert.api.certcentralApi.submitForValidation({
path: { domain_id: 'example' },
body: {
validations: ['example'],
type: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
domain_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
validations?: JsonValue[],
type?: string,
dcv_method?: string,
email_array?: JsonValue[]
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
validation_emails | JsonValue | No | — |
name_scope | string | No | — |
base_emails | JsonValue[] | No | — |
email_array | JsonValue[] | No | — |
dcv_token | JsonValue | No | — |
token | string | No | — |
status | string | No | — |
expiration_date | string | No | — |
verification_value | string | No | — |
http_token_url | string | No | — |
submitForValidation_504f5354
certcentralApi.submitForValidation_504f5354
Submit for validation
Risk: write
await corsair.digicert.api.certcentralApi.submitForValidation_504f5354({
path: { organization_id: 'example' },
body: {
validations: ['example'],
type: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
organization_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
validations?: JsonValue[],
type?: string,
verified_users?: JsonValue[]
}
JsonValue
templateInfo
certcentralApi.templateInfo
Template info
Risk: read
await corsair.digicert.api.certcentralApi.templateInfo({
path: { container_id: 'example', template_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
container_id: string,
template_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
name | string | No | — |
date_created | string | No | — |
access_roles | JsonValue[] | No | — |
transferFunds
certcentralApi.transferFunds
Transfer funds
Risk: destructive
await corsair.digicert.api.certcentralApi.transferFunds({
body: { amount: 1, from_container_id: 1, to_container_id: 1 },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
amount: number,
from_container_id: number,
to_container_id: number
}
JsonValue
unitOrderDetails
certcentralApi.unitOrderDetails
Unit order details
Risk: read
await corsair.digicert.api.certcentralApi.unitOrderDetails({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
unit_account_id | number | No | — |
unit_account_name | string | No | — |
bundle | JsonValue[] | No | — |
product_name_id | string | No | — |
product_name | string | No | — |
units | number | No | — |
cost | number | No | — |
status | string | No | — |
expiration_date | string | No | — |
created_date | string | No | — |
can_cancel | boolean | No | — |
updateAccountEmails
certcentralApi.updateAccountEmails
Update account emails
Risk: write
await corsair.digicert.api.certcentralApi.updateAccountEmails({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
admin_email?: string,
emergency_emails?: string
}
JsonValue
updateAccountNotificationSettings
certcentralApi.updateAccountNotificationSettings
Update account notification settings
Risk: write
await corsair.digicert.api.certcentralApi.updateAccountNotificationSettings({
body: {
account_settings: ['example'],
name: 'example',
value: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account_settings?: JsonValue[],
name?: string,
value?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
status | string | No | — |
message | string | No | — |
updateAcmeRestrictions
certcentralApi.updateAcmeRestrictions
Update ACME restrictions
Risk: write
await corsair.digicert.api.certcentralApi.updateAcmeRestrictions({
path: { key_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
key_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
sans?: JsonValue[],
allowed_order_count?: number
}
JsonValue
updateAllowedDomains
certcentralApi.updateAllowedDomains
Update allowed domains
Risk: write
await corsair.digicert.api.certcentralApi.updateAllowedDomains({
path: { container_id: 'example' },
body: {
allowed_domain_names: ['example'],
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
container_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
allowed_domain_names: JsonValue[]
}
JsonValue
updateAutoReissueSettings
certcentralApi.updateAutoReissueSettings
Update auto-reissue settings
Risk: write
await corsair.digicert.api.certcentralApi.updateAutoReissueSettings({
path: { order_id: 'example' },
body: { auto_reissue: 1 },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
auto_reissue: number
}
JsonValue
updateContainerAssignments
certcentralApi.updateContainerAssignments
Update container assignments
Risk: write
await corsair.digicert.api.certcentralApi.updateContainerAssignments({
path: { user_id: 'example' },
body: {
container_id_assignments: ['example'],
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
user_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
container_id_assignments: JsonValue[]
}
JsonValue
updateCsr
certcentralApi.updateCsr
Update CSR
Risk: write
await corsair.digicert.api.certcentralApi.updateCsr({
path: { order_id: 'example' },
body: { csr: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
csr: string
}
JsonValue
updateCsrForAPendingReissueRequest
certcentralApi.updateCsrForAPendingReissueRequest
Update CSR for a pending reissue request
Risk: read
await corsair.digicert.api.certcentralApi.updateCsrForAPendingReissueRequest({
path: { request_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
request_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
updateInviteStatus
certcentralApi.updateInviteStatus
Update invite status
Risk: write
await corsair.digicert.api.certcentralApi.updateInviteStatus({
path: { invite_id: 'example' },
body: { status: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
invite_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
status: string
}
JsonValue
updateKeyStatus
certcentralApi.updateKeyStatus
Update key status
Risk: write
await corsair.digicert.api.certcentralApi.updateKeyStatus({
path: { key_id: 'example' },
body: { status: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
key_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
status: string
}
JsonValue
updateOidcSsoConfiguration
certcentralApi.updateOidcSsoConfiguration
Update OIDC SSO configuration
Risk: write
await corsair.digicert.api.certcentralApi.updateOidcSsoConfiguration({
body: {
provider_url: 'example',
client_id: 'example',
client_secret: 'example',
friendly_name: 'example',
scope_parameter: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
provider_url: string,
client_id: string,
client_secret: string,
friendly_name: string,
scope_parameter: string,
discoverable?: boolean
}
JsonValue
updateOrderContacts
certcentralApi.updateOrderContacts
Update order contacts
Risk: write
await corsair.digicert.api.certcentralApi.updateOrderContacts({
path: { order_id: 'example' },
body: {
contacts: ['example'],
contact_type: 'example',
first_name: 'example',
last_name: 'example',
email: 'jane.doe@example.com',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
contacts?: JsonValue[],
contact_type?: string,
first_name?: string,
last_name?: string,
email?: string,
job_title?: string,
telephone?: string,
language_id?: string
}
JsonValue
updateOrderStatus
certcentralApi.updateOrderStatus
Update order status
Risk: destructive
await corsair.digicert.api.certcentralApi.updateOrderStatus({
path: { order_id: 'example' },
body: { status: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
status: string,
note?: string
}
JsonValue
updateOrganizationAndTechnicalContact
certcentralApi.updateOrganizationAndTechnicalContact
Update organization and technical contact
Risk: write
await corsair.digicert.api.certcentralApi.updateOrganizationAndTechnicalContact({
path: { organization_id: 'example' },
body: {
contacts: ['example'],
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
organization_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
contacts?: JsonValue[],
first_name?: string,
last_name?: string,
email?: string,
job_title?: string,
telephone?: string,
telephone_extension?: string,
language_id?: string,
contact_type?: string
}
JsonValue
updateOrganizationAssignments
certcentralApi.updateOrganizationAssignments
Update organization assignments
Risk: write
await corsair.digicert.api.certcentralApi.updateOrganizationAssignments({
path: { container_id: 'example' },
body: {
organization_id_assignments: ['example'],
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
container_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
organization_id_assignments: JsonValue[]
}
JsonValue
updateRenewalMessage
certcentralApi.updateRenewalMessage
Update renewal message
Risk: write
await corsair.digicert.api.certcentralApi.updateRenewalMessage({
path: { order_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
custom_renewal_message?: string
}
JsonValue
updateRenewalNotificationRecipients
certcentralApi.updateRenewalNotificationRecipients
Update renewal notification recipients
Risk: write
await corsair.digicert.api.certcentralApi.updateRenewalNotificationRecipients({
path: { container_id: 'example' },
body: {
name: 'example',
value: 'example',
allow_override: true,
inheritable: true,
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
container_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
name: string,
value: string,
allow_override: boolean,
inheritable: boolean
}
JsonValue
updateRenewalNotificationSettings
certcentralApi.updateRenewalNotificationSettings
Update renewal notification settings
Risk: write
await corsair.digicert.api.certcentralApi.updateRenewalNotificationSettings({
path: { order_id: 'example', status: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | JsonValue | No | — |
path full type
path full type
{
order_id: string,
status: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
updateRequestStatus
certcentralApi.updateRequestStatus
Update request status
Risk: write
await corsair.digicert.api.certcentralApi.updateRequestStatus({
path: { request_id: 'example' },
body: { status: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
request_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
status: string,
processor_comment?: string
}
JsonValue
updateSamlEntity
certcentralApi.updateSamlEntity
Update SAML entity
Risk: write
await corsair.digicert.api.certcentralApi.updateSamlEntity({
path: { entity_id: 'example' },
body: { attribute_mapping: 'example', friendly_name: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
entity_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
xml_metadata?: string,
source_url?: string,
attribute_mapping: string,
friendly_name: string
}
JsonValue
updateSiteSealSettings
certcentralApi.updateSiteSealSettings
Update site seal settings
Risk: write
await corsair.digicert.api.certcentralApi.updateSiteSealSettings({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
seal_number?: number,
seal_size?: string,
seal_hover?: boolean,
seal_autoplay?: boolean,
seal_use_logo?: boolean,
display_malware_scan?: boolean,
display_ct_log?: boolean,
display_pci_scan?: boolean,
display_blocklist_check?: boolean,
display_verified_customer?: boolean
}
| Name | Type | Required | Description |
|---|---|---|---|
order_id | number | No | — |
product_name_id | string | No | — |
seal_hash | string | No | — |
seal_number | string | No | — |
seal_size | string | No | — |
seal_hover | boolean | No | — |
seal_autoplay | boolean | No | — |
seal_use_logo | boolean | No | — |
display_malware_scan | boolean | No | — |
display_ct_log | boolean | No | — |
display_pci_scan | boolean | No | — |
display_blocklist_check | boolean | No | — |
display_verified_customer | boolean | No | — |
eligible_ct_log | boolean | No | — |
eligible_blocklist_check | boolean | No | — |
eligible_pci_scan | boolean | No | — |
ct_log_enabled | boolean | No | — |
pci_scan_enabled | boolean | No | — |
seal_code | string | No | — |
seal_logo | string | No | — |
updateUserAssignments
certcentralApi.updateUserAssignments
Update user assignments
Risk: write
await corsair.digicert.api.certcentralApi.updateUserAssignments({
path: { container_id: 'example' },
body: {
user_id_assignments: ['example'],
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
container_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
user_id_assignments: JsonValue[]
}
JsonValue
updateVmcOrCmcOrders
certcentralApi.updateVmcOrCmcOrders
Update VMC or CMC orders
Risk: write
await corsair.digicert.api.certcentralApi.updateVmcOrCmcOrders({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | JsonValue | No | — |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
uploadSiteSealLogo
certcentralApi.uploadSiteSealLogo
Upload site seal logo
Risk: write
await corsair.digicert.api.certcentralApi.uploadSiteSealLogo({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | JsonValue | No | — |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
uploadVmcOrCmcLogoEncoded
certcentralApi.uploadVmcOrCmcLogoEncoded
Upload VMC or CMC logo (encoded)
Risk: write
await corsair.digicert.api.certcentralApi.uploadVmcOrCmcLogoEncoded({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | JsonValue | No | — |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
organization_id | number | No | — |
trademark_country_code | string | No | — |
trademark_registration_number | string | No | — |
uploadVmcOrCmcLogoSvg
certcentralApi.uploadVmcOrCmcLogoSvg
Upload VMC or CMC logo (SVG)
Risk: write
await corsair.digicert.api.certcentralApi.uploadVmcOrCmcLogoSvg({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | JsonValue | No | — |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
organization_id | number | No | — |
trademark_country_code | string | No | — |
trademark_registration_number | string | No | — |
userInfo
certcentralApi.userInfo
User info
Risk: read
await corsair.digicert.api.certcentralApi.userInfo({
path: { user_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
user_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
username | string | No | — |
account_id | number | No | — |
first_name | string | No | — |
last_name | string | No | — |
email | string | No | — |
job_title | string | No | — |
telephone | string | No | — |
status | string | No | — |
last_login_date | string | No | — |
container | JsonValue | No | — |
public_id | string | No | — |
name | string | No | — |
parent_id | number | No | — |
template_id | number | No | — |
ekey | string | No | — |
has_logo | boolean | No | — |
is_active | boolean | No | — |
access_roles | JsonValue[] | No | — |
is_cert_central | boolean | No | — |
is_enterprise | boolean | No | — |
is_saml_sso_only | boolean | No | — |
type | string | No | — |
language_id | number | No | — |
account_language_id | number | No | — |
has_container_assignments | boolean | No | — |
container_assignments | JsonValue[] | No | — |
container_visibility | JsonValue[] | No | — |
allowed_domain_names | JsonValue[] | No | — |
organization_assignments | JsonValue[] | No | — |
usernameAvailability
certcentralApi.usernameAvailability
Username availability
Risk: read
await corsair.digicert.api.certcentralApi.usernameAvailability({
path: { user_name: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
user_name: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
available | boolean | No | — |
validateVmcOrCmcLogoFormatEncoded
certcentralApi.validateVmcOrCmcLogoFormatEncoded
Validate VMC or CMC logo format (encoded)
Risk: write
await corsair.digicert.api.certcentralApi.validateVmcOrCmcLogoFormatEncoded({
body: { logo: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
logo: string
}
JsonValue
validateVmcOrCmcLogoFormatSvg
certcentralApi.validateVmcOrCmcLogoFormatSvg
Validate VMC or CMC logo format (SVG)
Risk: write
await corsair.digicert.api.certcentralApi.validateVmcOrCmcLogoFormatSvg({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | JsonValue | No | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
validationDetails
certcentralApi.validationDetails
Validation details
Risk: read
await corsair.digicert.api.certcentralApi.validationDetails({
path: { domain_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
domain_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
validations | JsonValue[] | No | — |
type | string | No | — |
name | string | No | — |
description | string | No | — |
date_created | string | No | — |
validated_until | string | No | — |
status | string | No | — |
dcv_status | string | No | — |
org_status | string | No | — |
verified_users | JsonValue[] | No | — |
validationDetails_4745542f
certcentralApi.validationDetails_4745542f
Validation details
Risk: read
await corsair.digicert.api.certcentralApi.validationDetails_4745542f({
path: { organization_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
organization_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
validations | JsonValue[] | No | — |
type | string | No | — |
name | string | No | — |
description | string | No | — |
date_created | string | No | — |
validated_until | string | No | — |
status | string | No | — |
verified_users | JsonValue[] | No | — |
validationTypes
certcentralApi.validationTypes
Validation types
Risk: read
await corsair.digicert.api.certcentralApi.validationTypes({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
validation_types | JsonValue[] | No | — |
validationTypes_4745542f
certcentralApi.validationTypes_4745542f
Validation types
Risk: read
await corsair.digicert.api.certcentralApi.validationTypes_4745542f({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
validation_types | JsonValue[] | No | — |
viewBalance
certcentralApi.viewBalance
View balance
Risk: read
await corsair.digicert.api.certcentralApi.viewBalance({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
balance | string | No | — |
currency | string | No | — |
unpaid_invoice_balance | string | No | — |
negative_balance_limit | string | No | — |
total_available_funds | string | No | — |
used_credit_from_other_containers | string | No | — |
unlimited_negative_balance | boolean | No | — |
viewKeyLockerSignatures
certcentralApi.viewKeyLockerSignatures
View KeyLocker signatures
Risk: read
await corsair.digicert.api.certcentralApi.viewKeyLockerSignatures({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
order_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
signatures | JsonValue | No | — |
signatures_allotted | number | No | — |
signatures_consumed | number | No | — |
user_assigned | JsonValue | No | — |
name | string | No | — |
email | string | No | — |
account_id | number | No | — |
order_id | number | No | — |
certificate_id | number | No | — |
viewNote
certcentralApi.viewNote
View note
Risk: read
await corsair.digicert.api.certcentralApi.viewNote({
path: { order_id: 'example', note_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
order_id: string,
note_id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | number | No | — |
date_created | string | No | — |
text | string | No | — |
user | JsonValue | No | — |
voucherPriceEstimate
certcentralApi.voucherPriceEstimate
Voucher price estimate
Risk: write
await corsair.digicert.api.certcentralApi.voucherPriceEstimate({
body: {
vouchers: ['example'],
product_name_id: 'example',
quantity: 1,
country: 'example',
city: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
vouchers?: JsonValue[],
product_name_id?: string,
no_of_fqdns?: number,
no_of_wildcards?: number,
shipping_method?: string,
validity_years?: number,
validity_days?: number,
quantity?: number,
billing_address?: JsonValue,
country?: string,
city?: string,
state?: string,
zip?: string,
address?: string,
address2?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
voucher_prices | JsonValue[] | No | — |
product_name_id | string | No | — |
no_of_fqdns | number | No | — |
no_of_wildcards | number | No | — |
shipping_method | string | No | — |
validity_years | number | No | — |
validity_days | number | No | — |
quantity | number | No | — |
cost | number | No | — |
total_cost | number | No | — |
total_tax | number | No | — |
total_cost_plus_tax | number | No | — |
currency | string | No | — |
Certificates
listIntermediates
certificates.listIntermediates
List account intermediate certificates.
Risk: read
await corsair.digicert.api.certificates.listIntermediates({});
| Name | Type | Required | Description |
|---|---|---|---|
intermediates | object[] | Yes | — |
intermediates full type
intermediates full type
{
id: string,
subject_common_name: string,
subject_org_name: string,
valid_from?: string,
issuer_common_name: string,
status: string,
valid_to: string,
serial_number: string,
thumbprint: string,
signature_hash: string,
is_private: string,
is_root: string,
pem: string
}[]
Content Trust
infoV0
contentTrust.infoV0
Read public Content Trust CSC v0 service information.
Risk: read
await corsair.digicert.api.contentTrust.infoV0({ lang: 'en-US' });
| Name | Type | Required | Description |
|---|---|---|---|
lang | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
lang | string | No | — |
specs | string | No | — |
name | string | No | — |
logo | string | No | — |
region | string | No | — |
description | string | No | — |
oauth2 | string | No | — |
methods | string[] | No | — |
authType | string[] | No | — |
infoV1
contentTrust.infoV1
Read public Content Trust CSC v1 service information.
Risk: read
await corsair.digicert.api.contentTrust.infoV1({ lang: 'en-US' });
| Name | Type | Required | Description |
|---|---|---|---|
lang | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
lang | string | No | — |
specs | string | No | — |
name | string | No | — |
logo | string | No | — |
region | string | No | — |
description | string | No | — |
oauth2 | string | No | — |
methods | string[] | No | — |
authType | string[] | No | — |
Content Trust Api
approve
contentTrustApi.approve
Approve validation
Risk: write
await corsair.digicert.api.contentTrustApi.approve({
path: { validationId: 'example' },
query: { account_id: 'example' },
body: {
account: { id: 'example' },
contact_data: { mobile_phone: 'example', email: 'jane.doe@example.com' },
user_data: { first_name: 'example', last_name: 'example' },
identification_document: {
country: 'example',
number: 'example',
date_issued: 'example',
valid_until: 'example',
type: 'PASSPORT',
},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
validationId: string
}
query full type
query full type
{
account_id: string
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account: {
id: string,
name?: string
},
contact_data: {
mobile_phone: string,
email: string
},
user_data: {
first_name: string,
last_name: string,
common_name?: string,
nationality?: string,
ident_language?: string,
organization_uuid?: string,
organization?: string,
title?: string,
partner_id?: string,
profession_validation_date?: string,
organization_identifier?: string,
organization_country?: string,
organization_state?: string,
organization_locality?: string
},
identification_document: {
country: string,
number: string,
date_issued: string,
valid_until: string,
type: PASSPORT | DRIVER_LICENSE | ID_CARD
}
}
| Name | Type | Required | Description |
|---|---|---|---|
created_by | string | No | — |
modified_on | string | No | — |
modified_by | string | No | — |
created_on | string | No | — |
validation_id | string | No | — |
validation_entity | string | No | — |
validation_entity_type | string | No | — |
validation_type | string | No | — |
validation_method | string | No | — |
validation_status | VALIDATION_CREATED | VALIDATION_ERROR | INVITE_SENT | INVITE_FAILED | PENDING_IDENTITY_PROOFING | APPROVED | REJECTED | ABORTED | DOCUMENT_VERIFICATION_ERROR | REVIEW_PENDING | EXPIRED | PENDING_MANUAL_REVIEW | PENDING_SIGNER_APPROVAL | CANCELLED | No | — |
default_profile_id | string | No | — |
credential_profile_ids | string[] | No | — |
verifyid_transaction_id | string | No | — |
associated_users | object[] | No | — |
expiration_date | string | No | — |
expired | boolean | No | — |
rejection_status | string | No | — |
vetting_details | object | No | — |
validation_approvals | object[] | No | — |
validation_enrollment_id | string | No | — |
validation_profile_id | string | No | — |
failure_reason | string | No | — |
language_code | string | No | — |
auto_approval_enabled | boolean | No | — |
terms_and_conditions | string | No | — |
terms_acceptance_time | string | No | — |
client_data | string | No | — |
last_sent | string | No | — |
invites_number | number | No | — |
validation_profile | object | No | — |
cancelationReason | string | No | — |
bulk_onboarding_user_id | string | No | — |
legal_first_name | string | No | — |
legal_last_name | string | No | — |
account_id | string | No | — |
associated_users full type
associated_users full type
{
created_by?: string,
modified_on?: string,
modified_by?: string,
created_on?: string,
associate_user_id?: string,
email?: string,
phone?: string,
pending_user_creation?: boolean
}[]
vetting_details full type
vetting_details full type
{
first_name?: string,
last_name?: string,
common_name?: string,
country?: string,
document_type?: PASSPORT | DRIVER_LICENSE | ID_CARD,
document_id?: string,
date_issued?: string,
valid_until?: string,
nationality?: string,
ident_language?: string,
title?: string,
organization_uuid?: string,
organization?: string,
organization_identifier?: string,
organization_country?: string,
organization_unit?: string,
organization_state?: string,
organization_locality?: string,
phone?: string,
email?: string,
blocklist_transaction_number?: string,
partner_id?: string,
profession_validation_date?: string
}
validation_approvals full type
validation_approvals full type
{
id?: string,
validationId?: string,
reviewed_validation_status?: VALIDATION_CREATED | VALIDATION_ERROR | INVITE_SENT | INVITE_FAILED | PENDING_IDENTITY_PROOFING | APPROVED | REJECTED | ABORTED | DOCUMENT_VERIFICATION_ERROR | EXPIRED | PENDING_MANUAL_REVIEW | PENDING_SIGNER_APPROVAL | PENDING_ORG_REVIEW | DISABLED | CANCELLED,
status?: APPROVED | REJECTED | string,
reason?: string,
reason_code?: VALIDATION_IN_PROCESS | VALIDATION_COMPLETED,
userId?: string,
reviewed_on?: string,
reviewed_by?: string
}[]
validation_profile full type
validation_profile full type
{
id?: string,
credential_profile_ids?: string[],
default_credential_profile_id?: string,
validation_method?: f2f | remote | RA | manual | remote_manual,
validation_type?: advanced+ | qualified | basic | string,
nickname?: string,
policies?: {
name?: organization_details_required | title_detail_required | create_user | issue_credential | suppress_validation_approval_email | add_san_value_to_certificate | blocklist_transaction_number_required | allow_opt_out | register_notary_profession_validation | organization_identifier_required,
value?: boolean
}[],
status?: ACTIVE | DISABLED | string,
modified_on?: string,
created_by?: string,
created_on?: string,
modified_by?: string,
account_id?: string,
alternative_validation_profile_id?: string,
is_default_profile?: string,
organization_id?: string,
remote_identity_vendor?: AUTO_IDENT | VIDEO_IDENT,
product_type?: string,
organization_identifier?: string,
onboarding_credential_profile_id?: string
}
approvePendingSignerApproval
contentTrustApi.approvePendingSignerApproval
Approve self-enrolled user validation
Risk: write
await corsair.digicert.api.contentTrustApi.approvePendingSignerApproval({
path: { validationId: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
validationId: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
created_by | string | No | — |
modified_on | string | No | — |
modified_by | string | No | — |
created_on | string | No | — |
validation_id | string | No | — |
validation_entity | string | No | — |
validation_entity_type | string | No | — |
validation_type | string | No | — |
validation_method | string | No | — |
validation_status | VALIDATION_CREATED | VALIDATION_ERROR | INVITE_SENT | INVITE_FAILED | PENDING_IDENTITY_PROOFING | APPROVED | REJECTED | ABORTED | DOCUMENT_VERIFICATION_ERROR | REVIEW_PENDING | EXPIRED | PENDING_MANUAL_REVIEW | PENDING_SIGNER_APPROVAL | CANCELLED | No | — |
default_profile_id | string | No | — |
credential_profile_ids | string[] | No | — |
verifyid_transaction_id | string | No | — |
associated_users | object[] | No | — |
expiration_date | string | No | — |
expired | boolean | No | — |
rejection_status | string | No | — |
vetting_details | object | No | — |
validation_approvals | object[] | No | — |
validation_enrollment_id | string | No | — |
validation_profile_id | string | No | — |
failure_reason | string | No | — |
language_code | string | No | — |
auto_approval_enabled | boolean | No | — |
terms_and_conditions | string | No | — |
terms_acceptance_time | string | No | — |
client_data | string | No | — |
last_sent | string | No | — |
invites_number | number | No | — |
validation_profile | object | No | — |
cancelationReason | string | No | — |
bulk_onboarding_user_id | string | No | — |
legal_first_name | string | No | — |
legal_last_name | string | No | — |
account_id | string | No | — |
associated_users full type
associated_users full type
{
created_by?: string,
modified_on?: string,
modified_by?: string,
created_on?: string,
associate_user_id?: string,
email?: string,
phone?: string,
pending_user_creation?: boolean
}[]
vetting_details full type
vetting_details full type
{
first_name?: string,
last_name?: string,
common_name?: string,
country?: string,
document_type?: PASSPORT | DRIVER_LICENSE | ID_CARD,
document_id?: string,
date_issued?: string,
valid_until?: string,
nationality?: string,
ident_language?: string,
title?: string,
organization_uuid?: string,
organization?: string,
organization_identifier?: string,
organization_country?: string,
organization_unit?: string,
organization_state?: string,
organization_locality?: string,
phone?: string,
email?: string,
blocklist_transaction_number?: string,
partner_id?: string,
profession_validation_date?: string
}
validation_approvals full type
validation_approvals full type
{
id?: string,
validationId?: string,
reviewed_validation_status?: VALIDATION_CREATED | VALIDATION_ERROR | INVITE_SENT | INVITE_FAILED | PENDING_IDENTITY_PROOFING | APPROVED | REJECTED | ABORTED | DOCUMENT_VERIFICATION_ERROR | EXPIRED | PENDING_MANUAL_REVIEW | PENDING_SIGNER_APPROVAL | PENDING_ORG_REVIEW | DISABLED | CANCELLED,
status?: APPROVED | REJECTED | string,
reason?: string,
reason_code?: VALIDATION_IN_PROCESS | VALIDATION_COMPLETED,
userId?: string,
reviewed_on?: string,
reviewed_by?: string
}[]
validation_profile full type
validation_profile full type
{
id?: string,
credential_profile_ids?: string[],
default_credential_profile_id?: string,
validation_method?: f2f | remote | RA | manual | remote_manual,
validation_type?: advanced+ | qualified | basic | string,
nickname?: string,
policies?: {
name?: organization_details_required | title_detail_required | create_user | issue_credential | suppress_validation_approval_email | add_san_value_to_certificate | blocklist_transaction_number_required | allow_opt_out | register_notary_profession_validation | organization_identifier_required,
value?: boolean
}[],
status?: ACTIVE | DISABLED | string,
modified_on?: string,
created_by?: string,
created_on?: string,
modified_by?: string,
account_id?: string,
alternative_validation_profile_id?: string,
is_default_profile?: string,
organization_id?: string,
remote_identity_vendor?: AUTO_IDENT | VIDEO_IDENT,
product_type?: string,
organization_identifier?: string,
onboarding_credential_profile_id?: string
}
approveValidationOrganization
contentTrustApi.approveValidationOrganization
Approve organization details for a validation
Risk: write
await corsair.digicert.api.contentTrustApi.approveValidationOrganization({
path: { validationId: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
validationId: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
created_by | string | No | — |
modified_on | string | No | — |
modified_by | string | No | — |
created_on | string | No | — |
validation_id | string | No | — |
validation_entity | string | No | — |
validation_entity_type | string | No | — |
validation_type | string | No | — |
validation_method | string | No | — |
validation_status | VALIDATION_CREATED | VALIDATION_ERROR | INVITE_SENT | INVITE_FAILED | PENDING_IDENTITY_PROOFING | APPROVED | REJECTED | ABORTED | DOCUMENT_VERIFICATION_ERROR | REVIEW_PENDING | EXPIRED | PENDING_MANUAL_REVIEW | PENDING_SIGNER_APPROVAL | CANCELLED | No | — |
default_profile_id | string | No | — |
credential_profile_ids | string[] | No | — |
verifyid_transaction_id | string | No | — |
associated_users | object[] | No | — |
expiration_date | string | No | — |
expired | boolean | No | — |
rejection_status | string | No | — |
vetting_details | object | No | — |
validation_approvals | object[] | No | — |
validation_enrollment_id | string | No | — |
validation_profile_id | string | No | — |
failure_reason | string | No | — |
language_code | string | No | — |
auto_approval_enabled | boolean | No | — |
terms_and_conditions | string | No | — |
terms_acceptance_time | string | No | — |
client_data | string | No | — |
last_sent | string | No | — |
invites_number | number | No | — |
validation_profile | object | No | — |
cancelationReason | string | No | — |
bulk_onboarding_user_id | string | No | — |
legal_first_name | string | No | — |
legal_last_name | string | No | — |
account_id | string | No | — |
associated_users full type
associated_users full type
{
created_by?: string,
modified_on?: string,
modified_by?: string,
created_on?: string,
associate_user_id?: string,
email?: string,
phone?: string,
pending_user_creation?: boolean
}[]
vetting_details full type
vetting_details full type
{
first_name?: string,
last_name?: string,
common_name?: string,
country?: string,
document_type?: PASSPORT | DRIVER_LICENSE | ID_CARD,
document_id?: string,
date_issued?: string,
valid_until?: string,
nationality?: string,
ident_language?: string,
title?: string,
organization_uuid?: string,
organization?: string,
organization_identifier?: string,
organization_country?: string,
organization_unit?: string,
organization_state?: string,
organization_locality?: string,
phone?: string,
email?: string,
blocklist_transaction_number?: string,
partner_id?: string,
profession_validation_date?: string
}
validation_approvals full type
validation_approvals full type
{
id?: string,
validationId?: string,
reviewed_validation_status?: VALIDATION_CREATED | VALIDATION_ERROR | INVITE_SENT | INVITE_FAILED | PENDING_IDENTITY_PROOFING | APPROVED | REJECTED | ABORTED | DOCUMENT_VERIFICATION_ERROR | EXPIRED | PENDING_MANUAL_REVIEW | PENDING_SIGNER_APPROVAL | PENDING_ORG_REVIEW | DISABLED | CANCELLED,
status?: APPROVED | REJECTED | string,
reason?: string,
reason_code?: VALIDATION_IN_PROCESS | VALIDATION_COMPLETED,
userId?: string,
reviewed_on?: string,
reviewed_by?: string
}[]
validation_profile full type
validation_profile full type
{
id?: string,
credential_profile_ids?: string[],
default_credential_profile_id?: string,
validation_method?: f2f | remote | RA | manual | remote_manual,
validation_type?: advanced+ | qualified | basic | string,
nickname?: string,
policies?: {
name?: organization_details_required | title_detail_required | create_user | issue_credential | suppress_validation_approval_email | add_san_value_to_certificate | blocklist_transaction_number_required | allow_opt_out | register_notary_profession_validation | organization_identifier_required,
value?: boolean
}[],
status?: ACTIVE | DISABLED | string,
modified_on?: string,
created_by?: string,
created_on?: string,
modified_by?: string,
account_id?: string,
alternative_validation_profile_id?: string,
is_default_profile?: string,
organization_id?: string,
remote_identity_vendor?: AUTO_IDENT | VIDEO_IDENT,
product_type?: string,
organization_identifier?: string,
onboarding_credential_profile_id?: string
}
authorizeCredentials
contentTrustApi.authorizeCredentials
Authorize credential access
Risk: write
await corsair.digicert.api.contentTrustApi.authorizeCredentials({
body: {
hash: ['example'],
credentialID: 'example',
numSignatures: 1,
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
hash: string[],
credentialID: string,
numSignatures: number,
PIN?: string,
OTP?: string,
description?: string,
clientData?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
expiresIn | string | No | — |
SAD | string | No | — |
authorizeCredentials1
contentTrustApi.authorizeCredentials1
Authorize credential access
Risk: write
await corsair.digicert.api.contentTrustApi.authorizeCredentials1({
body: {
hash: ['example'],
credentialID: 'example',
numSignatures: 1,
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
hash: string[],
credentialID: string,
numSignatures: number,
PIN?: string,
OTP?: string,
description?: string,
clientData?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
expiresIn | string | No | — |
SAD | string | No | — |
cancelCredentialByName
contentTrustApi.cancelCredentialByName
Cancel credential by credential name
Risk: destructive
await corsair.digicert.api.contentTrustApi.cancelCredentialByName({
path: { name: 'example' },
body: { notes: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
name: string
}
query full type
query full type
{
user_id?: string
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
notes: string
}
| Name | Type | Required | Description |
|---|---|---|---|
created_by | string | No | — |
modified_on | string | No | — |
modified_by | string | No | — |
created_on | string | No | — |
id | string | No | — |
name | string | No | — |
user_id | string | No | — |
account_id | string | No | — |
profile_id | string | No | — |
first_credential | boolean | No | — |
status | string | No | — |
cc_order_id | string | No | — |
cancelValidation
contentTrustApi.cancelValidation
Cancel validation
Risk: write
await corsair.digicert.api.contentTrustApi.cancelValidation({
path: { validationId: 'example' },
query: { account_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
validationId: string
}
query full type
query full type
{
account_id: string
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
created_by | string | No | — |
modified_on | string | No | — |
modified_by | string | No | — |
created_on | string | No | — |
validation_id | string | No | — |
validation_entity | string | No | — |
validation_entity_type | string | No | — |
validation_type | string | No | — |
validation_method | string | No | — |
validation_status | VALIDATION_CREATED | VALIDATION_ERROR | INVITE_SENT | INVITE_FAILED | PENDING_IDENTITY_PROOFING | APPROVED | REJECTED | ABORTED | DOCUMENT_VERIFICATION_ERROR | REVIEW_PENDING | EXPIRED | PENDING_MANUAL_REVIEW | PENDING_SIGNER_APPROVAL | CANCELLED | No | — |
default_profile_id | string | No | — |
credential_profile_ids | string[] | No | — |
verifyid_transaction_id | string | No | — |
associated_users | object[] | No | — |
expiration_date | string | No | — |
expired | boolean | No | — |
rejection_status | string | No | — |
vetting_details | object | No | — |
validation_approvals | object[] | No | — |
validation_enrollment_id | string | No | — |
validation_profile_id | string | No | — |
failure_reason | string | No | — |
language_code | string | No | — |
auto_approval_enabled | boolean | No | — |
terms_and_conditions | string | No | — |
terms_acceptance_time | string | No | — |
client_data | string | No | — |
last_sent | string | No | — |
invites_number | number | No | — |
validation_profile | object | No | — |
cancelationReason | string | No | — |
bulk_onboarding_user_id | string | No | — |
legal_first_name | string | No | — |
legal_last_name | string | No | — |
account_id | string | No | — |
associated_users full type
associated_users full type
{
created_by?: string,
modified_on?: string,
modified_by?: string,
created_on?: string,
associate_user_id?: string,
email?: string,
phone?: string,
pending_user_creation?: boolean
}[]
vetting_details full type
vetting_details full type
{
first_name?: string,
last_name?: string,
common_name?: string,
country?: string,
document_type?: PASSPORT | DRIVER_LICENSE | ID_CARD,
document_id?: string,
date_issued?: string,
valid_until?: string,
nationality?: string,
ident_language?: string,
title?: string,
organization_uuid?: string,
organization?: string,
organization_identifier?: string,
organization_country?: string,
organization_unit?: string,
organization_state?: string,
organization_locality?: string,
phone?: string,
email?: string,
blocklist_transaction_number?: string,
partner_id?: string,
profession_validation_date?: string
}
validation_approvals full type
validation_approvals full type
{
id?: string,
validationId?: string,
reviewed_validation_status?: VALIDATION_CREATED | VALIDATION_ERROR | INVITE_SENT | INVITE_FAILED | PENDING_IDENTITY_PROOFING | APPROVED | REJECTED | ABORTED | DOCUMENT_VERIFICATION_ERROR | EXPIRED | PENDING_MANUAL_REVIEW | PENDING_SIGNER_APPROVAL | PENDING_ORG_REVIEW | DISABLED | CANCELLED,
status?: APPROVED | REJECTED | string,
reason?: string,
reason_code?: VALIDATION_IN_PROCESS | VALIDATION_COMPLETED,
userId?: string,
reviewed_on?: string,
reviewed_by?: string
}[]
validation_profile full type
validation_profile full type
{
id?: string,
credential_profile_ids?: string[],
default_credential_profile_id?: string,
validation_method?: f2f | remote | RA | manual | remote_manual,
validation_type?: advanced+ | qualified | basic | string,
nickname?: string,
policies?: {
name?: organization_details_required | title_detail_required | create_user | issue_credential | suppress_validation_approval_email | add_san_value_to_certificate | blocklist_transaction_number_required | allow_opt_out | register_notary_profession_validation | organization_identifier_required,
value?: boolean
}[],
status?: ACTIVE | DISABLED | string,
modified_on?: string,
created_by?: string,
created_on?: string,
modified_by?: string,
account_id?: string,
alternative_validation_profile_id?: string,
is_default_profile?: string,
organization_id?: string,
remote_identity_vendor?: AUTO_IDENT | VIDEO_IDENT,
product_type?: string,
organization_identifier?: string,
onboarding_credential_profile_id?: string
}
createRecurringCredential
contentTrustApi.createRecurringCredential
Create credential
Risk: write
await corsair.digicert.api.contentTrustApi.createRecurringCredential({
body: {
account: { id: 'example' },
label: 'example',
profileId: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account: {
id: string,
name?: string
},
label: string,
mobile?: string,
profileId: string,
reuseExistingSecret?: boolean
}
| Name | Type | Required | Description |
|---|---|---|---|
id | string | No | — |
account_id | string | No | — |
userId | string | No | — |
credential_id | string | No | — |
name | string | No | — |
profile_id | string | No | — |
first_credential | boolean | No | — |
createRecurringCredentialV2
contentTrustApi.createRecurringCredentialV2
Create credential v2 flow supports credential creation with CertCentral, Trustlink, MPKI8 and Dcone CA
Risk: write
await corsair.digicert.api.contentTrustApi.createRecurringCredentialV2({
body: {
label: 'example',
productName: 'example',
organization: {
id: 1,
contacts: [{ contact_type: 'VERIFIED_CONTACT' }],
},
userId: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
label: string,
countryCode?: string,
productName: string,
organization: {
id: number,
contacts: {
first_name?: string,
last_name?: string,
telephone?: string,
email?: string,
job_title?: string,
country?: string,
city?: string,
state?: string,
zip?: string,
contact_type: VERIFIED_CONTACT | ORGANIZATION_CONTACT,
id?: number
}[]
},
userId: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | string | No | — |
account_id | string | No | — |
userId | string | No | — |
credential_id | string | No | — |
name | string | No | — |
profile_id | string | No | — |
first_credential | boolean | No | — |
createUserInAm
contentTrustApi.createUserInAm
Create user in AM
Risk: write
await corsair.digicert.api.contentTrustApi.createUserInAm({
body: {
email: 'jane.doe@example.com',
first_name: 'example',
last_name: 'example',
user_name: 'example',
user_type: 'example',
accounts: ['example'],
roles: ['AM_ACCOUNT_ADMIN'],
is_pipl_accepted: true,
is_tou_accepted: true,
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
email: string,
first_name: string,
last_name: string,
user_name: string,
phone_number?: string,
locale?: string,
description?: string,
user_type: string,
accounts: string[],
roles: (AM_ACCOUNT_ADMIN | DSM_DOCUMENT_SIGNER | AM_DEFAULT_USER | DSM_CLIENT_ADMIN)[],
is_pipl_accepted: boolean,
is_tou_accepted: boolean
}
| Name | Type | Required | Description |
|---|---|---|---|
id | string | No | — |
createValidation
contentTrustApi.createValidation
Create validation
Risk: write
await corsair.digicert.api.contentTrustApi.createValidation({
body: {
account: { id: 'example' },
associated_users: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account: {
id: string,
name?: string
},
validation_entity?: person | organization,
validation_entity_type?: account_user | end_user | organization,
validation_type?: advanced+ | qualified | basic,
validation_method?: f2f | remote | RA | manual | remote_manual,
default_profile_id?: string,
associated_users: {
list?: {
associate_user_id?: string,
email: string,
phone?: string,
new_user?: boolean,
language_code?: string
}[],
empty?: boolean
},
validation_profile_id?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
created_by | string | No | — |
modified_on | string | No | — |
modified_by | string | No | — |
created_on | string | No | — |
validation_id | string | No | — |
validation_entity | string | No | — |
validation_entity_type | string | No | — |
validation_type | string | No | — |
validation_method | string | No | — |
validation_status | VALIDATION_CREATED | VALIDATION_ERROR | INVITE_SENT | INVITE_FAILED | PENDING_IDENTITY_PROOFING | APPROVED | REJECTED | ABORTED | DOCUMENT_VERIFICATION_ERROR | REVIEW_PENDING | EXPIRED | PENDING_MANUAL_REVIEW | PENDING_SIGNER_APPROVAL | CANCELLED | No | — |
default_profile_id | string | No | — |
credential_profile_ids | string[] | No | — |
verifyid_transaction_id | string | No | — |
associated_users | object[] | No | — |
expiration_date | string | No | — |
expired | boolean | No | — |
rejection_status | string | No | — |
vetting_details | object | No | — |
validation_approvals | object[] | No | — |
validation_enrollment_id | string | No | — |
validation_profile_id | string | No | — |
failure_reason | string | No | — |
language_code | string | No | — |
auto_approval_enabled | boolean | No | — |
terms_and_conditions | string | No | — |
terms_acceptance_time | string | No | — |
client_data | string | No | — |
last_sent | string | No | — |
invites_number | number | No | — |
validation_profile | object | No | — |
cancelationReason | string | No | — |
bulk_onboarding_user_id | string | No | — |
legal_first_name | string | No | — |
legal_last_name | string | No | — |
account_id | string | No | — |
tags | object[] | No | — |
associated_users full type
associated_users full type
{
created_by?: string,
modified_on?: string,
modified_by?: string,
created_on?: string,
associate_user_id?: string,
email?: string,
phone?: string,
pending_user_creation?: boolean
}[]
vetting_details full type
vetting_details full type
{
first_name?: string,
last_name?: string,
common_name?: string,
country?: string,
document_type?: PASSPORT | DRIVER_LICENSE | ID_CARD,
document_id?: string,
date_issued?: string,
valid_until?: string,
nationality?: string,
ident_language?: string,
title?: string,
organization_uuid?: string,
organization?: string,
organization_identifier?: string,
organization_country?: string,
organization_unit?: string,
organization_state?: string,
organization_locality?: string,
phone?: string,
email?: string,
blocklist_transaction_number?: string,
partner_id?: string,
profession_validation_date?: string
}
validation_approvals full type
validation_approvals full type
{
id?: string,
validationId?: string,
reviewed_validation_status?: VALIDATION_CREATED | VALIDATION_ERROR | INVITE_SENT | INVITE_FAILED | PENDING_IDENTITY_PROOFING | APPROVED | REJECTED | ABORTED | DOCUMENT_VERIFICATION_ERROR | EXPIRED | PENDING_MANUAL_REVIEW | PENDING_SIGNER_APPROVAL | PENDING_ORG_REVIEW | DISABLED | CANCELLED,
status?: APPROVED | REJECTED | string,
reason?: string,
reason_code?: VALIDATION_IN_PROCESS | VALIDATION_COMPLETED,
userId?: string,
reviewed_on?: string,
reviewed_by?: string
}[]
validation_profile full type
validation_profile full type
{
id?: string,
credential_profile_ids?: string[],
default_credential_profile_id?: string,
validation_method?: f2f | remote | RA | manual | remote_manual,
validation_type?: advanced+ | qualified | basic | string,
nickname?: string,
policies?: {
name?: organization_details_required | title_detail_required | create_user | issue_credential | suppress_validation_approval_email | add_san_value_to_certificate | blocklist_transaction_number_required | allow_opt_out | register_notary_profession_validation | organization_identifier_required,
value?: boolean
}[],
status?: ACTIVE | DISABLED | string,
modified_on?: string,
created_by?: string,
created_on?: string,
modified_by?: string,
account_id?: string,
alternative_validation_profile_id?: string,
is_default_profile?: string,
organization_id?: string,
remote_identity_vendor?: AUTO_IDENT | VIDEO_IDENT,
product_type?: string,
organization_identifier?: string,
onboarding_credential_profile_id?: string
}
tags full type
tags full type
{
name?: string,
values?: string[]
}[]
credentialSendOtp
contentTrustApi.credentialSendOtp
Send credential OTP
Risk: destructive
await corsair.digicert.api.contentTrustApi.credentialSendOtp({
body: { credentialID: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
clientData?: string,
credentialID: string
}
undefined
credentialSendOtp1
contentTrustApi.credentialSendOtp1
Send credential OTP
Risk: destructive
await corsair.digicert.api.contentTrustApi.credentialSendOtp1({
body: { credentialID: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
clientData?: string,
credentialID: string
}
undefined
credentialsInfo
contentTrustApi.credentialsInfo
Get credential details
Risk: write
await corsair.digicert.api.contentTrustApi.credentialsInfo({
body: { credentialID: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificates?: string,
lang?: string,
clientData?: string,
credentialID: string,
certInfo?: boolean,
authInfo?: boolean
}
| Name | Type | Required | Description |
|---|---|---|---|
description | string | No | — |
authMode | string | No | — |
lang | string | No | — |
key | object | No | — |
cert | object | No | — |
SCAL | string | No | — |
PIN | object | No | — |
OTP | object | No | — |
key full type
key full type
{
status?: string,
algo?: string[],
len?: number,
curve?: string
}
cert full type
cert full type
{
status?: string,
certificates?: string[],
issuerDN?: string,
serialNumber?: string,
subjectDN?: string,
validFrom?: string,
validTo?: string
}
PIN full type
PIN full type
{
presence?: string,
format?: string,
label?: string,
description?: string
}
OTP full type
OTP full type
{
presence?: string,
type?: string,
provider?: string,
format?: string,
label?: string,
description?: string,
ID?: string
}
credentialsInfo1
contentTrustApi.credentialsInfo1
Get credential details
Risk: write
await corsair.digicert.api.contentTrustApi.credentialsInfo1({
body: { credentialID: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificates?: string,
lang?: string,
clientData?: string,
credentialID: string,
certInfo?: boolean,
authInfo?: boolean
}
| Name | Type | Required | Description |
|---|---|---|---|
description | string | No | — |
authMode | string | No | — |
lang | string | No | — |
key | object | No | — |
cert | object | No | — |
SCAL | string | No | — |
PIN | object | No | — |
OTP | object | No | — |
key full type
key full type
{
status?: string,
algo?: string[],
len?: number,
curve?: string
}
cert full type
cert full type
{
status?: string,
certificates?: string[],
issuerDN?: string,
serialNumber?: string,
subjectDN?: string,
validFrom?: string,
validTo?: string
}
PIN full type
PIN full type
{
presence?: string,
format?: string,
label?: string,
description?: string
}
OTP full type
OTP full type
{
presence?: string,
type?: string,
provider?: string,
format?: string,
label?: string,
description?: string,
ID?: string
}
disableValidation
contentTrustApi.disableValidation
Disable validation
Risk: write
await corsair.digicert.api.contentTrustApi.disableValidation({
path: { validationId: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
validationId: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account?: {
id: string,
name?: string
},
notes?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
created_by | string | No | — |
modified_on | string | No | — |
modified_by | string | No | — |
created_on | string | No | — |
validation_id | string | No | — |
validation_entity | string | No | — |
validation_entity_type | string | No | — |
validation_type | string | No | — |
validation_method | string | No | — |
validation_status | VALIDATION_CREATED | VALIDATION_ERROR | INVITE_SENT | INVITE_FAILED | PENDING_IDENTITY_PROOFING | APPROVED | REJECTED | ABORTED | DOCUMENT_VERIFICATION_ERROR | REVIEW_PENDING | EXPIRED | PENDING_MANUAL_REVIEW | PENDING_SIGNER_APPROVAL | CANCELLED | No | — |
default_profile_id | string | No | — |
credential_profile_ids | string[] | No | — |
verifyid_transaction_id | string | No | — |
associated_users | object[] | No | — |
expiration_date | string | No | — |
expired | boolean | No | — |
rejection_status | string | No | — |
vetting_details | object | No | — |
validation_approvals | object[] | No | — |
validation_enrollment_id | string | No | — |
validation_profile_id | string | No | — |
failure_reason | string | No | — |
language_code | string | No | — |
auto_approval_enabled | boolean | No | — |
terms_and_conditions | string | No | — |
terms_acceptance_time | string | No | — |
client_data | string | No | — |
last_sent | string | No | — |
invites_number | number | No | — |
validation_profile | object | No | — |
cancelationReason | string | No | — |
bulk_onboarding_user_id | string | No | — |
legal_first_name | string | No | — |
legal_last_name | string | No | — |
account_id | string | No | — |
associated_users full type
associated_users full type
{
created_by?: string,
modified_on?: string,
modified_by?: string,
created_on?: string,
associate_user_id?: string,
email?: string,
phone?: string,
pending_user_creation?: boolean
}[]
vetting_details full type
vetting_details full type
{
first_name?: string,
last_name?: string,
common_name?: string,
country?: string,
document_type?: PASSPORT | DRIVER_LICENSE | ID_CARD,
document_id?: string,
date_issued?: string,
valid_until?: string,
nationality?: string,
ident_language?: string,
title?: string,
organization_uuid?: string,
organization?: string,
organization_identifier?: string,
organization_country?: string,
organization_unit?: string,
organization_state?: string,
organization_locality?: string,
phone?: string,
email?: string,
blocklist_transaction_number?: string,
partner_id?: string,
profession_validation_date?: string
}
validation_approvals full type
validation_approvals full type
{
id?: string,
validationId?: string,
reviewed_validation_status?: VALIDATION_CREATED | VALIDATION_ERROR | INVITE_SENT | INVITE_FAILED | PENDING_IDENTITY_PROOFING | APPROVED | REJECTED | ABORTED | DOCUMENT_VERIFICATION_ERROR | EXPIRED | PENDING_MANUAL_REVIEW | PENDING_SIGNER_APPROVAL | PENDING_ORG_REVIEW | DISABLED | CANCELLED,
status?: APPROVED | REJECTED | string,
reason?: string,
reason_code?: VALIDATION_IN_PROCESS | VALIDATION_COMPLETED,
userId?: string,
reviewed_on?: string,
reviewed_by?: string
}[]
validation_profile full type
validation_profile full type
{
id?: string,
credential_profile_ids?: string[],
default_credential_profile_id?: string,
validation_method?: f2f | remote | RA | manual | remote_manual,
validation_type?: advanced+ | qualified | basic | string,
nickname?: string,
policies?: {
name?: organization_details_required | title_detail_required | create_user | issue_credential | suppress_validation_approval_email | add_san_value_to_certificate | blocklist_transaction_number_required | allow_opt_out | register_notary_profession_validation | organization_identifier_required,
value?: boolean
}[],
status?: ACTIVE | DISABLED | string,
modified_on?: string,
created_by?: string,
created_on?: string,
modified_by?: string,
account_id?: string,
alternative_validation_profile_id?: string,
is_default_profile?: string,
organization_id?: string,
remote_identity_vendor?: AUTO_IDENT | VIDEO_IDENT,
product_type?: string,
organization_identifier?: string,
onboarding_credential_profile_id?: string
}
enableValidation
contentTrustApi.enableValidation
Enable validation
Risk: write
await corsair.digicert.api.contentTrustApi.enableValidation({
path: { validationId: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
validationId: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account?: {
id: string,
name?: string
},
notes?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
created_by | string | No | — |
modified_on | string | No | — |
modified_by | string | No | — |
created_on | string | No | — |
validation_id | string | No | — |
validation_entity | string | No | — |
validation_entity_type | string | No | — |
validation_type | string | No | — |
validation_method | string | No | — |
validation_status | VALIDATION_CREATED | VALIDATION_ERROR | INVITE_SENT | INVITE_FAILED | PENDING_IDENTITY_PROOFING | APPROVED | REJECTED | ABORTED | DOCUMENT_VERIFICATION_ERROR | REVIEW_PENDING | EXPIRED | PENDING_MANUAL_REVIEW | PENDING_SIGNER_APPROVAL | CANCELLED | No | — |
default_profile_id | string | No | — |
credential_profile_ids | string[] | No | — |
verifyid_transaction_id | string | No | — |
associated_users | object[] | No | — |
expiration_date | string | No | — |
expired | boolean | No | — |
rejection_status | string | No | — |
vetting_details | object | No | — |
validation_approvals | object[] | No | — |
validation_enrollment_id | string | No | — |
validation_profile_id | string | No | — |
failure_reason | string | No | — |
language_code | string | No | — |
auto_approval_enabled | boolean | No | — |
terms_and_conditions | string | No | — |
terms_acceptance_time | string | No | — |
client_data | string | No | — |
last_sent | string | No | — |
invites_number | number | No | — |
validation_profile | object | No | — |
cancelationReason | string | No | — |
bulk_onboarding_user_id | string | No | — |
legal_first_name | string | No | — |
legal_last_name | string | No | — |
account_id | string | No | — |
associated_users full type
associated_users full type
{
created_by?: string,
modified_on?: string,
modified_by?: string,
created_on?: string,
associate_user_id?: string,
email?: string,
phone?: string,
pending_user_creation?: boolean
}[]
vetting_details full type
vetting_details full type
{
first_name?: string,
last_name?: string,
common_name?: string,
country?: string,
document_type?: PASSPORT | DRIVER_LICENSE | ID_CARD,
document_id?: string,
date_issued?: string,
valid_until?: string,
nationality?: string,
ident_language?: string,
title?: string,
organization_uuid?: string,
organization?: string,
organization_identifier?: string,
organization_country?: string,
organization_unit?: string,
organization_state?: string,
organization_locality?: string,
phone?: string,
email?: string,
blocklist_transaction_number?: string,
partner_id?: string,
profession_validation_date?: string
}
validation_approvals full type
validation_approvals full type
{
id?: string,
validationId?: string,
reviewed_validation_status?: VALIDATION_CREATED | VALIDATION_ERROR | INVITE_SENT | INVITE_FAILED | PENDING_IDENTITY_PROOFING | APPROVED | REJECTED | ABORTED | DOCUMENT_VERIFICATION_ERROR | EXPIRED | PENDING_MANUAL_REVIEW | PENDING_SIGNER_APPROVAL | PENDING_ORG_REVIEW | DISABLED | CANCELLED,
status?: APPROVED | REJECTED | string,
reason?: string,
reason_code?: VALIDATION_IN_PROCESS | VALIDATION_COMPLETED,
userId?: string,
reviewed_on?: string,
reviewed_by?: string
}[]
validation_profile full type
validation_profile full type
{
id?: string,
credential_profile_ids?: string[],
default_credential_profile_id?: string,
validation_method?: f2f | remote | RA | manual | remote_manual,
validation_type?: advanced+ | qualified | basic | string,
nickname?: string,
policies?: {
name?: organization_details_required | title_detail_required | create_user | issue_credential | suppress_validation_approval_email | add_san_value_to_certificate | blocklist_transaction_number_required | allow_opt_out | register_notary_profession_validation | organization_identifier_required,
value?: boolean
}[],
status?: ACTIVE | DISABLED | string,
modified_on?: string,
created_by?: string,
created_on?: string,
modified_by?: string,
account_id?: string,
alternative_validation_profile_id?: string,
is_default_profile?: string,
organization_id?: string,
remote_identity_vendor?: AUTO_IDENT | VIDEO_IDENT,
product_type?: string,
organization_identifier?: string,
onboarding_credential_profile_id?: string
}
enhanceHash
contentTrustApi.enhanceHash
Enhance document hashes to AES(Advanced electronic signature) compliant hashes
Risk: write
await corsair.digicert.api.contentTrustApi.enhanceHash({
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
credential_id?: string,
hashes?: string[],
sign_algo?: string,
advanced_electronic_signature?: PAdES-B | PAdES-T | CAdES-B | CAdES-T | CAdES-LT
}
| Name | Type | Required | Description |
|---|---|---|---|
hashes | string[] | No | — |
enhanceSignature
contentTrustApi.enhanceSignature
Enhance PKCS1 signature(s) to AES(Advanced electronic signature) compliant signature(s)
Risk: write
await corsair.digicert.api.contentTrustApi.enhanceSignature({
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
credential_id?: string,
signatures?: string[],
sign_algo?: string,
advanced_electronic_signature?: PAdES-B | PAdES-T | CAdES-B | CAdES-T | CAdES-LT,
hashes?: string[]
}
| Name | Type | Required | Description |
|---|---|---|---|
signatures | string[] | No | — |
extendTransaction
contentTrustApi.extendTransaction
Extend multi-signature authorization
Risk: write
await corsair.digicert.api.contentTrustApi.extendTransaction({
body: {
hash: ['example'],
credentialID: 'example',
SAD: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
hash: string[],
clientData?: string,
credentialID: string,
SAD: string
}
| Name | Type | Required | Description |
|---|---|---|---|
expiresIn | string | No | — |
SAD | string | No | — |
extendTransaction1
contentTrustApi.extendTransaction1
Extend multi-signature authorization
Risk: write
await corsair.digicert.api.contentTrustApi.extendTransaction1({
body: {
hash: ['example'],
credentialID: 'example',
SAD: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
hash: string[],
clientData?: string,
credentialID: string,
SAD: string
}
| Name | Type | Required | Description |
|---|---|---|---|
expiresIn | string | No | — |
SAD | string | No | — |
getById
contentTrustApi.getById
Get audit log by ID
Risk: read
await corsair.digicert.api.contentTrustApi.getById({
path: { id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string
}
query full type
query full type
{
account_id?: string
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | string | No | — |
account_id | string | No | — |
resource_type | VALIDATION | SIGNATURE | LICENSE | CREDENTIAL | TIMESTAMP | MANAGER_CONFIG | DSE_ACCOUNT | DSE_PROFILE | CERTIFICATE_PROFILE | SIGNING_PROVIDER | DOCUMENT | CERTIFICATE | SELF_ENROLLMENT_LINK | VALIDATION_PROFILE | DSM_CERTIFICATE_TEMPLATE | DSM_CERTIFICATE_PROFILE | MIGRATION | PRODUCT | ONBOARDING | SIGNER | USER | No | — |
resource_id | string | No | — |
action | SIGN | UPDATE | CREATE | DELETE | EMAIL_SENT | FETCH | AUTHORIZE | SEND_OTP | ENABLE | DISABLE | CANCEL | REVOKE | SIGNING_HUB_USER_CREATION | HASH_ENHANCEMENT | SIGNATURE_ENHANCEMENT | No | — |
auth_type | BASIC | API_TOKEN | INTERNAL | string | No | — |
timestamp | string | No | — |
description | string | No | — |
status | SUCCESS | FAILURE | string | No | — |
error_message | string | No | — |
data | string | No | — |
userId | string | No | — |
created_by | string | No | — |
hash | string | No | — |
number_hashes | number | No | — |
license_hash_enabled | boolean | No | — |
certificateLevel | ADVANCED_PLUS | QUALIFIED | BASIC | No | — |
certificateType | ESEAL | INDIVIDUAL | INDIVIDUAL_WITH_ORGANIZATION | PROFESSIONAL | CLIENT_AUTHENTICATION | No | — |
getCredentialByName
contentTrustApi.getCredentialByName
Returns credential details by credential name
Risk: read
await corsair.digicert.api.contentTrustApi.getCredentialByName({
path: { name: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
name: string
}
query full type
query full type
{
user_id?: string
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
created_by | string | No | — |
modified_on | string | No | — |
modified_by | string | No | — |
created_on | string | No | — |
id | string | No | — |
name | string | No | — |
user_id | string | No | — |
account_id | string | No | — |
profile_id | string | No | — |
first_credential | boolean | No | — |
status | string | No | — |
cc_order_id | string | No | — |
getCredentialList
contentTrustApi.getCredentialList
List user credentials
Risk: read
await corsair.digicert.api.contentTrustApi.getCredentialList({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
Paging parameters?: {
offset?: number,
limit?: number,
sort?: string[]
},
Search parameters?: {
id?: string,
label?: string,
user_id?: string,
status?: ACTIVE | PENDING_APPROVAL | DEACTIVATED | VALID | SUSPENDED | EXPIRED | REVOKED | PENDING_ISSUANCE,
key_algorithm?: string,
key_size?: number,
account_id?: string
}
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
total | number | No | — |
offset | number | No | — |
limit | number | No | — |
credentials | object[] | No | — |
credentials full type
credentials full type
{
created_by?: string,
modified_on?: string,
modified_by?: string,
created_on?: string,
credential_id?: string,
label?: string,
key_algorithm?: string,
key_size?: number,
status?: string,
profile_id?: string,
userId?: string
}[]
getValidation
contentTrustApi.getValidation
Get validation by ID
Risk: read
await corsair.digicert.api.contentTrustApi.getValidation({
path: { validationId: 'example' },
query: { account_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
validationId: string
}
query full type
query full type
{
account_id: string
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
created_by | string | No | — |
modified_on | string | No | — |
modified_by | string | No | — |
created_on | string | No | — |
validation_id | string | No | — |
validation_entity | string | No | — |
validation_entity_type | string | No | — |
validation_type | string | No | — |
validation_method | string | No | — |
validation_status | VALIDATION_CREATED | VALIDATION_ERROR | INVITE_SENT | INVITE_FAILED | PENDING_IDENTITY_PROOFING | APPROVED | REJECTED | ABORTED | DOCUMENT_VERIFICATION_ERROR | REVIEW_PENDING | EXPIRED | PENDING_MANUAL_REVIEW | PENDING_SIGNER_APPROVAL | CANCELLED | No | — |
default_profile_id | string | No | — |
credential_profile_ids | string[] | No | — |
verifyid_transaction_id | string | No | — |
associated_users | object[] | No | — |
expiration_date | string | No | — |
expired | boolean | No | — |
rejection_status | string | No | — |
vetting_details | object | No | — |
validation_approvals | object[] | No | — |
validation_enrollment_id | string | No | — |
validation_profile_id | string | No | — |
failure_reason | string | No | — |
language_code | string | No | — |
auto_approval_enabled | boolean | No | — |
terms_and_conditions | string | No | — |
terms_acceptance_time | string | No | — |
client_data | string | No | — |
last_sent | string | No | — |
invites_number | number | No | — |
validation_profile | object | No | — |
cancelationReason | string | No | — |
bulk_onboarding_user_id | string | No | — |
legal_first_name | string | No | — |
legal_last_name | string | No | — |
account_id | string | No | — |
tags | object[] | No | — |
associated_users full type
associated_users full type
{
created_by?: string,
modified_on?: string,
modified_by?: string,
created_on?: string,
associate_user_id?: string,
email?: string,
phone?: string,
pending_user_creation?: boolean
}[]
vetting_details full type
vetting_details full type
{
first_name?: string,
last_name?: string,
common_name?: string,
country?: string,
document_type?: PASSPORT | DRIVER_LICENSE | ID_CARD,
document_id?: string,
date_issued?: string,
valid_until?: string,
nationality?: string,
ident_language?: string,
title?: string,
organization_uuid?: string,
organization?: string,
organization_identifier?: string,
organization_country?: string,
organization_unit?: string,
organization_state?: string,
organization_locality?: string,
phone?: string,
email?: string,
blocklist_transaction_number?: string,
partner_id?: string,
profession_validation_date?: string
}
validation_approvals full type
validation_approvals full type
{
id?: string,
validationId?: string,
reviewed_validation_status?: VALIDATION_CREATED | VALIDATION_ERROR | INVITE_SENT | INVITE_FAILED | PENDING_IDENTITY_PROOFING | APPROVED | REJECTED | ABORTED | DOCUMENT_VERIFICATION_ERROR | EXPIRED | PENDING_MANUAL_REVIEW | PENDING_SIGNER_APPROVAL | PENDING_ORG_REVIEW | DISABLED | CANCELLED,
status?: APPROVED | REJECTED | string,
reason?: string,
reason_code?: VALIDATION_IN_PROCESS | VALIDATION_COMPLETED,
userId?: string,
reviewed_on?: string,
reviewed_by?: string
}[]
validation_profile full type
validation_profile full type
{
id?: string,
credential_profile_ids?: string[],
default_credential_profile_id?: string,
validation_method?: f2f | remote | RA | manual | remote_manual,
validation_type?: advanced+ | qualified | basic | string,
nickname?: string,
policies?: {
name?: organization_details_required | title_detail_required | create_user | issue_credential | suppress_validation_approval_email | add_san_value_to_certificate | blocklist_transaction_number_required | allow_opt_out | register_notary_profession_validation | organization_identifier_required,
value?: boolean
}[],
status?: ACTIVE | DISABLED | string,
modified_on?: string,
created_by?: string,
created_on?: string,
modified_by?: string,
account_id?: string,
alternative_validation_profile_id?: string,
is_default_profile?: string,
organization_id?: string,
remote_identity_vendor?: AUTO_IDENT | VIDEO_IDENT,
product_type?: string,
organization_identifier?: string,
onboarding_credential_profile_id?: string
}
tags full type
tags full type
{
name?: string,
values?: string[]
}[]
getValidationDetails
contentTrustApi.getValidationDetails
Get user validation details
Risk: read
await corsair.digicert.api.contentTrustApi.getValidationDetails({
path: { userId: 'example' },
query: { account_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
userId: string
}
query full type
query full type
{
account_id: string
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
oauth_account_id | string | No | — |
sli | string | No | — |
bulk_onboarding_user_id | string | No | — |
oauth_account_cert_central_enabled | string | No | — |
validation_list | object[] | No | — |
validation_list full type
validation_list full type
{
validation_status?: VALIDATION_CREATED | VALIDATION_ERROR | INVITE_SENT | INVITE_FAILED | PENDING_IDENTITY_PROOFING | APPROVED | REJECTED | ABORTED | DOCUMENT_VERIFICATION_ERROR | REVIEW_PENDING | EXPIRED | PENDING_MANUAL_REVIEW | PENDING_SIGNER_APPROVAL | PENDING_ORG_REVIEW | DISABLED | CANCELLED,
validation_expiry_date?: string,
validation_type?: advanced+ | qualified | basic,
terms_and_conditions?: string,
terms_id?: string,
certificate?: {
subject_dn?: string,
validity?: string
},
default_profile_id?: string,
validation_id?: string,
validation_method?: f2f | remote | RA | manual | remote_manual,
ident_type?: AUTO_IDENT_ADVANCED | AUTO_IDENT_QUALIFIED | VIDEO_IDENT_QUALIFIED | AUTO_IDENT_BASIC | VIDEO_IDENT_BASIC | VIDEO_IDENT_ADVANCED_PLUS | VIDEO_IDENT_TEST_QUALIFIED | AUTO_IDENT_TEST_ADVANCED | AUTO_IDENT_TEST_QUALIFIED | AUTO_IDENT_TEST_BASIC | VIDEO_IDENT_TEST_BASIC | VIDEO_IDENT_TEST_ADVANCED_PLUS,
ident_id?: string,
oauth_account_id?: string,
client_data?: string,
sli?: string
}[]
invalidateValidation
contentTrustApi.invalidateValidation
Invalidate validation
Risk: destructive
await corsair.digicert.api.contentTrustApi.invalidateValidation({
path: { validationId: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
validationId: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account?: {
id: string,
name?: string
},
reason_code?: KEY_COMPROMISE | AFFILIATION_CHANGED | SUPERSEDED | CESSATION_OF_OPERATION
}
| Name | Type | Required | Description |
|---|---|---|---|
created_by | string | No | — |
modified_on | string | No | — |
modified_by | string | No | — |
created_on | string | No | — |
validation_id | string | No | — |
validation_entity | string | No | — |
validation_entity_type | string | No | — |
validation_type | string | No | — |
validation_method | string | No | — |
validation_status | VALIDATION_CREATED | VALIDATION_ERROR | INVITE_SENT | INVITE_FAILED | PENDING_IDENTITY_PROOFING | APPROVED | REJECTED | ABORTED | DOCUMENT_VERIFICATION_ERROR | REVIEW_PENDING | EXPIRED | PENDING_MANUAL_REVIEW | PENDING_SIGNER_APPROVAL | CANCELLED | No | — |
default_profile_id | string | No | — |
credential_profile_ids | string[] | No | — |
verifyid_transaction_id | string | No | — |
associated_users | object[] | No | — |
expiration_date | string | No | — |
expired | boolean | No | — |
rejection_status | string | No | — |
vetting_details | object | No | — |
validation_approvals | object[] | No | — |
validation_enrollment_id | string | No | — |
validation_profile_id | string | No | — |
failure_reason | string | No | — |
language_code | string | No | — |
auto_approval_enabled | boolean | No | — |
terms_and_conditions | string | No | — |
terms_acceptance_time | string | No | — |
client_data | string | No | — |
last_sent | string | No | — |
invites_number | number | No | — |
validation_profile | object | No | — |
cancelationReason | string | No | — |
bulk_onboarding_user_id | string | No | — |
legal_first_name | string | No | — |
legal_last_name | string | No | — |
account_id | string | No | — |
associated_users full type
associated_users full type
{
created_by?: string,
modified_on?: string,
modified_by?: string,
created_on?: string,
associate_user_id?: string,
email?: string,
phone?: string,
pending_user_creation?: boolean
}[]
vetting_details full type
vetting_details full type
{
first_name?: string,
last_name?: string,
common_name?: string,
country?: string,
document_type?: PASSPORT | DRIVER_LICENSE | ID_CARD,
document_id?: string,
date_issued?: string,
valid_until?: string,
nationality?: string,
ident_language?: string,
title?: string,
organization_uuid?: string,
organization?: string,
organization_identifier?: string,
organization_country?: string,
organization_unit?: string,
organization_state?: string,
organization_locality?: string,
phone?: string,
email?: string,
blocklist_transaction_number?: string,
partner_id?: string,
profession_validation_date?: string
}
validation_approvals full type
validation_approvals full type
{
id?: string,
validationId?: string,
reviewed_validation_status?: VALIDATION_CREATED | VALIDATION_ERROR | INVITE_SENT | INVITE_FAILED | PENDING_IDENTITY_PROOFING | APPROVED | REJECTED | ABORTED | DOCUMENT_VERIFICATION_ERROR | EXPIRED | PENDING_MANUAL_REVIEW | PENDING_SIGNER_APPROVAL | PENDING_ORG_REVIEW | DISABLED | CANCELLED,
status?: APPROVED | REJECTED | string,
reason?: string,
reason_code?: VALIDATION_IN_PROCESS | VALIDATION_COMPLETED,
userId?: string,
reviewed_on?: string,
reviewed_by?: string
}[]
validation_profile full type
validation_profile full type
{
id?: string,
credential_profile_ids?: string[],
default_credential_profile_id?: string,
validation_method?: f2f | remote | RA | manual | remote_manual,
validation_type?: advanced+ | qualified | basic | string,
nickname?: string,
policies?: {
name?: organization_details_required | title_detail_required | create_user | issue_credential | suppress_validation_approval_email | add_san_value_to_certificate | blocklist_transaction_number_required | allow_opt_out | register_notary_profession_validation | organization_identifier_required,
value?: boolean
}[],
status?: ACTIVE | DISABLED | string,
modified_on?: string,
created_by?: string,
created_on?: string,
modified_by?: string,
account_id?: string,
alternative_validation_profile_id?: string,
is_default_profile?: string,
organization_id?: string,
remote_identity_vendor?: AUTO_IDENT | VIDEO_IDENT,
product_type?: string,
organization_identifier?: string,
onboarding_credential_profile_id?: string
}
listAuditLogsWithCursor
contentTrustApi.listAuditLogsWithCursor
List audit logs using cursor pagination
Risk: read
await corsair.digicert.api.contentTrustApi.listAuditLogsWithCursor({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
cursor_timestamp?: string,
cursor_id?: string,
limit?: number,
direction?: NEXT | PREVIOUS,
sort_by?: timestamp,
sort_order?: ASC | DESC,
id?: string,
action?: SIGN | UPDATE | ENABLE | DISABLE | CREATE | DELETE | EMAIL_SENT | FETCH | AUTHORIZE | SEND_OTP | REVOKE | VERIFY | LIST,
resource_type?: VALIDATION | SIGNATURE | LICENSE | CREDENTIAL | TIMESTAMP | MANAGER_CONFIG | DSE_ACCOUNT | DSE_PROFILE | CERTIFICATE_PROFILE | SIGNING_PROVIDER | DOCUMENT | CERTIFICATE | SELF_ENROLLMENT_LINK | VALIDATION_PROFILE | DSM_CERTIFICATE_TEMPLATE | DSM_CERTIFICATE_PROFILE | MIGRATION | PRODUCT | ONBOARDING | SIGNER | USER,
resource_id?: string,
account_id?: string,
user_id?: string,
start_date?: string,
end_date?: string,
status?: SUCCESS | FAILURE,
created_by?: string,
certificate_type?: (ESEAL | INDIVIDUAL | INDIVIDUAL_WITH_ORGANIZATION | PROFESSIONAL | CLIENT_AUTHENTICATION)[],
certificate_level?: (ADVANCED_PLUS | QUALIFIED | BASIC)[]
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
data | object[] | No | — |
pagination | object | No | — |
data full type
data full type
{
id?: string,
account_id?: string,
resource_type?: VALIDATION | SIGNATURE | LICENSE | CREDENTIAL | TIMESTAMP | MANAGER_CONFIG | DSE_ACCOUNT | DSE_PROFILE | CERTIFICATE_PROFILE | SIGNING_PROVIDER | DOCUMENT | CERTIFICATE | SELF_ENROLLMENT_LINK | VALIDATION_PROFILE | DSM_CERTIFICATE_TEMPLATE | DSM_CERTIFICATE_PROFILE | MIGRATION | PRODUCT | ONBOARDING | SIGNER | USER,
resource_id?: string,
action?: SIGN | UPDATE | CREATE | DELETE | EMAIL_SENT | FETCH | AUTHORIZE | SEND_OTP | ENABLE | DISABLE | CANCEL | REVOKE | SIGNING_HUB_USER_CREATION | HASH_ENHANCEMENT | SIGNATURE_ENHANCEMENT,
auth_type?: BASIC | API_TOKEN | INTERNAL | string,
timestamp?: string,
description?: string,
status?: SUCCESS | FAILURE | string,
error_message?: string,
data?: string,
userId?: string,
created_by?: string,
hash?: string,
number_hashes?: number,
license_hash_enabled?: boolean,
certificateLevel?: ADVANCED_PLUS | QUALIFIED | BASIC,
certificateType?: ESEAL | INDIVIDUAL | INDIVIDUAL_WITH_ORGANIZATION | PROFESSIONAL | CLIENT_AUTHENTICATION
}[]
pagination full type
pagination full type
{
count?: number,
limit?: number,
has_next?: boolean,
has_previous?: boolean,
next_cursor_timestamp?: string,
next_cursor_id?: string,
previous_cursor_timestamp?: string,
previous_cursor_id?: string
}
listCredentials
contentTrustApi.listCredentials
List user credentials
Risk: write
await corsair.digicert.api.contentTrustApi.listCredentials({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
userID: string,
clientData?: string,
pageToken?: string,
maxResults?: number
}
| Name | Type | Required | Description |
|---|---|---|---|
nextPageToken | string | No | — |
credentialIDs | string[] | No | — |
listCredentials1
contentTrustApi.listCredentials1
List user credentials
Risk: write
await corsair.digicert.api.contentTrustApi.listCredentials1({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
userID: string,
clientData?: string,
pageToken?: string,
maxResults?: number
}
| Name | Type | Required | Description |
|---|---|---|---|
nextPageToken | string | No | — |
credentialIDs | string[] | No | — |
listValidations
contentTrustApi.listValidations
List validations
Risk: read
await corsair.digicert.api.contentTrustApi.listValidations({
query: { account_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
account_id: string,
Paging parameters?: {
offset?: number,
limit?: number,
sort?: string[]
},
Search parameters?: {
id?: string,
email?: string,
validation_entity_type?: string,
validation_type?: string,
validation_method?: f2f | remote | RA | manual | remote_manual,
validation_status?: VALIDATION_CREATED | VALIDATION_ERROR | INVITE_SENT | INVITE_FAILED | PENDING_IDENTITY_PROOFING | APPROVED | REJECTED | ABORTED | DOCUMENT_VERIFICATION_ERROR | REVIEW_PENDING | EXPIRED | PENDING_MANUAL_REVIEW | PENDING_SIGNER_APPROVAL | PENDING_ORG_REVIEW | DISABLED | CANCELLED,
validation_entity?: string
}
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
total | number | No | — |
offset | number | No | — |
limit | number | No | — |
items | object[] | No | — |
items full type
items full type
{
created_by?: string,
modified_on?: string,
modified_by?: string,
created_on?: string,
validation_id?: string,
validation_entity?: string,
validation_entity_type?: string,
validation_type?: string,
validation_method?: string,
validation_status?: VALIDATION_CREATED | VALIDATION_ERROR | INVITE_SENT | INVITE_FAILED | PENDING_IDENTITY_PROOFING | APPROVED | REJECTED | ABORTED | DOCUMENT_VERIFICATION_ERROR | REVIEW_PENDING | EXPIRED | PENDING_MANUAL_REVIEW | PENDING_SIGNER_APPROVAL | CANCELLED,
default_profile_id?: string,
credential_profile_ids?: string[],
verifyid_transaction_id?: string,
associated_users?: {
created_by?: string,
modified_on?: string,
modified_by?: string,
created_on?: string,
associate_user_id?: string,
email?: string,
phone?: string,
pending_user_creation?: boolean
}[],
expiration_date?: string,
expired?: boolean,
rejection_status?: string,
vetting_details?: {
first_name?: string,
last_name?: string,
common_name?: string,
country?: string,
document_type?: PASSPORT | DRIVER_LICENSE | ID_CARD,
document_id?: string,
date_issued?: string,
valid_until?: string,
nationality?: string,
ident_language?: string,
title?: string,
organization_uuid?: string,
organization?: string,
organization_identifier?: string,
organization_country?: string,
organization_unit?: string,
organization_state?: string,
organization_locality?: string,
phone?: string,
email?: string,
blocklist_transaction_number?: string,
partner_id?: string,
profession_validation_date?: string
},
validation_approvals?: {
id?: string,
validationId?: string,
reviewed_validation_status?: VALIDATION_CREATED | VALIDATION_ERROR | INVITE_SENT | INVITE_FAILED | PENDING_IDENTITY_PROOFING | APPROVED | REJECTED | ABORTED | DOCUMENT_VERIFICATION_ERROR | EXPIRED | PENDING_MANUAL_REVIEW | PENDING_SIGNER_APPROVAL | PENDING_ORG_REVIEW | DISABLED | CANCELLED,
status?: APPROVED | REJECTED | string,
reason?: string,
reason_code?: VALIDATION_IN_PROCESS | VALIDATION_COMPLETED,
userId?: string,
reviewed_on?: string,
reviewed_by?: string
}[],
validation_enrollment_id?: string,
validation_profile_id?: string,
failure_reason?: string,
language_code?: string,
auto_approval_enabled?: boolean,
terms_and_conditions?: string,
terms_acceptance_time?: string,
client_data?: string,
last_sent?: string,
invites_number?: number,
validation_profile?: {
id?: string,
credential_profile_ids?: string[],
default_credential_profile_id?: string,
validation_method?: f2f | remote | RA | manual | remote_manual,
validation_type?: advanced+ | qualified | basic,
nickname?: string,
policies?: {
name?: organization_details_required | title_detail_required | create_user | issue_credential | suppress_validation_approval_email | add_san_value_to_certificate | blocklist_transaction_number_required | allow_opt_out | register_notary_profession_validation | organization_identifier_required,
value?: boolean
}[],
status?: ACTIVE | DISABLED | string,
modified_on?: string,
created_by?: string,
created_on?: string,
modified_by?: string,
account_id?: string,
alternative_validation_profile_id?: string,
is_default_profile?: string,
organization_id?: string,
remote_identity_vendor?: AUTO_IDENT | VIDEO_IDENT,
product_type?: string,
organization_identifier?: string,
onboarding_credential_profile_id?: string
},
cancelationReason?: string,
bulk_onboarding_user_id?: string,
legal_first_name?: string,
legal_last_name?: string,
account_id?: string,
tags?: {
name?: string,
values?: string[]
}[]
}[]
oauth2Token
contentTrustApi.oauth2Token
Get access token
Risk: write
await corsair.digicert.api.contentTrustApi.oauth2Token({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
grant_type: string,
code?: string,
client_id: string,
client_secret?: string,
redirect_uri?: string,
client_data?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
access_token | string | No | — |
refresh_token | string | No | — |
token_type | string | No | — |
expires_in | number | No | — |
oauth2Token1
contentTrustApi.oauth2Token1
Get access token
Risk: write
await corsair.digicert.api.contentTrustApi.oauth2Token1({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
grant_type: string,
code?: string,
client_id: string,
client_secret?: string,
redirect_uri?: string,
client_data?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
access_token | string | No | — |
refresh_token | string | No | — |
token_type | string | No | — |
expires_in | number | No | — |
reject
contentTrustApi.reject
Reject validation
Risk: write
await corsair.digicert.api.contentTrustApi.reject({
path: { validationId: 'example' },
query: { account_id: 'example' },
body: { reason: 'TECH_PHOTO' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
validationId: string
}
query full type
query full type
{
account_id: string
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
reason: TECH_PHOTO | TECH_HOLOGRAM | BAD_PHOTO_QUALITY | ID_NOT_SUPPORTED | USER_ID | ID_DAMAGED | ID_OTHER | USER_WRONG_PERSON | PHOTO_OTHER | OTHER_ERROR | WARNING_SOCIAL_ENGINEERING | WARNING_ID_MANIPULATION | FACE_COMPARISON_UNMATCHED | WARNING_FAKE_ID | WARNING_PHOTO | WARNING_DESCRIPTION | WARNING_USER_UNDERAGE | WARNING_INCONSISTENT_DATA | DOCUMENT_TAMPERED | WARNING_FAKED_MANIPULATED_ID | WARNING_FRAUD_OTHER | WARNING_WRONG_CHECKSUM | WARNING_IDENTITY_THEFT | SECURITY_FEATURE_IDENTITY_FAKED | LIVENESS_DETECTION_FAILED | SECURITY_FEATURE_DIGITAL_IMAGE\ | FRONT_DOCUMENT_DIGITAL_IMAGE | BACK_DOCUMENT_DIGITAL_IMAGE | FACE_COMPARISON_DIGITAL_IMAGE | LIVENESS_LEFT_DIGITAL_IMAGE | LIVENESS_RIGHT_DIGITAL_IMAGE
}
| Name | Type | Required | Description |
|---|---|---|---|
created_by | string | No | — |
modified_on | string | No | — |
modified_by | string | No | — |
created_on | string | No | — |
validation_id | string | No | — |
validation_entity | string | No | — |
validation_entity_type | string | No | — |
validation_type | string | No | — |
validation_method | string | No | — |
validation_status | VALIDATION_CREATED | VALIDATION_ERROR | INVITE_SENT | INVITE_FAILED | PENDING_IDENTITY_PROOFING | APPROVED | REJECTED | ABORTED | DOCUMENT_VERIFICATION_ERROR | REVIEW_PENDING | EXPIRED | PENDING_MANUAL_REVIEW | PENDING_SIGNER_APPROVAL | CANCELLED | No | — |
default_profile_id | string | No | — |
credential_profile_ids | string[] | No | — |
verifyid_transaction_id | string | No | — |
associated_users | object[] | No | — |
expiration_date | string | No | — |
expired | boolean | No | — |
rejection_status | string | No | — |
vetting_details | object | No | — |
validation_approvals | object[] | No | — |
validation_enrollment_id | string | No | — |
validation_profile_id | string | No | — |
failure_reason | string | No | — |
language_code | string | No | — |
auto_approval_enabled | boolean | No | — |
terms_and_conditions | string | No | — |
terms_acceptance_time | string | No | — |
client_data | string | No | — |
last_sent | string | No | — |
invites_number | number | No | — |
validation_profile | object | No | — |
cancelationReason | string | No | — |
bulk_onboarding_user_id | string | No | — |
legal_first_name | string | No | — |
legal_last_name | string | No | — |
account_id | string | No | — |
associated_users full type
associated_users full type
{
created_by?: string,
modified_on?: string,
modified_by?: string,
created_on?: string,
associate_user_id?: string,
email?: string,
phone?: string,
pending_user_creation?: boolean
}[]
vetting_details full type
vetting_details full type
{
first_name?: string,
last_name?: string,
common_name?: string,
country?: string,
document_type?: PASSPORT | DRIVER_LICENSE | ID_CARD,
document_id?: string,
date_issued?: string,
valid_until?: string,
nationality?: string,
ident_language?: string,
title?: string,
organization_uuid?: string,
organization?: string,
organization_identifier?: string,
organization_country?: string,
organization_unit?: string,
organization_state?: string,
organization_locality?: string,
phone?: string,
email?: string,
blocklist_transaction_number?: string,
partner_id?: string,
profession_validation_date?: string
}
validation_approvals full type
validation_approvals full type
{
id?: string,
validationId?: string,
reviewed_validation_status?: VALIDATION_CREATED | VALIDATION_ERROR | INVITE_SENT | INVITE_FAILED | PENDING_IDENTITY_PROOFING | APPROVED | REJECTED | ABORTED | DOCUMENT_VERIFICATION_ERROR | EXPIRED | PENDING_MANUAL_REVIEW | PENDING_SIGNER_APPROVAL | PENDING_ORG_REVIEW | DISABLED | CANCELLED,
status?: APPROVED | REJECTED | string,
reason?: string,
reason_code?: VALIDATION_IN_PROCESS | VALIDATION_COMPLETED,
userId?: string,
reviewed_on?: string,
reviewed_by?: string
}[]
validation_profile full type
validation_profile full type
{
id?: string,
credential_profile_ids?: string[],
default_credential_profile_id?: string,
validation_method?: f2f | remote | RA | manual | remote_manual,
validation_type?: advanced+ | qualified | basic | string,
nickname?: string,
policies?: {
name?: organization_details_required | title_detail_required | create_user | issue_credential | suppress_validation_approval_email | add_san_value_to_certificate | blocklist_transaction_number_required | allow_opt_out | register_notary_profession_validation | organization_identifier_required,
value?: boolean
}[],
status?: ACTIVE | DISABLED | string,
modified_on?: string,
created_by?: string,
created_on?: string,
modified_by?: string,
account_id?: string,
alternative_validation_profile_id?: string,
is_default_profile?: string,
organization_id?: string,
remote_identity_vendor?: AUTO_IDENT | VIDEO_IDENT,
product_type?: string,
organization_identifier?: string,
onboarding_credential_profile_id?: string
}
rejectPendingSignerApproval
contentTrustApi.rejectPendingSignerApproval
Reject self-enrolled user validation
Risk: write
await corsair.digicert.api.contentTrustApi.rejectPendingSignerApproval({
path: { validationId: 'example' },
body: { reason: 'VALIDATION_IN_PROCESS' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
validationId: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
reason: VALIDATION_IN_PROCESS | VALIDATION_COMPLETED | UNDEFINED
}
| Name | Type | Required | Description |
|---|---|---|---|
created_by | string | No | — |
modified_on | string | No | — |
modified_by | string | No | — |
created_on | string | No | — |
validation_id | string | No | — |
validation_entity | string | No | — |
validation_entity_type | string | No | — |
validation_type | string | No | — |
validation_method | string | No | — |
validation_status | VALIDATION_CREATED | VALIDATION_ERROR | INVITE_SENT | INVITE_FAILED | PENDING_IDENTITY_PROOFING | APPROVED | REJECTED | ABORTED | DOCUMENT_VERIFICATION_ERROR | REVIEW_PENDING | EXPIRED | PENDING_MANUAL_REVIEW | PENDING_SIGNER_APPROVAL | CANCELLED | No | — |
default_profile_id | string | No | — |
credential_profile_ids | string[] | No | — |
verifyid_transaction_id | string | No | — |
associated_users | object[] | No | — |
expiration_date | string | No | — |
expired | boolean | No | — |
rejection_status | string | No | — |
vetting_details | object | No | — |
validation_approvals | object[] | No | — |
validation_enrollment_id | string | No | — |
validation_profile_id | string | No | — |
failure_reason | string | No | — |
language_code | string | No | — |
auto_approval_enabled | boolean | No | — |
terms_and_conditions | string | No | — |
terms_acceptance_time | string | No | — |
client_data | string | No | — |
last_sent | string | No | — |
invites_number | number | No | — |
validation_profile | object | No | — |
cancelationReason | string | No | — |
bulk_onboarding_user_id | string | No | — |
legal_first_name | string | No | — |
legal_last_name | string | No | — |
account_id | string | No | — |
associated_users full type
associated_users full type
{
created_by?: string,
modified_on?: string,
modified_by?: string,
created_on?: string,
associate_user_id?: string,
email?: string,
phone?: string,
pending_user_creation?: boolean
}[]
vetting_details full type
vetting_details full type
{
first_name?: string,
last_name?: string,
common_name?: string,
country?: string,
document_type?: PASSPORT | DRIVER_LICENSE | ID_CARD,
document_id?: string,
date_issued?: string,
valid_until?: string,
nationality?: string,
ident_language?: string,
title?: string,
organization_uuid?: string,
organization?: string,
organization_identifier?: string,
organization_country?: string,
organization_unit?: string,
organization_state?: string,
organization_locality?: string,
phone?: string,
email?: string,
blocklist_transaction_number?: string,
partner_id?: string,
profession_validation_date?: string
}
validation_approvals full type
validation_approvals full type
{
id?: string,
validationId?: string,
reviewed_validation_status?: VALIDATION_CREATED | VALIDATION_ERROR | INVITE_SENT | INVITE_FAILED | PENDING_IDENTITY_PROOFING | APPROVED | REJECTED | ABORTED | DOCUMENT_VERIFICATION_ERROR | EXPIRED | PENDING_MANUAL_REVIEW | PENDING_SIGNER_APPROVAL | PENDING_ORG_REVIEW | DISABLED | CANCELLED,
status?: APPROVED | REJECTED | string,
reason?: string,
reason_code?: VALIDATION_IN_PROCESS | VALIDATION_COMPLETED,
userId?: string,
reviewed_on?: string,
reviewed_by?: string
}[]
validation_profile full type
validation_profile full type
{
id?: string,
credential_profile_ids?: string[],
default_credential_profile_id?: string,
validation_method?: f2f | remote | RA | manual | remote_manual,
validation_type?: advanced+ | qualified | basic | string,
nickname?: string,
policies?: {
name?: organization_details_required | title_detail_required | create_user | issue_credential | suppress_validation_approval_email | add_san_value_to_certificate | blocklist_transaction_number_required | allow_opt_out | register_notary_profession_validation | organization_identifier_required,
value?: boolean
}[],
status?: ACTIVE | DISABLED | string,
modified_on?: string,
created_by?: string,
created_on?: string,
modified_by?: string,
account_id?: string,
alternative_validation_profile_id?: string,
is_default_profile?: string,
organization_id?: string,
remote_identity_vendor?: AUTO_IDENT | VIDEO_IDENT,
product_type?: string,
organization_identifier?: string,
onboarding_credential_profile_id?: string
}
rejectValidationOrganization
contentTrustApi.rejectValidationOrganization
Reject organization details for a validation
Risk: write
await corsair.digicert.api.contentTrustApi.rejectValidationOrganization({
path: { validationId: 'example' },
body: { reason: 'TECH_PHOTO' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
validationId: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
reason: TECH_PHOTO | TECH_HOLOGRAM | BAD_PHOTO_QUALITY | ID_NOT_SUPPORTED | USER_ID | ID_DAMAGED | ID_OTHER | USER_WRONG_PERSON | PHOTO_OTHER | OTHER_ERROR | WARNING_SOCIAL_ENGINEERING | WARNING_ID_MANIPULATION | FACE_COMPARISON_UNMATCHED | WARNING_FAKE_ID | WARNING_PHOTO | WARNING_DESCRIPTION | WARNING_USER_UNDERAGE | WARNING_INCONSISTENT_DATA | DOCUMENT_TAMPERED | WARNING_FAKED_MANIPULATED_ID | WARNING_FRAUD_OTHER | WARNING_WRONG_CHECKSUM | WARNING_IDENTITY_THEFT | SECURITY_FEATURE_IDENTITY_FAKED | LIVENESS_DETECTION_FAILED | SECURITY_FEATURE_DIGITAL_IMAGE\ | FRONT_DOCUMENT_DIGITAL_IMAGE | BACK_DOCUMENT_DIGITAL_IMAGE | FACE_COMPARISON_DIGITAL_IMAGE | LIVENESS_LEFT_DIGITAL_IMAGE | LIVENESS_RIGHT_DIGITAL_IMAGE
}
| Name | Type | Required | Description |
|---|---|---|---|
created_by | string | No | — |
modified_on | string | No | — |
modified_by | string | No | — |
created_on | string | No | — |
validation_id | string | No | — |
validation_entity | string | No | — |
validation_entity_type | string | No | — |
validation_type | string | No | — |
validation_method | string | No | — |
validation_status | VALIDATION_CREATED | VALIDATION_ERROR | INVITE_SENT | INVITE_FAILED | PENDING_IDENTITY_PROOFING | APPROVED | REJECTED | ABORTED | DOCUMENT_VERIFICATION_ERROR | REVIEW_PENDING | EXPIRED | PENDING_MANUAL_REVIEW | PENDING_SIGNER_APPROVAL | CANCELLED | No | — |
default_profile_id | string | No | — |
credential_profile_ids | string[] | No | — |
verifyid_transaction_id | string | No | — |
associated_users | object[] | No | — |
expiration_date | string | No | — |
expired | boolean | No | — |
rejection_status | string | No | — |
vetting_details | object | No | — |
validation_approvals | object[] | No | — |
validation_enrollment_id | string | No | — |
validation_profile_id | string | No | — |
failure_reason | string | No | — |
language_code | string | No | — |
auto_approval_enabled | boolean | No | — |
terms_and_conditions | string | No | — |
terms_acceptance_time | string | No | — |
client_data | string | No | — |
last_sent | string | No | — |
invites_number | number | No | — |
validation_profile | object | No | — |
cancelationReason | string | No | — |
bulk_onboarding_user_id | string | No | — |
legal_first_name | string | No | — |
legal_last_name | string | No | — |
account_id | string | No | — |
associated_users full type
associated_users full type
{
created_by?: string,
modified_on?: string,
modified_by?: string,
created_on?: string,
associate_user_id?: string,
email?: string,
phone?: string,
pending_user_creation?: boolean
}[]
vetting_details full type
vetting_details full type
{
first_name?: string,
last_name?: string,
common_name?: string,
country?: string,
document_type?: PASSPORT | DRIVER_LICENSE | ID_CARD,
document_id?: string,
date_issued?: string,
valid_until?: string,
nationality?: string,
ident_language?: string,
title?: string,
organization_uuid?: string,
organization?: string,
organization_identifier?: string,
organization_country?: string,
organization_unit?: string,
organization_state?: string,
organization_locality?: string,
phone?: string,
email?: string,
blocklist_transaction_number?: string,
partner_id?: string,
profession_validation_date?: string
}
validation_approvals full type
validation_approvals full type
{
id?: string,
validationId?: string,
reviewed_validation_status?: VALIDATION_CREATED | VALIDATION_ERROR | INVITE_SENT | INVITE_FAILED | PENDING_IDENTITY_PROOFING | APPROVED | REJECTED | ABORTED | DOCUMENT_VERIFICATION_ERROR | EXPIRED | PENDING_MANUAL_REVIEW | PENDING_SIGNER_APPROVAL | PENDING_ORG_REVIEW | DISABLED | CANCELLED,
status?: APPROVED | REJECTED | string,
reason?: string,
reason_code?: VALIDATION_IN_PROCESS | VALIDATION_COMPLETED,
userId?: string,
reviewed_on?: string,
reviewed_by?: string
}[]
validation_profile full type
validation_profile full type
{
id?: string,
credential_profile_ids?: string[],
default_credential_profile_id?: string,
validation_method?: f2f | remote | RA | manual | remote_manual,
validation_type?: advanced+ | qualified | basic | string,
nickname?: string,
policies?: {
name?: organization_details_required | title_detail_required | create_user | issue_credential | suppress_validation_approval_email | add_san_value_to_certificate | blocklist_transaction_number_required | allow_opt_out | register_notary_profession_validation | organization_identifier_required,
value?: boolean
}[],
status?: ACTIVE | DISABLED | string,
modified_on?: string,
created_by?: string,
created_on?: string,
modified_by?: string,
account_id?: string,
alternative_validation_profile_id?: string,
is_default_profile?: string,
organization_id?: string,
remote_identity_vendor?: AUTO_IDENT | VIDEO_IDENT,
product_type?: string,
organization_identifier?: string,
onboarding_credential_profile_id?: string
}
replaceClientAdmin
contentTrustApi.replaceClientAdmin
Replace existing client admin user
Risk: write
await corsair.digicert.api.contentTrustApi.replaceClientAdmin({
path: { userId: 'example' },
body: {
email: 'jane.doe@example.com',
first_name: 'example',
last_name: 'example',
user_name: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
userId: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
email: string,
first_name: string,
last_name: string,
user_name: string,
phone_number?: string,
locale?: string,
description?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | string | No | — |
resendEmail
contentTrustApi.resendEmail
Resend validation email
Risk: destructive
await corsair.digicert.api.contentTrustApi.resendEmail({
path: { validationId: 'example' },
query: { account_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
validationId: string
}
query full type
query full type
{
account_id: string,
force?: boolean
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
created_by | string | No | — |
modified_on | string | No | — |
modified_by | string | No | — |
created_on | string | No | — |
validation_id | string | No | — |
validation_entity | string | No | — |
validation_entity_type | string | No | — |
validation_type | string | No | — |
validation_method | string | No | — |
validation_status | VALIDATION_CREATED | VALIDATION_ERROR | INVITE_SENT | INVITE_FAILED | PENDING_IDENTITY_PROOFING | APPROVED | REJECTED | ABORTED | DOCUMENT_VERIFICATION_ERROR | REVIEW_PENDING | EXPIRED | PENDING_MANUAL_REVIEW | PENDING_SIGNER_APPROVAL | CANCELLED | No | — |
default_profile_id | string | No | — |
credential_profile_ids | string[] | No | — |
verifyid_transaction_id | string | No | — |
associated_users | object[] | No | — |
expiration_date | string | No | — |
expired | boolean | No | — |
rejection_status | string | No | — |
vetting_details | object | No | — |
validation_approvals | object[] | No | — |
validation_enrollment_id | string | No | — |
validation_profile_id | string | No | — |
failure_reason | string | No | — |
language_code | string | No | — |
auto_approval_enabled | boolean | No | — |
terms_and_conditions | string | No | — |
terms_acceptance_time | string | No | — |
client_data | string | No | — |
last_sent | string | No | — |
invites_number | number | No | — |
validation_profile | object | No | — |
cancelationReason | string | No | — |
bulk_onboarding_user_id | string | No | — |
legal_first_name | string | No | — |
legal_last_name | string | No | — |
account_id | string | No | — |
associated_users full type
associated_users full type
{
created_by?: string,
modified_on?: string,
modified_by?: string,
created_on?: string,
associate_user_id?: string,
email?: string,
phone?: string,
pending_user_creation?: boolean
}[]
vetting_details full type
vetting_details full type
{
first_name?: string,
last_name?: string,
common_name?: string,
country?: string,
document_type?: PASSPORT | DRIVER_LICENSE | ID_CARD,
document_id?: string,
date_issued?: string,
valid_until?: string,
nationality?: string,
ident_language?: string,
title?: string,
organization_uuid?: string,
organization?: string,
organization_identifier?: string,
organization_country?: string,
organization_unit?: string,
organization_state?: string,
organization_locality?: string,
phone?: string,
email?: string,
blocklist_transaction_number?: string,
partner_id?: string,
profession_validation_date?: string
}
validation_approvals full type
validation_approvals full type
{
id?: string,
validationId?: string,
reviewed_validation_status?: VALIDATION_CREATED | VALIDATION_ERROR | INVITE_SENT | INVITE_FAILED | PENDING_IDENTITY_PROOFING | APPROVED | REJECTED | ABORTED | DOCUMENT_VERIFICATION_ERROR | EXPIRED | PENDING_MANUAL_REVIEW | PENDING_SIGNER_APPROVAL | PENDING_ORG_REVIEW | DISABLED | CANCELLED,
status?: APPROVED | REJECTED | string,
reason?: string,
reason_code?: VALIDATION_IN_PROCESS | VALIDATION_COMPLETED,
userId?: string,
reviewed_on?: string,
reviewed_by?: string
}[]
validation_profile full type
validation_profile full type
{
id?: string,
credential_profile_ids?: string[],
default_credential_profile_id?: string,
validation_method?: f2f | remote | RA | manual | remote_manual,
validation_type?: advanced+ | qualified | basic | string,
nickname?: string,
policies?: {
name?: organization_details_required | title_detail_required | create_user | issue_credential | suppress_validation_approval_email | add_san_value_to_certificate | blocklist_transaction_number_required | allow_opt_out | register_notary_profession_validation | organization_identifier_required,
value?: boolean
}[],
status?: ACTIVE | DISABLED | string,
modified_on?: string,
created_by?: string,
created_on?: string,
modified_by?: string,
account_id?: string,
alternative_validation_profile_id?: string,
is_default_profile?: string,
organization_id?: string,
remote_identity_vendor?: AUTO_IDENT | VIDEO_IDENT,
product_type?: string,
organization_identifier?: string,
onboarding_credential_profile_id?: string
}
retryValidation
contentTrustApi.retryValidation
Retries to create user and his first credential
Risk: write
await corsair.digicert.api.contentTrustApi.retryValidation({
path: { validationId: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
validationId: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
revalidate
contentTrustApi.revalidate
Re-initiate validation
Risk: write
await corsair.digicert.api.contentTrustApi.revalidate({
path: { validationId: 'example' },
query: { account_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
validationId: string
}
query full type
query full type
{
account_id: string
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
created_by | string | No | — |
modified_on | string | No | — |
modified_by | string | No | — |
created_on | string | No | — |
validation_id | string | No | — |
validation_entity | string | No | — |
validation_entity_type | string | No | — |
validation_type | string | No | — |
validation_method | string | No | — |
validation_status | VALIDATION_CREATED | VALIDATION_ERROR | INVITE_SENT | INVITE_FAILED | PENDING_IDENTITY_PROOFING | APPROVED | REJECTED | ABORTED | DOCUMENT_VERIFICATION_ERROR | REVIEW_PENDING | EXPIRED | PENDING_MANUAL_REVIEW | PENDING_SIGNER_APPROVAL | CANCELLED | No | — |
default_profile_id | string | No | — |
credential_profile_ids | string[] | No | — |
verifyid_transaction_id | string | No | — |
associated_users | object[] | No | — |
expiration_date | string | No | — |
expired | boolean | No | — |
rejection_status | string | No | — |
vetting_details | object | No | — |
validation_approvals | object[] | No | — |
validation_enrollment_id | string | No | — |
validation_profile_id | string | No | — |
failure_reason | string | No | — |
language_code | string | No | — |
auto_approval_enabled | boolean | No | — |
terms_and_conditions | string | No | — |
terms_acceptance_time | string | No | — |
client_data | string | No | — |
last_sent | string | No | — |
invites_number | number | No | — |
validation_profile | object | No | — |
cancelationReason | string | No | — |
bulk_onboarding_user_id | string | No | — |
legal_first_name | string | No | — |
legal_last_name | string | No | — |
account_id | string | No | — |
associated_users full type
associated_users full type
{
created_by?: string,
modified_on?: string,
modified_by?: string,
created_on?: string,
associate_user_id?: string,
email?: string,
phone?: string,
pending_user_creation?: boolean
}[]
vetting_details full type
vetting_details full type
{
first_name?: string,
last_name?: string,
common_name?: string,
country?: string,
document_type?: PASSPORT | DRIVER_LICENSE | ID_CARD,
document_id?: string,
date_issued?: string,
valid_until?: string,
nationality?: string,
ident_language?: string,
title?: string,
organization_uuid?: string,
organization?: string,
organization_identifier?: string,
organization_country?: string,
organization_unit?: string,
organization_state?: string,
organization_locality?: string,
phone?: string,
email?: string,
blocklist_transaction_number?: string,
partner_id?: string,
profession_validation_date?: string
}
validation_approvals full type
validation_approvals full type
{
id?: string,
validationId?: string,
reviewed_validation_status?: VALIDATION_CREATED | VALIDATION_ERROR | INVITE_SENT | INVITE_FAILED | PENDING_IDENTITY_PROOFING | APPROVED | REJECTED | ABORTED | DOCUMENT_VERIFICATION_ERROR | EXPIRED | PENDING_MANUAL_REVIEW | PENDING_SIGNER_APPROVAL | PENDING_ORG_REVIEW | DISABLED | CANCELLED,
status?: APPROVED | REJECTED | string,
reason?: string,
reason_code?: VALIDATION_IN_PROCESS | VALIDATION_COMPLETED,
userId?: string,
reviewed_on?: string,
reviewed_by?: string
}[]
validation_profile full type
validation_profile full type
{
id?: string,
credential_profile_ids?: string[],
default_credential_profile_id?: string,
validation_method?: f2f | remote | RA | manual | remote_manual,
validation_type?: advanced+ | qualified | basic | string,
nickname?: string,
policies?: {
name?: organization_details_required | title_detail_required | create_user | issue_credential | suppress_validation_approval_email | add_san_value_to_certificate | blocklist_transaction_number_required | allow_opt_out | register_notary_profession_validation | organization_identifier_required,
value?: boolean
}[],
status?: ACTIVE | DISABLED | string,
modified_on?: string,
created_by?: string,
created_on?: string,
modified_by?: string,
account_id?: string,
alternative_validation_profile_id?: string,
is_default_profile?: string,
organization_id?: string,
remote_identity_vendor?: AUTO_IDENT | VIDEO_IDENT,
product_type?: string,
organization_identifier?: string,
onboarding_credential_profile_id?: string
}
revokeCredentials
contentTrustApi.revokeCredentials
Revoke credentials
Risk: destructive
await corsair.digicert.api.contentTrustApi.revokeCredentials({
path: { name: 'example' },
query: { user_id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
name: string
}
query full type
query full type
{
user_id: string
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
reason: KEY_COMPROMISE | AFFILIATION_CHANGED | SUPERSEDED | CESSATION_OF_OPERATION
}
| Name | Type | Required | Description |
|---|---|---|---|
created_by | string | No | — |
modified_on | string | No | — |
modified_by | string | No | — |
created_on | string | No | — |
credential_id | string | No | — |
label | string | No | — |
key_algorithm | string | No | — |
key_size | number | No | — |
status | string | No | — |
profile_id | string | No | — |
userId | string | No | — |
revokeToken
contentTrustApi.revokeToken
Revokes the access token
Risk: destructive
await corsair.digicert.api.contentTrustApi.revokeToken({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
token: string,
token_type_hint?: string,
client_data?: string
}
undefined
revokeToken1
contentTrustApi.revokeToken1
Revokes the access token
Risk: destructive
await corsair.digicert.api.contentTrustApi.revokeToken1({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
token: string,
token_type_hint?: string,
client_data?: string
}
undefined
setupAccount
contentTrustApi.setupAccount
Setup new onboarding account.
Risk: write
await corsair.digicert.api.contentTrustApi.setupAccount({
body: {
account_name: 'example',
locale: 'example',
is_delegated: true,
admin_user: {
first_name: 'example',
last_name: 'example',
email: 'jane.doe@example.com',
user_name: 'example',
phone_number: 'example',
locale: 'example',
id: 'example',
},
service_user: { email: 'jane.doe@example.com' },
organization_details: {
name: 'example',
address: 'example',
address2: 'example',
country: 'example',
organization_contact: {
first_name: 'example',
last_name: 'example',
email: 'jane.doe@example.com',
job_title: 'example',
telephone: 'example',
},
authorized_representative: [{
first_name: 'example',
last_name: 'example',
email: 'jane.doe@example.com',
job_title: 'example',
telephone: 'example',
}],
},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account_name: string,
locale: string,
is_delegated: boolean,
admin_user: {
first_name: string,
last_name: string,
email: string,
user_name: string,
phone_number: string,
locale: string,
id: string
},
service_user: {
email: string
},
organization_details: {
id?: string,
name: string,
address: string,
address2: string,
zip?: string,
city?: string,
state?: string,
country: string,
telephone?: string,
organization_contact: {
first_name: string,
last_name: string,
email: string,
job_title: string,
telephone: string
},
authorized_representative: {
first_name: string,
last_name: string,
email: string,
job_title: string,
telephone: string
}[],
organization_identifier?: string
},
sso_configuration?: {
authorization_endpoint?: string,
token_endpoint?: string,
jwks_endpoint?: string,
client_id?: string,
client_secret?: string,
token_audience?: string,
token_issuer?: string
}
}
| Name | Type | Required | Description |
|---|---|---|---|
id | string | No | — |
service_user | object | No | — |
admin_user | object | No | — |
products | string[] | No | — |
account_id | string | No | — |
organization | object | No | — |
sso_configuration | object | No | — |
service_user full type
service_user full type
{
api_key?: string,
id?: string
}
admin_user full type
admin_user full type
{
api_key?: string,
id?: string
}
organization full type
organization full type
{
id?: number,
status?: string,
display_name?: string,
name?: string,
address?: string,
address2?: string,
zip?: string,
city?: string,
state?: string,
country?: string
}
sso_configuration full type
sso_configuration full type
{
callback_url?: string,
login_initiation_endpoint?: string,
logout_endpoint?: string
}
signHash
contentTrustApi.signHash
Sign hash
Risk: write
await corsair.digicert.api.contentTrustApi.signHash({
body: {
hash: ['example'],
signAlgo: 'example',
credentialID: 'example',
SAD: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
hash: string[],
hashAlgo?: string,
signAlgo: string,
signAlgoParams?: string,
clientData?: string,
credentialID: string,
SAD: string
}
| Name | Type | Required | Description |
|---|---|---|---|
signatures | string[] | No | — |
signHash1
contentTrustApi.signHash1
Sign hash
Risk: write
await corsair.digicert.api.contentTrustApi.signHash1({
body: {
hash: ['example'],
signAlgo: 'example',
credentialID: 'example',
SAD: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
hash: string[],
hashAlgo?: string,
signAlgo: string,
signAlgoParams?: string,
clientData?: string,
credentialID: string,
SAD: string
}
| Name | Type | Required | Description |
|---|---|---|---|
signatures | string[] | No | — |
timeStampToken
contentTrustApi.timeStampToken
Create hash timestamp
Risk: write
await corsair.digicert.api.contentTrustApi.timeStampToken({
body: { hash: 'example', hashAlgo: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
nonce?: string,
clientData?: string,
hash: string,
hashAlgo: string
}
string
timeStampToken1
contentTrustApi.timeStampToken1
Create hash timestamp
Risk: write
await corsair.digicert.api.contentTrustApi.timeStampToken1({
body: { hash: 'example', hashAlgo: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
nonce?: string,
clientData?: string,
hash: string,
hashAlgo: string
}
string
updateAccount
contentTrustApi.updateAccount
update the onboarded sub-account
Risk: write
await corsair.digicert.api.contentTrustApi.updateAccount({
path: { onboardingId: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
onboardingId: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
organization_details?: {
id?: string,
name: string,
address: string,
address2: string,
zip?: string,
city?: string,
state?: string,
country: string,
telephone?: string,
organization_contact: {
first_name: string,
last_name: string,
email: string,
job_title: string,
telephone: string
},
authorized_representative: {
first_name: string,
last_name: string,
email: string,
job_title: string,
telephone: string
}[],
organization_identifier?: string
}
}
| Name | Type | Required | Description |
|---|---|---|---|
id | string | No | — |
service_user | object | No | — |
admin_user | object | No | — |
products | string[] | No | — |
account_id | string | No | — |
organization | object | No | — |
sso_configuration | object | No | — |
service_user full type
service_user full type
{
api_key?: string,
id?: string
}
admin_user full type
admin_user full type
{
api_key?: string,
id?: string
}
organization full type
organization full type
{
id?: number,
status?: string,
display_name?: string,
name?: string,
address?: string,
address2?: string,
zip?: string,
city?: string,
state?: string,
country?: string
}
sso_configuration full type
sso_configuration full type
{
callback_url?: string,
login_initiation_endpoint?: string,
logout_endpoint?: string
}
updateCredential
contentTrustApi.updateCredential
Update credential
Risk: write
await corsair.digicert.api.contentTrustApi.updateCredential({
path: { credentialId: 'example' },
query: { user_id: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
credentialId: string
}
query full type
query full type
{
user_id: string
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account?: {
id: string,
name?: string
},
label?: string
}
undefined
updateUserData
contentTrustApi.updateUserData
Update user auth data like mobile or secret
Risk: write
await corsair.digicert.api.contentTrustApi.updateUserData({
path: { userId: 'example' },
body: {
account: { id: 'example' },
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
userId: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account: {
id: string,
name?: string
},
phone_number?: string,
email?: string,
first_name?: string,
last_name?: string,
locale?: string
}
undefined
verifyAuditLog
contentTrustApi.verifyAuditLog
Verify audit log
Risk: read
await corsair.digicert.api.contentTrustApi.verifyAuditLog({
path: { id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
calculated_hash | string | No | — |
stored_hash | string | No | — |
status | SUCCESS | FAILURE | string | No | — |
Custom Reports
orderById
customReports.orderById
Query one CertCentral certificate order by ID through Custom Reports GraphQL.
Risk: read
await corsair.digicert.api.customReports.orderById({ id: 123, fields: ['id', 'common_name', 'status'] });
| Name | Type | Required | Description |
|---|---|---|---|
id | number | Yes | — |
fields | (account_id | additional_emails | agreement_id | auto_renew | ca_cert_id | certificate_tracker_id | common_name | contacts_email | container_id | container_name | cost | csr | custom_renewal_message | customer_order_id | date_created | dcv_method | disable_issuance_email | disable_renewal_notifications | dns_names | email | firstname | has_duplicates | id | is_out_of_contract | is_renewed | issuer_common_name | job_title | lastname | locale | metadata | org_addr1 | org_addr2 | organization_city | organization_country | organization_id | organization_name | organization_state | organization_unit | pay_type | plus_feature | product_id | product_name | product_name_id | product_type | purchased_dns_names | receipt_id | Renewed | renewed_order_id | serial_number | server_platform_id | signature_hash | status | telephone | thumbprint | user_assignments | user_email | user_first_name | user_id | user_last_name | valid_from | valid_till | validity_years)[] | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
data | object | Yes | — |
data full type
data full type
{
order_details_by_id: Record<string, JsonValue> | null
}
orders
customReports.orders
Query CertCentral certificate order details through Custom Reports GraphQL.
Risk: read
await corsair.digicert.api.customReports.orders({ fields: ['id', 'status'], status: 'issued', limit: 5 });
| Name | Type | Required | Description |
|---|---|---|---|
fields | (account_id | additional_emails | agreement_id | auto_renew | ca_cert_id | certificate_tracker_id | common_name | contacts_email | container_id | container_name | cost | csr | custom_renewal_message | customer_order_id | date_created | dcv_method | disable_issuance_email | disable_renewal_notifications | dns_names | email | firstname | has_duplicates | id | is_out_of_contract | is_renewed | issuer_common_name | job_title | lastname | locale | metadata | org_addr1 | org_addr2 | organization_city | organization_country | organization_id | organization_name | organization_state | organization_unit | pay_type | plus_feature | product_id | product_name | product_name_id | product_type | purchased_dns_names | receipt_id | Renewed | renewed_order_id | serial_number | server_platform_id | signature_hash | status | telephone | thumbprint | user_assignments | user_email | user_first_name | user_id | user_last_name | valid_from | valid_till | validity_years)[] | Yes | — |
id | number | No | — |
status | string | No | — |
valid_from | string | No | — |
valid_till | string | No | — |
container_id | string | No | — |
organization_id | string | No | — |
product_name_id | string | No | — |
serial_number | string | No | — |
signature_hash | string | No | — |
user_id | string | No | — |
date_created | string | No | — |
ca_cert_id | string | No | — |
common_name | string | No | — |
dns_names | string | No | — |
locale | string | No | — |
thumbprint | string | No | — |
email | string | No | — |
search | string | No | — |
sort | [valid_till | container_id | organization_id | product_name_id | serial_number | signature_hash | user_id | date_created | ca_cert_id | common_name | dns_names | locale | thumbprint | email, ASC | DESC] | No | — |
offset | number | No | — |
limit | number | No | — |
fields; pagination and filters are serialized into the documented GraphQL query.
Output
| Name | Type | Required | Description |
|---|---|---|---|
data | object | Yes | — |
data full type
data full type
{
order_details: Record<string, JsonValue>[]
}
Orders
list
orders.list
List CertCentral certificate orders.
Risk: read
await corsair.digicert.api.orders.list({});
| Name | Type | Required | Description |
|---|---|---|---|
filters | object | No | — |
sort | string | No | — |
offset | number | No | — |
limit | number | No | — |
filters full type
filters full type
{
id?: string,
status?: pending | issued | rejected | revoked | waiting_pickup | reissue_pending | canceled | active_issued,
organization_id?: string,
product_name_id?: string,
valid_till?: string,
user_id?: string,
common_name?: string,
domain_name?: string,
date_created?: string,
container_id?: string,
is_renewed?: 0 | 1,
disable_renewal_notifications?: 0 | 1,
email?: string,
certificate_id?: string,
origin?: certcentral | migrated,
serial_number?: string,
search?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
orders | object[] | Yes | — |
page | object | Yes | — |
orders full type
orders full type
{
id: number,
certificate?: {
id: number,
common_name: string,
dns_names?: string[],
valid_till?: string,
days_remaining?: number,
signature_hash?: string
},
status: string,
is_renewed?: boolean,
date_created?: string,
organization?: {
id: number,
name: string
} | never[],
validity_years?: number,
disable_renewal_notifications?: boolean,
container?: {
id: number,
name: string
},
product?: {
name_id: string,
name: string,
type: string
},
has_duplicates?: boolean,
product_name_id?: string
}[]
page full type
page full type
{
total: number,
limit: number,
offset: number
}
Organizations
list
organizations.list
List CertCentral organizations.
Risk: read
await corsair.digicert.api.organizations.list({});
| Name | Type | Required | Description |
|---|---|---|---|
include_validation | boolean | No | — |
filters | object | No | — |
sort | string | No | — |
limit | number | No | — |
offset | number | No | — |
include_validation adds validation-related response fields.
filters full type
filters full type
{
status?: active | inactive,
validation?: pending | not_pending,
container_id_for_organization?: string,
search?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
organizations | object[] | Yes | — |
page | object | Yes | — |
organizations full type
organizations full type
{
id: number,
status: string,
name: string,
display_name?: string,
is_active: boolean,
address?: string,
address2?: string,
zip?: string,
city?: string,
state?: string,
country?: string,
telephone?: string,
container?: {
id: number,
parent_id: number,
name: string,
is_active: boolean
},
container_id_assignments?: string[]
}[]
page full type
page full type
{
total: number,
limit: number,
offset: number
}
Private CA
helper
privateCA.helper
Read DigiCert Private CA application helper version information.
Risk: read
await corsair.digicert.api.privateCA.helper({});
digicert_one_api_key, sent as x-api-key.
Output
| Name | Type | Required | Description |
|---|---|---|---|
version | string | Yes | — |
verifyTemplate
privateCA.verifyTemplate
Validate a DigiCert Private CA template payload without creating it.
Risk: read
await corsair.digicert.api.privateCA.verifyTemplate({ template: '{"name":"TLS"}' });
| Name | Type | Required | Description |
|---|---|---|---|
template | string | Yes | — |
undefined
Private CAApi
deleteDeleteACertificateChain
privateCAApi.deleteDeleteACertificateChain
Delete a certificate chain
Risk: destructive
await corsair.digicert.api.privateCAApi.deleteDeleteACertificateChain({
path: { id: 'example', chainID: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string,
chainID: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
deleteDeleteCaAccounts
privateCAApi.deleteDeleteCaAccounts
Delete CA Accounts
Risk: destructive
await corsair.digicert.api.privateCAApi.deleteDeleteCaAccounts({
path: { id: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
accounts?: string[]
}
undefined
deleteDeleteSamlConfiguration
privateCAApi.deleteDeleteSamlConfiguration
Delete SAML Configuration
Risk: destructive
await corsair.digicert.api.privateCAApi.deleteDeleteSamlConfiguration({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
message | string | No | — |
deleteDeletesAPendingSignCa
privateCAApi.deleteDeletesAPendingSignCa
Deletes a pending sign CA
Risk: destructive
await corsair.digicert.api.privateCAApi.deleteDeletesAPendingSignCa({
path: { id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
getCheckAnalyticsConfiguration
privateCAApi.getCheckAnalyticsConfiguration
Check analytics configuration
Risk: read
await corsair.digicert.api.privateCAApi.getCheckAnalyticsConfiguration({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
enabled | boolean | No | — |
script | string | No | — |
getCheckIfSamlIsEnabled
privateCAApi.getCheckIfSamlIsEnabled
Check if SAML is enabled
Risk: read
await corsair.digicert.api.privateCAApi.getCheckIfSamlIsEnabled({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
enabled | boolean | No | — |
getDownloadACa
privateCAApi.getDownloadACa
Download a CA
Risk: read
await corsair.digicert.api.privateCAApi.getDownloadACa({
path: { id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string
}
query full type
query full type
{
format?: string
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
number[]
getDownloadAnOcspResponderCsr
privateCAApi.getDownloadAnOcspResponderCsr
Download an OCSP responder CSR
Risk: read
await corsair.digicert.api.privateCAApi.getDownloadAnOcspResponderCsr({
path: { id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
csr | string | No | — |
getGetAAccountsCertificateTemplateIsAssignedTo
privateCAApi.getGetAAccountsCertificateTemplateIsAssignedTo
Get a accounts certificate template is assigned to
Risk: read
await corsair.digicert.api.privateCAApi.getGetAAccountsCertificateTemplateIsAssignedTo({
path: { id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | string | No | — |
name | string | No | — |
getGetACa
privateCAApi.getGetACa
Get a CA
Risk: read
await corsair.digicert.api.privateCAApi.getGetACa({
path: { id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
account_assignments | object[] | No | — |
active_aia_issuer | object | No | — |
active_arl | object | No | — |
active_crl | object | No | — |
active_crl_cdps | object | No | — |
active_eerl | object | No | — |
allow_unmatched_cdp | boolean | No | — |
blob | string | No | — |
ca_type | string | No | — |
cert_type | string | No | — |
configuration | object | No | — |
create_default_aia_issuer | boolean | No | — |
create_default_crl | boolean | No | — |
create_preview_cert | boolean | No | — |
csr | string | No | — |
exportable | boolean | No | — |
extensions | object | No | — |
hosted_type | online | offline | external | third_party | No | — |
hsm_key_label | string | No | — |
hsm_partition | object | No | — |
id | string | No | — |
is_composite_ca | boolean | No | — |
issue_types | string[] | No | — |
issuer | object | No | — |
key_generation | object | No | — |
key_type | rsa | ecc | string | No | — |
name | string | No | — |
notification | object | No | — |
number_of_ica | number | No | — |
pem | string | No | — |
private_key | object | No | — |
recertification_links | object[] | No | — |
reinstate_requests | object[] | No | — |
revocation | object | No | — |
revocation_requests | object[] | No | — |
serial_number | string | No | — |
signature_algorithm | string | No | — |
status | active | pending_sign | disabled | string | No | — |
subject | object | No | — |
template | string | No | — |
template_id | string | No | — |
thumbprint_sha256 | string | No | — |
trust_type | string | No | — |
trust_types | string[] | No | — |
validity | object | No | — |
account_assignments full type
account_assignments full type
{
id?: string,
name?: string
}[]
active_aia_issuer full type
active_aia_issuer full type
{
file_name?: string,
id?: string
}
active_arl full type
active_arl full type
{
file_name?: string,
file_path?: string,
id?: string
}
active_crl full type
active_crl full type
{
file_name?: string,
file_path?: string,
id?: string
}
active_crl_cdps full type
active_crl_cdps full type
{
cdps?: string[]
}
active_eerl full type
active_eerl full type
{
file_name?: string,
file_path?: string,
id?: string
}
configuration full type
configuration full type
{
aia_issuer?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap | string,
type?: string[]
}[],
include?: string,
override_global?: boolean
},
allow_extended_validity?: boolean,
allow_pkcs7_operations?: boolean,
allowed_signature_algorithms?: string[],
available_signature_algorithms?: string[],
certificate_policies?: {
allowed_sources?: string[],
default_policies?: {
critical?: boolean,
policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[]
},
include?: string,
override_global?: boolean
},
chains?: {
certificates?: {
blob?: string,
cert_type?: string,
subject?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
}[],
default?: boolean,
id?: string,
name?: string
}[],
crl?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap | string,
type?: string[]
}[],
end_validity_years?: number,
include?: string,
override_global?: boolean
},
include_all_certificates_in_crl?: boolean,
issue_end_entities?: boolean,
issue_ica_intermediates?: boolean,
issue_types?: string[],
issue_unmanaged_ca?: boolean,
ocsp?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap | string,
type?: string[]
}[],
include?: string,
override_global?: boolean,
uri_path?: string
},
ocsp_responder?: {
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
certificate_template?: {
access?: string,
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
category?: string,
cert_type?: root | intermediate | end_entity,
created_date?: string,
id?: string,
install_type?: string,
issue_types?: string[],
kind?: string,
name?: string,
template_json?: string,
trust_type?: string,
updated_date?: string
},
delete_expired_responders?: boolean,
generation_enabled?: boolean,
hsm_partition?: {
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
},
override_global?: boolean,
responder_create_within_days?: number,
responder_validity_days?: number
}
}
extensions full type
extensions full type
{
adobe_archive_rev_info?: {
version?: number
},
adobe_timestamp?: {
location?: string,
requires_auth?: boolean,
version?: number
},
aia?: {
issuer_urls?: string[]
},
aki?: {
authority_name_serial_number?: boolean,
include?: string,
key_identifier?: boolean
},
basic_constraints?: {
ca?: boolean,
critical?: boolean,
path_length?: number
},
cabf_organization_identifier?: {
country?: string,
reference?: string,
scheme?: string,
state?: string
},
cdp?: {
urls?: string[]
},
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
extended_key_usage?: {
additional_values?: string[],
critical?: boolean
},
extensions_order?: string[],
issuer_alt_name?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
key_usage?: {
additional_values?: string[],
critical?: boolean,
skip_validation?: boolean
},
lei?: {
value?: string
},
lei_role?: {
value?: string
},
microsoft_application_certificate_policies?: {
additional_values?: string[],
critical?: boolean
},
microsoft_certificate_template_name?: string,
microsoft_certificate_template_v2?: {
major_version?: number,
minor_version?: number,
oid?: string
},
private_key_usage_period?: {
critical?: any,
not_after?: string,
not_before?: string
},
qc_statements?: {
critical?: boolean,
etsi-psd2-qcStatement?: string[],
id-etsi-qcs-QcPDS?: {
language?: string,
uri?: string
}[],
id-etsi-qcs-QcRetentionPeriod?: number,
id-etsi-qcs-QcType?: string[],
id-qcs-pkixQCSyntax-v2?: {
semantics_id?: string
},
oids?: string[]
},
san?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
security_identifier?: {
oid?: string,
value?: string
}[],
ski?: {
include?: string,
method?: string
},
ski_extension?: string,
smime_capabilities?: {
values?: string[]
},
subject_directory_attributes?: {
encoded_value?: number[]
}
}
hsm_partition full type
hsm_partition full type
{
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
}
issuer full type
issuer full type
{
hosted_type?: online | offline | third_party | string,
id?: string,
name?: string,
valid_from?: string,
valid_to?: string
}
key_generation full type
key_generation full type
{
dilithium_key_size?: string,
ecc_curve?: string,
ecdsa_curve?: string,
falcon_key_size?: string,
key_type?: string,
rsa_key_bits?: number,
sphincs_key_size?: string
}
notification full type
notification full type
{
enabled?: boolean,
frequency?: number[],
recipients?: string[]
}
private_key full type
private_key full type
{
password?: string,
pkcs12?: number[],
pre_installed?: boolean
}
recertification_links full type
recertification_links full type
{
created_date?: string,
link_type?: string,
linked_ca?: string
}[]
reinstate_requests full type
reinstate_requests full type
{
comments?: string,
id?: string,
requester_user_id?: string,
requester_username?: string,
reviewer_user_id?: string
}[]
revocation full type
revocation full type
{
comments?: string,
reason?: string,
revoke_date?: string,
revoked?: boolean
}
revocation_requests full type
revocation_requests full type
{
comments?: string,
id?: string,
reason?: string,
requester_user_id?: string,
requester_username?: string,
reviewer_user_id?: string,
revocation_date?: string
}[]
subject full type
subject full type
{
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
validity full type
validity full type
{
duration_unit?: string,
duration_value?: number,
valid_from?: string,
valid_to?: string
}
getGetACaCsr
privateCAApi.getGetACaCsr
Get a CA CSR
Risk: read
await corsair.digicert.api.privateCAApi.getGetACaCsr({
path: { id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
csr | string | No | — |
getGetACertificateChain
privateCAApi.getGetACertificateChain
Get a certificate chain
Risk: read
await corsair.digicert.api.privateCAApi.getGetACertificateChain({
path: { id: 'example', chainID: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string,
chainID: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
certificates | object[] | No | — |
default | boolean | No | — |
id | string | No | — |
name | string | No | — |
certificates full type
certificates full type
{
blob?: string,
cert_type?: string,
subject?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
}[]
getGetACertificateTemplate
privateCAApi.getGetACertificateTemplate
Get a certificate template
Risk: read
await corsair.digicert.api.privateCAApi.getGetACertificateTemplate({
path: { id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
access | string | No | — |
accounts | object[] | No | — |
active | boolean | No | — |
category | string | No | — |
cert_type | root | intermediate | end_entity | string | No | — |
created_date | string | No | — |
id | string | No | — |
install_type | string | No | — |
issue_types | string[] | No | — |
kind | string | No | — |
name | string | No | — |
template_json | string | No | — |
trust_type | string | No | — |
updated_date | string | No | — |
accounts full type
accounts full type
{
id?: string,
name?: string
}[]
getGetAllCaCertificateAiaIssuerFiles
privateCAApi.getGetAllCaCertificateAiaIssuerFiles
Get all CA certificate AIA issuer files
Risk: read
await corsair.digicert.api.privateCAApi.getGetAllCaCertificateAiaIssuerFiles({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
object
Output full type
Output full type
{
limit?: number,
offset?: number,
total?: number
}& {
items?: {
active?: boolean,
blob?: string,
ca?: {
id?: string,
name?: string
},
created_date?: string,
file_format?: string,
file_name?: string,
file_path?: string,
id?: string,
is_aia_file_warning?: boolean,
updated_date?: string
}[]
}
getGetAllCertificates
privateCAApi.getGetAllCertificates
Get All Certificates
Risk: read
await corsair.digicert.api.privateCAApi.getGetAllCertificates({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
offset?: number,
limit?: number,
certType?: string
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
items | object[] | No | — |
limit | number | No | — |
offset | number | No | — |
total | number | No | — |
items full type
items full type
{
}[]
getGetAllCertificates_a2d39d9
privateCAApi.getGetAllCertificates_a2d39d9
Get All Certificates
Risk: read
await corsair.digicert.api.privateCAApi.getGetAllCertificates_a2d39d9({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
offset?: number,
limit?: number,
sort?: string,
filters?: string,
serial_number?: string,
subject_key_id?: string,
subject_public_key?: string
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
object
Output full type
Output full type
{
limit?: number,
offset?: number,
total?: number
}& {
items?: {
account_assignments?: {
id?: string,
name?: string
}[],
account_id?: string,
blob?: number[],
cert_type?: string,
chain?: {
blob?: string,
cert_type?: string,
subject?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
}[],
csr?: string,
csr_type?: string,
custom_values?: {
},
escrow_private_key?: boolean,
extensions?: {
adobe_archive_rev_info?: {
version?: number
},
adobe_timestamp?: {
location?: string,
requires_auth?: boolean,
version?: number
},
aia?: {
issuer_urls?: string[]
},
aki?: {
authority_name_serial_number?: boolean,
include?: string,
key_identifier?: boolean
},
basic_constraints?: {
ca?: boolean,
critical?: boolean,
path_length?: number
},
cabf_organization_identifier?: {
country?: string,
reference?: string,
scheme?: string,
state?: string
},
cdp?: {
urls?: string[]
},
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
extended_key_usage?: {
additional_values?: string[],
critical?: boolean
},
extensions_order?: string[],
issuer_alt_name?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
key_usage?: {
additional_values?: string[],
critical?: boolean,
skip_validation?: boolean
},
lei?: {
value?: string
},
lei_role?: {
value?: string
},
microsoft_application_certificate_policies?: {
additional_values?: string[],
critical?: boolean
},
microsoft_certificate_template_name?: string,
microsoft_certificate_template_v2?: {
major_version?: number,
minor_version?: number,
oid?: string
},
private_key_usage_period?: {
critical?: any,
not_after?: string,
not_before?: string
},
qc_statements?: {
critical?: boolean,
etsi-psd2-qcStatement?: string[],
id-etsi-qcs-QcPDS?: {
language?: string,
uri?: string
}[],
id-etsi-qcs-QcRetentionPeriod?: number,
id-etsi-qcs-QcType?: string[],
id-qcs-pkixQCSyntax-v2?: {
semantics_id?: string
},
oids?: string[]
},
san?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
security_identifier?: {
oid?: string,
value?: string
}[],
ski?: {
include?: string,
method?: string
},
ski_extension?: string,
smime_capabilities?: {
values?: string[]
},
subject_directory_attributes?: {
encoded_value?: number[]
}
},
hosted_type?: string,
id?: string,
issuer?: {
id?: string,
name?: string,
trust_type?: string
},
issuer_subject?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
},
key_generation?: {
dilithium_key_size?: string,
ecc_curve?: string,
ecdsa_curve?: string,
falcon_key_size?: string,
key_type?: string,
rsa_key_bits?: number,
sphincs_key_size?: string
},
kind?: string,
notification?: {
enabled?: boolean,
frequency?: number[],
recipients?: string[]
},
ocsp_key_hash_alg?: string,
options?: {
chain_name?: string
},
revocation?: {
comments?: string,
reason?: string,
revoke_date?: string,
revoked?: boolean
},
serial_number?: string,
signature_algorithm?: string,
subject?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
},
template?: string,
template_id?: string,
thumbprint_sha256?: string,
trust_type?: string,
validity?: {
duration_unit?: string,
duration_value?: number,
valid_from?: string,
valid_to?: string
}
}[]
}
getGetAllCrlInfos
privateCAApi.getGetAllCrlInfos
Get All CRL Infos
Risk: read
await corsair.digicert.api.privateCAApi.getGetAllCrlInfos({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
offset?: number,
limit?: number
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
object
Output full type
Output full type
{
limit?: number,
offset?: number,
total?: number
}& {
items?: {
active?: boolean,
ca?: {
id?: string,
name?: string
},
configuration?: {
auto_partition?: {
limit?: number,
on_size?: boolean,
size?: number
},
auto_partition_generation_enabled?: boolean,
crl_scope?: string,
generation?: {
crl_frequency_hours?: any,
crl_validity_hours?: any,
override_global?: any
},
generation_enabled?: boolean,
include_idp?: boolean,
master_crl_enabled?: boolean,
publish_enabled?: boolean,
selected_domains?: string[],
signature_algorithm?: string
},
file_name?: string,
file_path?: string,
id?: string,
is_finalized?: boolean,
last_crl_number?: number,
last_generated_date?: string,
next_generate_date?: string
}[]
}
getGetAllOcspResponders
privateCAApi.getGetAllOcspResponders
Get all OCSP responders
Risk: read
await corsair.digicert.api.privateCAApi.getGetAllOcspResponders({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
offset?: number,
limit?: number
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
object
Output full type
Output full type
{
limit?: number,
offset?: number,
total?: number
}& {
items?: {
blob?: string,
created_date?: string,
csr?: number[],
csr_blob?: string,
delegated_scope?: {
ica_rules?: {
}
},
extensions?: {
adobe_archive_rev_info?: {
version?: number
},
adobe_timestamp?: {
location?: string,
requires_auth?: boolean,
version?: number
},
aia?: {
issuer_urls?: string[]
},
aki?: {
authority_name_serial_number?: boolean,
include?: string,
key_identifier?: boolean
},
basic_constraints?: {
ca?: boolean,
critical?: boolean,
path_length?: number
},
cabf_organization_identifier?: {
country?: string,
reference?: string,
scheme?: string,
state?: string
},
cdp?: {
urls?: string[]
},
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
extended_key_usage?: {
additional_values?: string[],
critical?: boolean
},
extensions_order?: string[],
issuer_alt_name?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
key_usage?: {
additional_values?: string[],
critical?: boolean,
skip_validation?: boolean
},
lei?: {
value?: string
},
lei_role?: {
value?: string
},
microsoft_application_certificate_policies?: {
additional_values?: string[],
critical?: boolean
},
microsoft_certificate_template_name?: string,
microsoft_certificate_template_v2?: {
major_version?: number,
minor_version?: number,
oid?: string
},
private_key_usage_period?: {
critical?: any,
not_after?: string,
not_before?: string
},
qc_statements?: {
critical?: boolean,
etsi-psd2-qcStatement?: string[],
id-etsi-qcs-QcPDS?: {
language?: string,
uri?: string
}[],
id-etsi-qcs-QcRetentionPeriod?: number,
id-etsi-qcs-QcType?: string[],
id-qcs-pkixQCSyntax-v2?: {
semantics_id?: string
},
oids?: string[]
},
san?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
security_identifier?: {
oid?: string,
value?: string
}[],
ski?: {
include?: string,
method?: string
},
ski_extension?: string,
smime_capabilities?: {
values?: string[]
},
subject_directory_attributes?: {
encoded_value?: number[]
}
},
hsm_provider?: {
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
},
id?: string,
issuer?: {
hosted_type?: online | offline | third_party,
id?: string,
name?: string,
valid_from?: string,
valid_to?: string
},
key_generation?: {
dilithium_key_size?: string,
ecc_curve?: string,
ecdsa_curve?: string,
falcon_key_size?: string,
key_type?: string,
rsa_key_bits?: number,
sphincs_key_size?: string
},
key_name?: string,
name?: string,
notification?: {
enabled?: boolean,
frequency?: number[],
recipients?: string[]
},
private_key?: {
password?: string,
pkcs12?: number[],
pre_installed?: boolean
},
responder_type?: string,
serial_number?: string,
signature_algorithm?: string,
status?: string,
updated_date?: string,
validity?: {
duration_unit?: string,
duration_value?: number,
valid_from?: string,
valid_to?: string
},
validity_truncate?: boolean
}[]
}
getGetAnAiaIssuerFile
privateCAApi.getGetAnAiaIssuerFile
Get an AIA Issuer File
Risk: read
await corsair.digicert.api.privateCAApi.getGetAnAiaIssuerFile({
path: { id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
active | boolean | No | — |
blob | string | No | — |
ca | object | No | — |
created_date | string | No | — |
file_format | string | No | — |
file_name | string | No | — |
file_path | string | No | — |
id | string | No | — |
is_aia_file_warning | boolean | No | — |
updated_date | string | No | — |
ca full type
ca full type
{
id?: string,
name?: string
}
getGetAnAiaIssuerFileBlob
privateCAApi.getGetAnAiaIssuerFileBlob
Get an AIA Issuer File Blob
Risk: read
await corsair.digicert.api.privateCAApi.getGetAnAiaIssuerFileBlob({
path: { id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
number
getGetAnOcspResponder
privateCAApi.getGetAnOcspResponder
Get an OCSP responder
Risk: read
await corsair.digicert.api.privateCAApi.getGetAnOcspResponder({
path: { id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
blob | string | No | — |
created_date | string | No | — |
csr | number[] | No | — |
csr_blob | string | No | — |
delegated_scope | object | No | — |
extensions | object | No | — |
hsm_provider | object | No | — |
id | string | No | — |
issuer | object | No | — |
key_generation | object | No | — |
key_name | string | No | — |
name | string | No | — |
notification | object | No | — |
private_key | object | No | — |
responder_type | string | No | — |
serial_number | string | No | — |
signature_algorithm | string | No | — |
status | string | No | — |
updated_date | string | No | — |
validity | object | No | — |
validity_truncate | boolean | No | — |
delegated_scope full type
delegated_scope full type
{
ica_rules?: {
}
}
extensions full type
extensions full type
{
adobe_archive_rev_info?: {
version?: number
},
adobe_timestamp?: {
location?: string,
requires_auth?: boolean,
version?: number
},
aia?: {
issuer_urls?: string[]
},
aki?: {
authority_name_serial_number?: boolean,
include?: string,
key_identifier?: boolean
},
basic_constraints?: {
ca?: boolean,
critical?: boolean,
path_length?: number
},
cabf_organization_identifier?: {
country?: string,
reference?: string,
scheme?: string,
state?: string
},
cdp?: {
urls?: string[]
},
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
extended_key_usage?: {
additional_values?: string[],
critical?: boolean
},
extensions_order?: string[],
issuer_alt_name?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
key_usage?: {
additional_values?: string[],
critical?: boolean,
skip_validation?: boolean
},
lei?: {
value?: string
},
lei_role?: {
value?: string
},
microsoft_application_certificate_policies?: {
additional_values?: string[],
critical?: boolean
},
microsoft_certificate_template_name?: string,
microsoft_certificate_template_v2?: {
major_version?: number,
minor_version?: number,
oid?: string
},
private_key_usage_period?: {
critical?: any,
not_after?: string,
not_before?: string
},
qc_statements?: {
critical?: boolean,
etsi-psd2-qcStatement?: string[],
id-etsi-qcs-QcPDS?: {
language?: string,
uri?: string
}[],
id-etsi-qcs-QcRetentionPeriod?: number,
id-etsi-qcs-QcType?: string[],
id-qcs-pkixQCSyntax-v2?: {
semantics_id?: string
},
oids?: string[]
},
san?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
security_identifier?: {
oid?: string,
value?: string
}[],
ski?: {
include?: string,
method?: string
},
ski_extension?: string,
smime_capabilities?: {
values?: string[]
},
subject_directory_attributes?: {
encoded_value?: number[]
}
}
hsm_provider full type
hsm_provider full type
{
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
}
issuer full type
issuer full type
{
hosted_type?: online | offline | third_party | string,
id?: string,
name?: string,
valid_from?: string,
valid_to?: string
}
key_generation full type
key_generation full type
{
dilithium_key_size?: string,
ecc_curve?: string,
ecdsa_curve?: string,
falcon_key_size?: string,
key_type?: string,
rsa_key_bits?: number,
sphincs_key_size?: string
}
notification full type
notification full type
{
enabled?: boolean,
frequency?: number[],
recipients?: string[]
}
private_key full type
private_key full type
{
password?: string,
pkcs12?: number[],
pre_installed?: boolean
}
validity full type
validity full type
{
duration_unit?: string,
duration_value?: number,
valid_from?: string,
valid_to?: string
}
getGetAuditLog
privateCAApi.getGetAuditLog
Get Audit Log
Risk: read
await corsair.digicert.api.privateCAApi.getGetAuditLog({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
offset?: number,
limit?: number,
from_date?: string,
to_date?: string
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
object
Output full type
Output full type
{
limit?: number,
offset?: number,
total?: number
}& {
items?: {
account_id?: string,
action?: string,
created_date?: string,
data?: string,
description?: string,
error_message?: string,
id?: string,
resource_id?: string,
resource_type?: string,
status?: string,
user_id?: string
}[]
}
getGetCaActiveStatus
privateCAApi.getGetCaActiveStatus
Get CA Active Status
Risk: read
await corsair.digicert.api.privateCAApi.getGetCaActiveStatus({
path: { id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
status | string | No | — |
getGetCaAiaIssuerConfiguration
privateCAApi.getGetCaAiaIssuerConfiguration
Get CA AIA Issuer Configuration
Risk: read
await corsair.digicert.api.privateCAApi.getGetCaAiaIssuerConfiguration({
path: { id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
domains | object[] | No | — |
include | string | No | — |
override_global | boolean | No | — |
domains full type
domains full type
{
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap | string,
type?: string[]
}[]
getGetCaCertificateChains
privateCAApi.getGetCaCertificateChains
Get CA certificate chains
Risk: read
await corsair.digicert.api.privateCAApi.getGetCaCertificateChains({
path: { id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
object
Output full type
Output full type
{
limit?: number,
offset?: number,
total?: number
}& {
items?: {
certificates?: {
blob?: string,
cert_type?: string,
subject?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
}[],
default?: boolean,
id?: string,
name?: string
}[]
}
getGetCaCertPoliciesConfiguration
privateCAApi.getGetCaCertPoliciesConfiguration
Get CA Cert Policies Configuration
Risk: read
await corsair.digicert.api.privateCAApi.getGetCaCertPoliciesConfiguration({
path: { id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
allowed_sources | string[] | No | — |
default_policies | object | No | — |
include | string | No | — |
override_global | boolean | No | — |
default_policies full type
default_policies full type
{
critical?: boolean,
policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[]
}
getGetCaCrlIssuanceConfig
privateCAApi.getGetCaCrlIssuanceConfig
Get CA CRL issuance config
Risk: read
await corsair.digicert.api.privateCAApi.getGetCaCrlIssuanceConfig({
path: { id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
domains | object[] | No | — |
end_validity_years | number | No | — |
include | string | No | — |
override_global | boolean | No | — |
domains full type
domains full type
{
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap | string,
type?: string[]
}[]
getGetCaNotes
privateCAApi.getGetCaNotes
Get CA Notes
Risk: read
await corsair.digicert.api.privateCAApi.getGetCaNotes({
path: { id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string
}
query full type
query full type
{
offset?: number,
limit?: number
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
object
Output full type
Output full type
{
limit?: number,
offset?: number,
total?: number
}& {
items?: {
created_date?: string,
id?: string,
text?: string,
user_email?: string,
user_full_name?: string,
user_id?: string
}[]
}
getGetCaOcspConfig
privateCAApi.getGetCaOcspConfig
Get CA OCSP config
Risk: read
await corsair.digicert.api.privateCAApi.getGetCaOcspConfig({
path: { id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
domains | object[] | No | — |
include | string | No | — |
override_global | boolean | No | — |
uri_path | string | No | — |
domains full type
domains full type
{
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap | string,
type?: string[]
}[]
getGetCaOcspGenerationConfig
privateCAApi.getGetCaOcspGenerationConfig
Get CA OCSP generation config
Risk: read
await corsair.digicert.api.privateCAApi.getGetCaOcspGenerationConfig({
path: { id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
delegated | boolean | No | — |
generation_frequency_hours | number | No | — |
include_chain | boolean | No | — |
offline_cas_option | sign_with_ca_key_and_fallback | sign_with_responder_and_fallback | sign_only_with_responder | sign_only_with_ca_key | No | — |
on_demand | boolean | No | — |
online_cas_option | sign_with_ca_key_and_fallback | sign_with_responder_and_fallback | sign_only_with_responder | sign_only_with_ca_key | No | — |
override_global | boolean | No | — |
response_duration_hours | number | No | — |
getGetCaOcspIssuanceConfig
privateCAApi.getGetCaOcspIssuanceConfig
Get CA OCSP issuance config
Risk: read
await corsair.digicert.api.privateCAApi.getGetCaOcspIssuanceConfig({
path: { id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
domains | object[] | No | — |
include | string | No | — |
override_global | boolean | No | — |
uri_path | string | No | — |
domains full type
domains full type
{
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap | string,
type?: string[]
}[]
getGetCaOcspResponderConfig
privateCAApi.getGetCaOcspResponderConfig
Get CA OCSP responder config
Risk: read
await corsair.digicert.api.privateCAApi.getGetCaOcspResponderConfig({
path: { id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
certificate_policies | object[] | No | — |
certificate_template | object | No | — |
delete_expired_responders | boolean | No | — |
generation_enabled | boolean | No | — |
hsm_partition | object | No | — |
override_global | boolean | No | — |
responder_create_within_days | number | No | — |
responder_validity_days | number | No | — |
certificate_policies full type
certificate_policies full type
{
cps_uri?: string,
oid?: string,
user_notice?: string
}[]
certificate_template full type
certificate_template full type
{
access?: string,
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
category?: string,
cert_type?: root | intermediate | end_entity | string,
created_date?: string,
id?: string,
install_type?: string,
issue_types?: string[],
kind?: string,
name?: string,
template_json?: string,
trust_type?: string,
updated_date?: string
}
hsm_partition full type
hsm_partition full type
{
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
}
getGetCaReinstateRequest
privateCAApi.getGetCaReinstateRequest
Get CA Reinstate Request
Risk: read
await corsair.digicert.api.privateCAApi.getGetCaReinstateRequest({
path: { id: 'example', requestId: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string,
requestId: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
comments | string | No | — |
id | string | No | — |
requester_user_id | string | No | — |
requester_username | string | No | — |
reviewer_user_id | string | No | — |
getGetCaRevokeRequest
privateCAApi.getGetCaRevokeRequest
Get CA Revoke Request
Risk: read
await corsair.digicert.api.privateCAApi.getGetCaRevokeRequest({
path: { id: 'example', requestId: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string,
requestId: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
comments | string | No | — |
id | string | No | — |
reason | string | No | — |
requester_user_id | string | No | — |
requester_username | string | No | — |
reviewer_user_id | string | No | — |
revocation_date | string | No | — |
getGetCertificate
privateCAApi.getGetCertificate
Get Certificate
Risk: read
await corsair.digicert.api.privateCAApi.getGetCertificate({
path: { id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string
}
query full type
query full type
{
chain_name?: string
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
account_assignments | object[] | No | — |
account_id | string | No | — |
blob | number[] | No | — |
cert_type | string | No | — |
chain | object[] | No | — |
csr | string | No | — |
csr_type | string | No | — |
custom_values | object | No | — |
escrow_private_key | boolean | No | — |
extensions | object | No | — |
hosted_type | string | No | — |
id | string | No | — |
issuer | object | No | — |
issuer_subject | object | No | — |
key_generation | object | No | — |
kind | string | No | — |
notification | object | No | — |
ocsp_key_hash_alg | string | No | — |
options | object | No | — |
revocation | object | No | — |
serial_number | string | No | — |
signature_algorithm | string | No | — |
subject | object | No | — |
template | string | No | — |
template_id | string | No | — |
thumbprint_sha256 | string | No | — |
trust_type | string | No | — |
validity | object | No | — |
account_assignments full type
account_assignments full type
{
id?: string,
name?: string
}[]
chain full type
chain full type
{
blob?: string,
cert_type?: string,
subject?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
}[]
custom_values full type
custom_values full type
{
}
extensions full type
extensions full type
{
adobe_archive_rev_info?: {
version?: number
},
adobe_timestamp?: {
location?: string,
requires_auth?: boolean,
version?: number
},
aia?: {
issuer_urls?: string[]
},
aki?: {
authority_name_serial_number?: boolean,
include?: string,
key_identifier?: boolean
},
basic_constraints?: {
ca?: boolean,
critical?: boolean,
path_length?: number
},
cabf_organization_identifier?: {
country?: string,
reference?: string,
scheme?: string,
state?: string
},
cdp?: {
urls?: string[]
},
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
extended_key_usage?: {
additional_values?: string[],
critical?: boolean
},
extensions_order?: string[],
issuer_alt_name?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
key_usage?: {
additional_values?: string[],
critical?: boolean,
skip_validation?: boolean
},
lei?: {
value?: string
},
lei_role?: {
value?: string
},
microsoft_application_certificate_policies?: {
additional_values?: string[],
critical?: boolean
},
microsoft_certificate_template_name?: string,
microsoft_certificate_template_v2?: {
major_version?: number,
minor_version?: number,
oid?: string
},
private_key_usage_period?: {
critical?: any,
not_after?: string,
not_before?: string
},
qc_statements?: {
critical?: boolean,
etsi-psd2-qcStatement?: string[],
id-etsi-qcs-QcPDS?: {
language?: string,
uri?: string
}[],
id-etsi-qcs-QcRetentionPeriod?: number,
id-etsi-qcs-QcType?: string[],
id-qcs-pkixQCSyntax-v2?: {
semantics_id?: string
},
oids?: string[]
},
san?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
security_identifier?: {
oid?: string,
value?: string
}[],
ski?: {
include?: string,
method?: string
},
ski_extension?: string,
smime_capabilities?: {
values?: string[]
},
subject_directory_attributes?: {
encoded_value?: number[]
}
}
issuer full type
issuer full type
{
id?: string,
name?: string,
trust_type?: string
}
issuer_subject full type
issuer_subject full type
{
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
key_generation full type
key_generation full type
{
dilithium_key_size?: string,
ecc_curve?: string,
ecdsa_curve?: string,
falcon_key_size?: string,
key_type?: string,
rsa_key_bits?: number,
sphincs_key_size?: string
}
notification full type
notification full type
{
enabled?: boolean,
frequency?: number[],
recipients?: string[]
}
options full type
options full type
{
chain_name?: string
}
revocation full type
revocation full type
{
comments?: string,
reason?: string,
revoke_date?: string,
revoked?: boolean
}
subject full type
subject full type
{
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
validity full type
validity full type
{
duration_unit?: string,
duration_value?: number,
valid_from?: string,
valid_to?: string
}
getGetCertificateExpiration
privateCAApi.getGetCertificateExpiration
Get certificate expiration
Risk: read
await corsair.digicert.api.privateCAApi.getGetCertificateExpiration({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
number
getGetCertificateTemplates
privateCAApi.getGetCertificateTemplates
Get certificate templates
Risk: read
await corsair.digicert.api.privateCAApi.getGetCertificateTemplates({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
offset?: number,
limit?: number,
name?: string
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
object
Output full type
Output full type
{
limit?: number,
offset?: number,
total?: number
}& {
items?: {
access?: string,
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
category?: string,
cert_type?: root | intermediate | end_entity,
created_date?: string,
id?: string,
install_type?: string,
issue_types?: string[],
kind?: string,
name?: string,
template_json?: string,
trust_type?: string,
updated_date?: string
}[]
}
getGetCertificateTemplateValidationSchemas
privateCAApi.getGetCertificateTemplateValidationSchemas
Get certificate template validation schemas
Risk: read
await corsair.digicert.api.privateCAApi.getGetCertificateTemplateValidationSchemas({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
type?: string,
category?: string
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
access | string | No | — |
accounts | object[] | No | — |
active | boolean | No | — |
category | string | No | — |
cert_type | root | intermediate | end_entity | string | No | — |
created_date | string | No | — |
id | string | No | — |
install_type | string | No | — |
issue_types | string[] | No | — |
kind | string | No | — |
name | string | No | — |
template_json | string | No | — |
trust_type | string | No | — |
updated_date | string | No | — |
accounts full type
accounts full type
{
id?: string,
name?: string
}[]
getGetCertificateTemplateValidationSchemas_4fe4fdb
privateCAApi.getGetCertificateTemplateValidationSchemas_4fe4fdb
Get certificate template validation schemas
Risk: read
await corsair.digicert.api.privateCAApi.getGetCertificateTemplateValidationSchemas_4fe4fdb({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
access | string | No | — |
accounts | object[] | No | — |
active | boolean | No | — |
category | string | No | — |
cert_type | root | intermediate | end_entity | string | No | — |
created_date | string | No | — |
id | string | No | — |
install_type | string | No | — |
issue_types | string[] | No | — |
kind | string | No | — |
name | string | No | — |
template_json | string | No | — |
trust_type | string | No | — |
updated_date | string | No | — |
accounts full type
accounts full type
{
id?: string,
name?: string
}[]
getGetCrlBlob
privateCAApi.getGetCrlBlob
Get CRL Blob
Risk: read
await corsair.digicert.api.privateCAApi.getGetCrlBlob({
path: { id: 'example', crl_number: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string,
crl_number: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
blob | number[] | No | — |
crl_id | string | No | — |
crl_number | number | No | — |
generated_date | string | No | — |
next_update | string | No | — |
this_update | string | No | — |
getGetCrlBlobList
privateCAApi.getGetCrlBlobList
Get CRL Blob List
Risk: read
await corsair.digicert.api.privateCAApi.getGetCrlBlobList({
path: { id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string
}
query full type
query full type
{
offset?: number,
limit?: number
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
object
Output full type
Output full type
{
limit?: number,
offset?: number,
total?: number
}& {
items?: {
blob?: number[],
crl_id?: string,
crl_number?: number,
generated_date?: string,
next_update?: string,
this_update?: string
}[]
}
getGetCrlConfig
privateCAApi.getGetCrlConfig
Get CRL Config
Risk: read
await corsair.digicert.api.privateCAApi.getGetCrlConfig({
path: { id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
auto_partition | object | No | — |
auto_partition_generation_enabled | boolean | No | — |
crl_scope | string | No | — |
generation | object | No | — |
generation_enabled | boolean | No | — |
include_idp | boolean | No | — |
master_crl_enabled | boolean | No | — |
publish_enabled | boolean | No | — |
selected_domains | string[] | No | — |
signature_algorithm | string | No | — |
auto_partition full type
auto_partition full type
{
limit?: number,
on_size?: boolean,
size?: number
}
generation full type
generation full type
{
crl_frequency_hours?: any,
crl_validity_hours?: any,
override_global?: any
}
getGetCrlInfo
privateCAApi.getGetCrlInfo
Get CRL Info
Risk: read
await corsair.digicert.api.privateCAApi.getGetCrlInfo({
path: { id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
active | boolean | No | — |
ca | object | No | — |
configuration | object | No | — |
file_name | string | No | — |
file_path | string | No | — |
id | string | No | — |
is_finalized | boolean | No | — |
last_crl_number | number | No | — |
last_generated_date | string | No | — |
next_generate_date | string | No | — |
ca full type
ca full type
{
id?: string,
name?: string
}
configuration full type
configuration full type
{
auto_partition?: {
limit?: number,
on_size?: boolean,
size?: number
},
auto_partition_generation_enabled?: boolean,
crl_scope?: string,
generation?: {
crl_frequency_hours?: any,
crl_validity_hours?: any,
override_global?: any
},
generation_enabled?: boolean,
include_idp?: boolean,
master_crl_enabled?: boolean,
publish_enabled?: boolean,
selected_domains?: string[],
signature_algorithm?: string
}
getGetCsvListOfCertificates
privateCAApi.getGetCsvListOfCertificates
Get CSV List of Certificates
Risk: read
await corsair.digicert.api.privateCAApi.getGetCsvListOfCertificates({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
offset?: number,
limit?: number,
certType?: string
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
object[]
Output full type
Output full type
{
commonName?: string,
id?: string,
issuerName?: string,
organizationName?: string,
revocationReason?: string,
revokedAt?: string,
serialNumber?: string,
status?: string,
validFrom?: string,
validTo?: string
}[]
getGetFedRampComplianceEvidence
privateCAApi.getGetFedRampComplianceEvidence
Get FedRAMP compliance evidence
Risk: read
await corsair.digicert.api.privateCAApi.getGetFedRampComplianceEvidence({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
datetime | string | No | — |
evidence | object | No | — |
product | string | No | — |
schema_version | string | No | — |
source | string | No | — |
evidence full type
evidence full type
{
change_management?: {
metadata?: {
control_ids?: string[],
datetime?: string,
id?: string,
next_refresh_at?: string,
title?: string,
ttl_seconds?: number
},
result?: {
audit_logging_enabled?: boolean,
mechanism?: string
}
},
data_encryption?: {
metadata?: {
control_ids?: string[],
datetime?: string,
id?: string,
next_refresh_at?: string,
title?: string,
ttl_seconds?: number
},
result?: {
field_level_encryption_enabled?: boolean,
master_secret_configured?: boolean,
mechanism?: string,
module_id?: string
}
},
fips_cmvp?: {
metadata?: {
control_ids?: string[],
datetime?: string,
id?: string,
next_refresh_at?: string,
title?: string,
ttl_seconds?: number
},
result?: {
active_module?: {
cavp_certificate?: string,
certificate_number?: string,
fips_140_3_validated?: boolean,
id?: string,
name?: string,
purpose?: string,
status?: string,
version?: string
},
allowed_aes_key_sizes?: number[],
allowed_ecdsa_curves?: string[],
allowed_key_algorithms?: string[],
allowed_rsa_key_sizes?: number[],
allowed_signature_algorithms?: string[],
checked_at?: string,
fips_mode_enabled?: boolean,
fips_module_enabled?: boolean,
fips_standard?: string,
providers?: {
active?: boolean,
allowed_in_fips_mode?: boolean,
configured?: boolean,
fips_140_3_validated?: boolean,
name?: string
}[]
}
}
}
getGetHsmPartitions
privateCAApi.getGetHsmPartitions
Get HSM partitions
Risk: read
await corsair.digicert.api.privateCAApi.getGetHsmPartitions({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
offset?: number,
limit?: number,
account_ids?: string
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
object
Output full type
Output full type
{
limit?: number,
offset?: number,
total?: number
}& {
items?: {
access_to_all?: boolean,
account_assignments?: {
id?: string,
name?: string
}[],
active_escrow_master_key?: {
active?: boolean,
id?: string
},
allowed_uses?: string[],
created_date?: string,
default?: boolean,
display_name?: string,
enabled?: boolean,
escrow_default?: boolean,
hsm_provider?: {
enabled?: any,
max_concurrent_ops?: number,
name?: string
},
id?: string,
name?: string,
partition_name?: string,
provider_partition_id?: string,
security_level?: level_1 | level_2 | level_3 | level_4
}[]
}
getGetSamlConfiguration
privateCAApi.getGetSamlConfiguration
Get SAML Configuration
Risk: read
await corsair.digicert.api.privateCAApi.getGetSamlConfiguration({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
createdAt | string | No | — |
enabled | boolean | No | — |
id | string | No | — |
idpEntityId | string | No | — |
idpMetadataUrl | string | No | — |
idpSsoUrl | string | No | — |
roleMappingJson | string | No | — |
updatedAt | string | No | — |
getGetSpMetadata
privateCAApi.getGetSpMetadata
Get SP Metadata
Risk: read
await corsair.digicert.api.privateCAApi.getGetSpMetadata({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
string
getGetTheRootCaHierarchy
privateCAApi.getGetTheRootCaHierarchy
Get the root CA hierarchy
Risk: read
await corsair.digicert.api.privateCAApi.getGetTheRootCaHierarchy({
path: { id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
cert_blob | number[] | No | — |
cert_type | string | No | — |
children | Record<string, any>[] | No | — |
id | string | No | — |
name | string | No | — |
parsed_subject | object | No | — |
status | string | No | — |
subject_dn | string | No | — |
valid_from | string | No | — |
valid_to | string | No | — |
parsed_subject full type
parsed_subject full type
{
common_name?: string,
country?: string[],
extra_names?: {
type?: number[],
value?: any
}[],
locality?: string[],
names?: {
type?: number[],
value?: any
}[],
organization?: string[],
organizational_unit?: string[],
postal_code?: string[],
province?: string[],
serial_number?: string,
street_address?: string[]
}
getHandleScepGetOperations
privateCAApi.getHandleScepGetOperations
Handle SCEP GET operations
Risk: write
await corsair.digicert.api.privateCAApi.getHandleScepGetOperations({
path: { profileID: 'example' },
query: { operation: 'GetCACert' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
profileID: string
}
query full type
query full type
{
operation: GetCACert | GetCACaps | PKIOperation,
message?: string
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
string
getInitiateSamlLogin
privateCAApi.getInitiateSamlLogin
Initiate SAML Login
Risk: read
await corsair.digicert.api.privateCAApi.getInitiateSamlLogin({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
RelayState?: string
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
any
getRecoverEscrowedEeKey
privateCAApi.getRecoverEscrowedEeKey
Recover Escrowed EE Key
Risk: read
await corsair.digicert.api.privateCAApi.getRecoverEscrowedEeKey({
path: { id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string
}
query full type
query full type
{
include_chain?: none | ica_only | full
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
password | string | No | — |
pkcs12 | number[] | No | — |
pre_installed | boolean | No | — |
getShowAllCas
privateCAApi.getShowAllCas
Show all CAs
Risk: read
await corsair.digicert.api.privateCAApi.getShowAllCas({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
object
Output full type
Output full type
{
limit?: number,
offset?: number,
total?: number
}& {
items?: {
account_assignments?: {
id?: string,
name?: string
}[],
active_aia_issuer?: {
file_name?: string,
id?: string
},
active_arl?: {
file_name?: string,
file_path?: string,
id?: string
},
active_crl?: {
file_name?: string,
file_path?: string,
id?: string
},
active_crl_cdps?: {
cdps?: string[]
},
active_eerl?: {
file_name?: string,
file_path?: string,
id?: string
},
allow_unmatched_cdp?: boolean,
blob?: string,
ca_type?: string,
cert_type?: string,
configuration?: {
aia_issuer?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap,
type?: string[]
}[],
include?: string,
override_global?: boolean
},
allow_extended_validity?: boolean,
allow_pkcs7_operations?: boolean,
allowed_signature_algorithms?: string[],
available_signature_algorithms?: string[],
certificate_policies?: {
allowed_sources?: string[],
default_policies?: {
critical?: boolean,
policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[]
},
include?: string,
override_global?: boolean
},
chains?: {
certificates?: {
blob?: string,
cert_type?: string,
subject?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
}[],
default?: boolean,
id?: string,
name?: string
}[],
crl?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap,
type?: string[]
}[],
end_validity_years?: number,
include?: string,
override_global?: boolean
},
include_all_certificates_in_crl?: boolean,
issue_end_entities?: boolean,
issue_ica_intermediates?: boolean,
issue_types?: string[],
issue_unmanaged_ca?: boolean,
ocsp?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap,
type?: string[]
}[],
include?: string,
override_global?: boolean,
uri_path?: string
},
ocsp_responder?: {
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
certificate_template?: {
access?: string,
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
category?: string,
cert_type?: root | intermediate | end_entity,
created_date?: string,
id?: string,
install_type?: string,
issue_types?: string[],
kind?: string,
name?: string,
template_json?: string,
trust_type?: string,
updated_date?: string
},
delete_expired_responders?: boolean,
generation_enabled?: boolean,
hsm_partition?: {
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
},
override_global?: boolean,
responder_create_within_days?: number,
responder_validity_days?: number
}
},
create_default_aia_issuer?: boolean,
create_default_crl?: boolean,
create_preview_cert?: boolean,
csr?: string,
exportable?: boolean,
extensions?: {
adobe_archive_rev_info?: {
version?: number
},
adobe_timestamp?: {
location?: string,
requires_auth?: boolean,
version?: number
},
aia?: {
issuer_urls?: string[]
},
aki?: {
authority_name_serial_number?: boolean,
include?: string,
key_identifier?: boolean
},
basic_constraints?: {
ca?: boolean,
critical?: boolean,
path_length?: number
},
cabf_organization_identifier?: {
country?: string,
reference?: string,
scheme?: string,
state?: string
},
cdp?: {
urls?: string[]
},
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
extended_key_usage?: {
additional_values?: string[],
critical?: boolean
},
extensions_order?: string[],
issuer_alt_name?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
key_usage?: {
additional_values?: string[],
critical?: boolean,
skip_validation?: boolean
},
lei?: {
value?: string
},
lei_role?: {
value?: string
},
microsoft_application_certificate_policies?: {
additional_values?: string[],
critical?: boolean
},
microsoft_certificate_template_name?: string,
microsoft_certificate_template_v2?: {
major_version?: number,
minor_version?: number,
oid?: string
},
private_key_usage_period?: {
critical?: any,
not_after?: string,
not_before?: string
},
qc_statements?: {
critical?: boolean,
etsi-psd2-qcStatement?: string[],
id-etsi-qcs-QcPDS?: {
language?: string,
uri?: string
}[],
id-etsi-qcs-QcRetentionPeriod?: number,
id-etsi-qcs-QcType?: string[],
id-qcs-pkixQCSyntax-v2?: {
semantics_id?: string
},
oids?: string[]
},
san?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
security_identifier?: {
oid?: string,
value?: string
}[],
ski?: {
include?: string,
method?: string
},
ski_extension?: string,
smime_capabilities?: {
values?: string[]
},
subject_directory_attributes?: {
encoded_value?: number[]
}
},
hosted_type?: online | offline | external | third_party,
hsm_key_label?: string,
hsm_partition?: {
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
},
id?: string,
is_composite_ca?: boolean,
issue_types?: string[],
issuer?: {
hosted_type?: online | offline | third_party,
id?: string,
name?: string,
valid_from?: string,
valid_to?: string
},
key_generation?: {
dilithium_key_size?: string,
ecc_curve?: string,
ecdsa_curve?: string,
falcon_key_size?: string,
key_type?: string,
rsa_key_bits?: number,
sphincs_key_size?: string
},
key_type?: rsa | ecc | string,
name?: string,
notification?: {
enabled?: boolean,
frequency?: number[],
recipients?: string[]
},
number_of_ica?: number,
pem?: string,
private_key?: {
password?: string,
pkcs12?: number[],
pre_installed?: boolean
},
recertification_links?: {
created_date?: string,
link_type?: string,
linked_ca?: string
}[],
reinstate_requests?: {
comments?: string,
id?: string,
requester_user_id?: string,
requester_username?: string,
reviewer_user_id?: string
}[],
revocation?: {
comments?: string,
reason?: string,
revoke_date?: string,
revoked?: boolean
},
revocation_requests?: {
comments?: string,
id?: string,
reason?: string,
requester_user_id?: string,
requester_username?: string,
reviewer_user_id?: string,
revocation_date?: string
}[],
serial_number?: string,
signature_algorithm?: string,
status?: active | pending_sign | disabled | string,
subject?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
},
template?: string,
template_id?: string,
thumbprint_sha256?: string,
trust_type?: string,
trust_types?: string[],
validity?: {
duration_unit?: string,
duration_value?: number,
valid_from?: string,
valid_to?: string
}
}[]
}
postAddACertificateChainToACa
privateCAApi.postAddACertificateChainToACa
Add a certificate chain to a CA
Risk: write
await corsair.digicert.api.privateCAApi.postAddACertificateChainToACa({
path: { id: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificates?: {
blob?: string,
cert_type?: string,
subject?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
}[],
default?: boolean,
id?: string,
name?: string
}
object
Output full type
Output full type
{
items?: {
},
limit?: number,
offset?: number,
total?: number
}& {
items?: {
certificates?: {
blob?: string,
cert_type?: string,
subject?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
}[],
default?: boolean,
id?: string,
name?: string
}
}
postAddAnAiaIssuerFile
privateCAApi.postAddAnAiaIssuerFile
Add an AIA Issuer File
Risk: write
await corsair.digicert.api.privateCAApi.postAddAnAiaIssuerFile({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
active | boolean | No | — |
blob | string | No | — |
ca | object | No | — |
created_date | string | No | — |
file_format | string | No | — |
file_name | string | No | — |
file_path | string | No | — |
id | string | No | — |
is_aia_file_warning | boolean | No | — |
updated_date | string | No | — |
ca full type
ca full type
{
id?: string,
name?: string
}
postAddCaAccounts
privateCAApi.postAddCaAccounts
Add CA Accounts
Risk: write
await corsair.digicert.api.privateCAApi.postAddCaAccounts({
path: { id: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
accounts?: string[]
}
undefined
postAddCrlInfos
privateCAApi.postAddCrlInfos
Add CRL Infos
Risk: write
await corsair.digicert.api.privateCAApi.postAddCrlInfos({
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
active?: boolean,
ca?: {
id?: string,
name?: string
},
configuration?: {
auto_partition?: {
limit?: number,
on_size?: boolean,
size?: number
},
auto_partition_generation_enabled?: boolean,
crl_scope?: string,
generation?: {
crl_frequency_hours?: any,
crl_validity_hours?: any,
override_global?: any
},
generation_enabled?: boolean,
include_idp?: boolean,
master_crl_enabled?: boolean,
publish_enabled?: boolean,
selected_domains?: string[],
signature_algorithm?: string
},
file_name?: string,
file_path?: string,
id?: string,
is_finalized?: boolean,
last_crl_number?: number,
last_generated_date?: string,
next_generate_date?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | string | No | — |
postApproveCaReinstateRequest
privateCAApi.postApproveCaReinstateRequest
Approve CA Reinstate Request
Risk: write
await corsair.digicert.api.privateCAApi.postApproveCaReinstateRequest({
path: { id: 'example', requestId: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string,
requestId: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
postApproveCaRevokeRequest
privateCAApi.postApproveCaRevokeRequest
Approve CA Revoke Request
Risk: destructive
await corsair.digicert.api.privateCAApi.postApproveCaRevokeRequest({
path: { id: 'example', requestId: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string,
requestId: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
postAssertionConsumerService
privateCAApi.postAssertionConsumerService
Assertion Consumer Service
Risk: write
await corsair.digicert.api.privateCAApi.postAssertionConsumerService({
body: { SAMLResponse: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
SAMLResponse: string,
RelayState?: string
}
any
postCreateACa
privateCAApi.postCreateACa
Create a CA
Risk: write
await corsair.digicert.api.privateCAApi.postCreateACa({
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account_assignments?: {
id?: string,
name?: string
}[],
active_aia_issuer?: {
file_name?: string,
id?: string
},
active_arl?: {
file_name?: string,
file_path?: string,
id?: string
},
active_crl?: {
file_name?: string,
file_path?: string,
id?: string
},
active_crl_cdps?: {
cdps?: string[]
},
active_eerl?: {
file_name?: string,
file_path?: string,
id?: string
},
allow_unmatched_cdp?: boolean,
blob?: string,
ca_type?: string,
cert_type?: string,
configuration?: {
aia_issuer?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap,
type?: string[]
}[],
include?: string,
override_global?: boolean
},
allow_extended_validity?: boolean,
allow_pkcs7_operations?: boolean,
allowed_signature_algorithms?: string[],
available_signature_algorithms?: string[],
certificate_policies?: {
allowed_sources?: string[],
default_policies?: {
critical?: boolean,
policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[]
},
include?: string,
override_global?: boolean
},
chains?: {
certificates?: {
blob?: string,
cert_type?: string,
subject?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
}[],
default?: boolean,
id?: string,
name?: string
}[],
crl?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap,
type?: string[]
}[],
end_validity_years?: number,
include?: string,
override_global?: boolean
},
include_all_certificates_in_crl?: boolean,
issue_end_entities?: boolean,
issue_ica_intermediates?: boolean,
issue_types?: string[],
issue_unmanaged_ca?: boolean,
ocsp?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap,
type?: string[]
}[],
include?: string,
override_global?: boolean,
uri_path?: string
},
ocsp_responder?: {
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
certificate_template?: {
access?: string,
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
category?: string,
cert_type?: root | intermediate | end_entity,
created_date?: string,
id?: string,
install_type?: string,
issue_types?: string[],
kind?: string,
name?: string,
template_json?: string,
trust_type?: string,
updated_date?: string
},
delete_expired_responders?: boolean,
generation_enabled?: boolean,
hsm_partition?: {
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
},
override_global?: boolean,
responder_create_within_days?: number,
responder_validity_days?: number
}
},
create_default_aia_issuer?: boolean,
create_default_crl?: boolean,
create_preview_cert?: boolean,
csr?: string,
exportable?: boolean,
extensions?: {
adobe_archive_rev_info?: {
version?: number
},
adobe_timestamp?: {
location?: string,
requires_auth?: boolean,
version?: number
},
aia?: {
issuer_urls?: string[]
},
aki?: {
authority_name_serial_number?: boolean,
include?: string,
key_identifier?: boolean
},
basic_constraints?: {
ca?: boolean,
critical?: boolean,
path_length?: number
},
cabf_organization_identifier?: {
country?: string,
reference?: string,
scheme?: string,
state?: string
},
cdp?: {
urls?: string[]
},
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
extended_key_usage?: {
additional_values?: string[],
critical?: boolean
},
extensions_order?: string[],
issuer_alt_name?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
key_usage?: {
additional_values?: string[],
critical?: boolean,
skip_validation?: boolean
},
lei?: {
value?: string
},
lei_role?: {
value?: string
},
microsoft_application_certificate_policies?: {
additional_values?: string[],
critical?: boolean
},
microsoft_certificate_template_name?: string,
microsoft_certificate_template_v2?: {
major_version?: number,
minor_version?: number,
oid?: string
},
private_key_usage_period?: {
critical?: any,
not_after?: string,
not_before?: string
},
qc_statements?: {
critical?: boolean,
etsi-psd2-qcStatement?: string[],
id-etsi-qcs-QcPDS?: {
language?: string,
uri?: string
}[],
id-etsi-qcs-QcRetentionPeriod?: number,
id-etsi-qcs-QcType?: string[],
id-qcs-pkixQCSyntax-v2?: {
semantics_id?: string
},
oids?: string[]
},
san?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
security_identifier?: {
oid?: string,
value?: string
}[],
ski?: {
include?: string,
method?: string
},
ski_extension?: string,
smime_capabilities?: {
values?: string[]
},
subject_directory_attributes?: {
encoded_value?: number[]
}
},
hosted_type?: online | offline | external | third_party,
hsm_key_label?: string,
hsm_partition?: {
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
},
id?: string,
is_composite_ca?: boolean,
issue_types?: string[],
issuer?: {
hosted_type?: online | offline | third_party,
id?: string,
name?: string,
valid_from?: string,
valid_to?: string
},
key_generation?: {
dilithium_key_size?: string,
ecc_curve?: string,
ecdsa_curve?: string,
falcon_key_size?: string,
key_type?: string,
rsa_key_bits?: number,
sphincs_key_size?: string
},
key_type?: rsa | ecc,
name?: string,
notification?: {
enabled?: boolean,
frequency?: number[],
recipients?: string[]
},
number_of_ica?: number,
pem?: string,
private_key?: {
password?: string,
pkcs12?: number[],
pre_installed?: boolean
},
recertification_links?: {
created_date?: string,
link_type?: string,
linked_ca?: string
}[],
reinstate_requests?: {
comments?: string,
id?: string,
requester_user_id?: string,
requester_username?: string,
reviewer_user_id?: string
}[],
revocation?: {
comments?: string,
reason?: string,
revoke_date?: string,
revoked?: boolean
},
revocation_requests?: {
comments?: string,
id?: string,
reason?: string,
requester_user_id?: string,
requester_username?: string,
reviewer_user_id?: string,
revocation_date?: string
}[],
serial_number?: string,
signature_algorithm?: string,
status?: active | pending_sign | disabled,
subject?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
},
template?: string,
template_id?: string,
thumbprint_sha256?: string,
trust_type?: string,
trust_types?: string[],
validity?: {
duration_unit?: string,
duration_value?: number,
valid_from?: string,
valid_to?: string
}
}
| Name | Type | Required | Description |
|---|---|---|---|
account_assignments | object[] | No | — |
active_aia_issuer | object | No | — |
active_arl | object | No | — |
active_crl | object | No | — |
active_crl_cdps | object | No | — |
active_eerl | object | No | — |
allow_unmatched_cdp | boolean | No | — |
blob | string | No | — |
ca_type | string | No | — |
cert_type | string | No | — |
configuration | object | No | — |
create_default_aia_issuer | boolean | No | — |
create_default_crl | boolean | No | — |
create_preview_cert | boolean | No | — |
csr | string | No | — |
exportable | boolean | No | — |
extensions | object | No | — |
hosted_type | online | offline | external | third_party | No | — |
hsm_key_label | string | No | — |
hsm_partition | object | No | — |
id | string | No | — |
is_composite_ca | boolean | No | — |
issue_types | string[] | No | — |
issuer | object | No | — |
key_generation | object | No | — |
key_type | rsa | ecc | string | No | — |
name | string | No | — |
notification | object | No | — |
number_of_ica | number | No | — |
pem | string | No | — |
private_key | object | No | — |
recertification_links | object[] | No | — |
reinstate_requests | object[] | No | — |
revocation | object | No | — |
revocation_requests | object[] | No | — |
serial_number | string | No | — |
signature_algorithm | string | No | — |
status | active | pending_sign | disabled | string | No | — |
subject | object | No | — |
template | string | No | — |
template_id | string | No | — |
thumbprint_sha256 | string | No | — |
trust_type | string | No | — |
trust_types | string[] | No | — |
validity | object | No | — |
account_assignments full type
account_assignments full type
{
id?: string,
name?: string
}[]
active_aia_issuer full type
active_aia_issuer full type
{
file_name?: string,
id?: string
}
active_arl full type
active_arl full type
{
file_name?: string,
file_path?: string,
id?: string
}
active_crl full type
active_crl full type
{
file_name?: string,
file_path?: string,
id?: string
}
active_crl_cdps full type
active_crl_cdps full type
{
cdps?: string[]
}
active_eerl full type
active_eerl full type
{
file_name?: string,
file_path?: string,
id?: string
}
configuration full type
configuration full type
{
aia_issuer?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap | string,
type?: string[]
}[],
include?: string,
override_global?: boolean
},
allow_extended_validity?: boolean,
allow_pkcs7_operations?: boolean,
allowed_signature_algorithms?: string[],
available_signature_algorithms?: string[],
certificate_policies?: {
allowed_sources?: string[],
default_policies?: {
critical?: boolean,
policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[]
},
include?: string,
override_global?: boolean
},
chains?: {
certificates?: {
blob?: string,
cert_type?: string,
subject?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
}[],
default?: boolean,
id?: string,
name?: string
}[],
crl?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap | string,
type?: string[]
}[],
end_validity_years?: number,
include?: string,
override_global?: boolean
},
include_all_certificates_in_crl?: boolean,
issue_end_entities?: boolean,
issue_ica_intermediates?: boolean,
issue_types?: string[],
issue_unmanaged_ca?: boolean,
ocsp?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap | string,
type?: string[]
}[],
include?: string,
override_global?: boolean,
uri_path?: string
},
ocsp_responder?: {
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
certificate_template?: {
access?: string,
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
category?: string,
cert_type?: root | intermediate | end_entity,
created_date?: string,
id?: string,
install_type?: string,
issue_types?: string[],
kind?: string,
name?: string,
template_json?: string,
trust_type?: string,
updated_date?: string
},
delete_expired_responders?: boolean,
generation_enabled?: boolean,
hsm_partition?: {
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
},
override_global?: boolean,
responder_create_within_days?: number,
responder_validity_days?: number
}
}
extensions full type
extensions full type
{
adobe_archive_rev_info?: {
version?: number
},
adobe_timestamp?: {
location?: string,
requires_auth?: boolean,
version?: number
},
aia?: {
issuer_urls?: string[]
},
aki?: {
authority_name_serial_number?: boolean,
include?: string,
key_identifier?: boolean
},
basic_constraints?: {
ca?: boolean,
critical?: boolean,
path_length?: number
},
cabf_organization_identifier?: {
country?: string,
reference?: string,
scheme?: string,
state?: string
},
cdp?: {
urls?: string[]
},
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
extended_key_usage?: {
additional_values?: string[],
critical?: boolean
},
extensions_order?: string[],
issuer_alt_name?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
key_usage?: {
additional_values?: string[],
critical?: boolean,
skip_validation?: boolean
},
lei?: {
value?: string
},
lei_role?: {
value?: string
},
microsoft_application_certificate_policies?: {
additional_values?: string[],
critical?: boolean
},
microsoft_certificate_template_name?: string,
microsoft_certificate_template_v2?: {
major_version?: number,
minor_version?: number,
oid?: string
},
private_key_usage_period?: {
critical?: any,
not_after?: string,
not_before?: string
},
qc_statements?: {
critical?: boolean,
etsi-psd2-qcStatement?: string[],
id-etsi-qcs-QcPDS?: {
language?: string,
uri?: string
}[],
id-etsi-qcs-QcRetentionPeriod?: number,
id-etsi-qcs-QcType?: string[],
id-qcs-pkixQCSyntax-v2?: {
semantics_id?: string
},
oids?: string[]
},
san?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
security_identifier?: {
oid?: string,
value?: string
}[],
ski?: {
include?: string,
method?: string
},
ski_extension?: string,
smime_capabilities?: {
values?: string[]
},
subject_directory_attributes?: {
encoded_value?: number[]
}
}
hsm_partition full type
hsm_partition full type
{
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
}
issuer full type
issuer full type
{
hosted_type?: online | offline | third_party | string,
id?: string,
name?: string,
valid_from?: string,
valid_to?: string
}
key_generation full type
key_generation full type
{
dilithium_key_size?: string,
ecc_curve?: string,
ecdsa_curve?: string,
falcon_key_size?: string,
key_type?: string,
rsa_key_bits?: number,
sphincs_key_size?: string
}
notification full type
notification full type
{
enabled?: boolean,
frequency?: number[],
recipients?: string[]
}
private_key full type
private_key full type
{
password?: string,
pkcs12?: number[],
pre_installed?: boolean
}
recertification_links full type
recertification_links full type
{
created_date?: string,
link_type?: string,
linked_ca?: string
}[]
reinstate_requests full type
reinstate_requests full type
{
comments?: string,
id?: string,
requester_user_id?: string,
requester_username?: string,
reviewer_user_id?: string
}[]
revocation full type
revocation full type
{
comments?: string,
reason?: string,
revoke_date?: string,
revoked?: boolean
}
revocation_requests full type
revocation_requests full type
{
comments?: string,
id?: string,
reason?: string,
requester_user_id?: string,
requester_username?: string,
reviewer_user_id?: string,
revocation_date?: string
}[]
subject full type
subject full type
{
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
validity full type
validity full type
{
duration_unit?: string,
duration_value?: number,
valid_from?: string,
valid_to?: string
}
postCreateACustomCertificateTemplate
privateCAApi.postCreateACustomCertificateTemplate
Create a custom certificate template
Risk: write
await corsair.digicert.api.privateCAApi.postCreateACustomCertificateTemplate({
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
access?: string,
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
category?: string,
cert_type?: root | intermediate | end_entity,
created_date?: string,
id?: string,
install_type?: string,
issue_types?: string[],
kind?: string,
name?: string,
template_json?: string,
trust_type?: string,
updated_date?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
access | string | No | — |
accounts | object[] | No | — |
active | boolean | No | — |
category | string | No | — |
cert_type | root | intermediate | end_entity | string | No | — |
created_date | string | No | — |
id | string | No | — |
install_type | string | No | — |
issue_types | string[] | No | — |
kind | string | No | — |
name | string | No | — |
template_json | string | No | — |
trust_type | string | No | — |
updated_date | string | No | — |
accounts full type
accounts full type
{
id?: string,
name?: string
}[]
postCreateAnOcspResponder
privateCAApi.postCreateAnOcspResponder
Create an OCSP responder
Risk: write
await corsair.digicert.api.privateCAApi.postCreateAnOcspResponder({
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
blob?: string,
created_date?: string,
csr?: number[],
csr_blob?: string,
delegated_scope?: {
ica_rules?: {
}
},
extensions?: {
adobe_archive_rev_info?: {
version?: number
},
adobe_timestamp?: {
location?: string,
requires_auth?: boolean,
version?: number
},
aia?: {
issuer_urls?: string[]
},
aki?: {
authority_name_serial_number?: boolean,
include?: string,
key_identifier?: boolean
},
basic_constraints?: {
ca?: boolean,
critical?: boolean,
path_length?: number
},
cabf_organization_identifier?: {
country?: string,
reference?: string,
scheme?: string,
state?: string
},
cdp?: {
urls?: string[]
},
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
extended_key_usage?: {
additional_values?: string[],
critical?: boolean
},
extensions_order?: string[],
issuer_alt_name?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
key_usage?: {
additional_values?: string[],
critical?: boolean,
skip_validation?: boolean
},
lei?: {
value?: string
},
lei_role?: {
value?: string
},
microsoft_application_certificate_policies?: {
additional_values?: string[],
critical?: boolean
},
microsoft_certificate_template_name?: string,
microsoft_certificate_template_v2?: {
major_version?: number,
minor_version?: number,
oid?: string
},
private_key_usage_period?: {
critical?: any,
not_after?: string,
not_before?: string
},
qc_statements?: {
critical?: boolean,
etsi-psd2-qcStatement?: string[],
id-etsi-qcs-QcPDS?: {
language?: string,
uri?: string
}[],
id-etsi-qcs-QcRetentionPeriod?: number,
id-etsi-qcs-QcType?: string[],
id-qcs-pkixQCSyntax-v2?: {
semantics_id?: string
},
oids?: string[]
},
san?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
security_identifier?: {
oid?: string,
value?: string
}[],
ski?: {
include?: string,
method?: string
},
ski_extension?: string,
smime_capabilities?: {
values?: string[]
},
subject_directory_attributes?: {
encoded_value?: number[]
}
},
hsm_provider?: {
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
},
id?: string,
issuer?: {
hosted_type?: online | offline | third_party,
id?: string,
name?: string,
valid_from?: string,
valid_to?: string
},
key_generation?: {
dilithium_key_size?: string,
ecc_curve?: string,
ecdsa_curve?: string,
falcon_key_size?: string,
key_type?: string,
rsa_key_bits?: number,
sphincs_key_size?: string
},
key_name?: string,
name?: string,
notification?: {
enabled?: boolean,
frequency?: number[],
recipients?: string[]
},
private_key?: {
password?: string,
pkcs12?: number[],
pre_installed?: boolean
},
responder_type?: string,
serial_number?: string,
signature_algorithm?: string,
status?: string,
updated_date?: string,
validity?: {
duration_unit?: string,
duration_value?: number,
valid_from?: string,
valid_to?: string
},
validity_truncate?: boolean
}
| Name | Type | Required | Description |
|---|---|---|---|
blob | string | No | — |
created_date | string | No | — |
csr | number[] | No | — |
csr_blob | string | No | — |
delegated_scope | object | No | — |
extensions | object | No | — |
hsm_provider | object | No | — |
id | string | No | — |
issuer | object | No | — |
key_generation | object | No | — |
key_name | string | No | — |
name | string | No | — |
notification | object | No | — |
private_key | object | No | — |
responder_type | string | No | — |
serial_number | string | No | — |
signature_algorithm | string | No | — |
status | string | No | — |
updated_date | string | No | — |
validity | object | No | — |
validity_truncate | boolean | No | — |
delegated_scope full type
delegated_scope full type
{
ica_rules?: {
}
}
extensions full type
extensions full type
{
adobe_archive_rev_info?: {
version?: number
},
adobe_timestamp?: {
location?: string,
requires_auth?: boolean,
version?: number
},
aia?: {
issuer_urls?: string[]
},
aki?: {
authority_name_serial_number?: boolean,
include?: string,
key_identifier?: boolean
},
basic_constraints?: {
ca?: boolean,
critical?: boolean,
path_length?: number
},
cabf_organization_identifier?: {
country?: string,
reference?: string,
scheme?: string,
state?: string
},
cdp?: {
urls?: string[]
},
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
extended_key_usage?: {
additional_values?: string[],
critical?: boolean
},
extensions_order?: string[],
issuer_alt_name?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
key_usage?: {
additional_values?: string[],
critical?: boolean,
skip_validation?: boolean
},
lei?: {
value?: string
},
lei_role?: {
value?: string
},
microsoft_application_certificate_policies?: {
additional_values?: string[],
critical?: boolean
},
microsoft_certificate_template_name?: string,
microsoft_certificate_template_v2?: {
major_version?: number,
minor_version?: number,
oid?: string
},
private_key_usage_period?: {
critical?: any,
not_after?: string,
not_before?: string
},
qc_statements?: {
critical?: boolean,
etsi-psd2-qcStatement?: string[],
id-etsi-qcs-QcPDS?: {
language?: string,
uri?: string
}[],
id-etsi-qcs-QcRetentionPeriod?: number,
id-etsi-qcs-QcType?: string[],
id-qcs-pkixQCSyntax-v2?: {
semantics_id?: string
},
oids?: string[]
},
san?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
security_identifier?: {
oid?: string,
value?: string
}[],
ski?: {
include?: string,
method?: string
},
ski_extension?: string,
smime_capabilities?: {
values?: string[]
},
subject_directory_attributes?: {
encoded_value?: number[]
}
}
hsm_provider full type
hsm_provider full type
{
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
}
issuer full type
issuer full type
{
hosted_type?: online | offline | third_party | string,
id?: string,
name?: string,
valid_from?: string,
valid_to?: string
}
key_generation full type
key_generation full type
{
dilithium_key_size?: string,
ecc_curve?: string,
ecdsa_curve?: string,
falcon_key_size?: string,
key_type?: string,
rsa_key_bits?: number,
sphincs_key_size?: string
}
notification full type
notification full type
{
enabled?: boolean,
frequency?: number[],
recipients?: string[]
}
private_key full type
private_key full type
{
password?: string,
pkcs12?: number[],
pre_installed?: boolean
}
validity full type
validity full type
{
duration_unit?: string,
duration_value?: number,
valid_from?: string,
valid_to?: string
}
postCreateAPendingDelegatedOcspResponder
privateCAApi.postCreateAPendingDelegatedOcspResponder
Create a pending Delegated OCSP responder
Risk: write
await corsair.digicert.api.privateCAApi.postCreateAPendingDelegatedOcspResponder({
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
blob?: string,
created_date?: string,
csr?: number[],
csr_blob?: string,
delegated_scope?: {
ica_rules?: {
}
},
extensions?: {
adobe_archive_rev_info?: {
version?: number
},
adobe_timestamp?: {
location?: string,
requires_auth?: boolean,
version?: number
},
aia?: {
issuer_urls?: string[]
},
aki?: {
authority_name_serial_number?: boolean,
include?: string,
key_identifier?: boolean
},
basic_constraints?: {
ca?: boolean,
critical?: boolean,
path_length?: number
},
cabf_organization_identifier?: {
country?: string,
reference?: string,
scheme?: string,
state?: string
},
cdp?: {
urls?: string[]
},
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
extended_key_usage?: {
additional_values?: string[],
critical?: boolean
},
extensions_order?: string[],
issuer_alt_name?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
key_usage?: {
additional_values?: string[],
critical?: boolean,
skip_validation?: boolean
},
lei?: {
value?: string
},
lei_role?: {
value?: string
},
microsoft_application_certificate_policies?: {
additional_values?: string[],
critical?: boolean
},
microsoft_certificate_template_name?: string,
microsoft_certificate_template_v2?: {
major_version?: number,
minor_version?: number,
oid?: string
},
private_key_usage_period?: {
critical?: any,
not_after?: string,
not_before?: string
},
qc_statements?: {
critical?: boolean,
etsi-psd2-qcStatement?: string[],
id-etsi-qcs-QcPDS?: {
language?: string,
uri?: string
}[],
id-etsi-qcs-QcRetentionPeriod?: number,
id-etsi-qcs-QcType?: string[],
id-qcs-pkixQCSyntax-v2?: {
semantics_id?: string
},
oids?: string[]
},
san?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
security_identifier?: {
oid?: string,
value?: string
}[],
ski?: {
include?: string,
method?: string
},
ski_extension?: string,
smime_capabilities?: {
values?: string[]
},
subject_directory_attributes?: {
encoded_value?: number[]
}
},
hsm_provider?: {
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
},
id?: string,
issuer?: {
hosted_type?: online | offline | third_party,
id?: string,
name?: string,
valid_from?: string,
valid_to?: string
},
key_generation?: {
dilithium_key_size?: string,
ecc_curve?: string,
ecdsa_curve?: string,
falcon_key_size?: string,
key_type?: string,
rsa_key_bits?: number,
sphincs_key_size?: string
},
key_name?: string,
name?: string,
notification?: {
enabled?: boolean,
frequency?: number[],
recipients?: string[]
},
private_key?: {
password?: string,
pkcs12?: number[],
pre_installed?: boolean
},
responder_type?: string,
serial_number?: string,
signature_algorithm?: string,
status?: string,
updated_date?: string,
validity?: {
duration_unit?: string,
duration_value?: number,
valid_from?: string,
valid_to?: string
},
validity_truncate?: boolean
}
| Name | Type | Required | Description |
|---|---|---|---|
blob | string | No | — |
created_date | string | No | — |
csr | number[] | No | — |
csr_blob | string | No | — |
delegated_scope | object | No | — |
extensions | object | No | — |
hsm_provider | object | No | — |
id | string | No | — |
issuer | object | No | — |
key_generation | object | No | — |
key_name | string | No | — |
name | string | No | — |
notification | object | No | — |
private_key | object | No | — |
responder_type | string | No | — |
serial_number | string | No | — |
signature_algorithm | string | No | — |
status | string | No | — |
updated_date | string | No | — |
validity | object | No | — |
validity_truncate | boolean | No | — |
delegated_scope full type
delegated_scope full type
{
ica_rules?: {
}
}
extensions full type
extensions full type
{
adobe_archive_rev_info?: {
version?: number
},
adobe_timestamp?: {
location?: string,
requires_auth?: boolean,
version?: number
},
aia?: {
issuer_urls?: string[]
},
aki?: {
authority_name_serial_number?: boolean,
include?: string,
key_identifier?: boolean
},
basic_constraints?: {
ca?: boolean,
critical?: boolean,
path_length?: number
},
cabf_organization_identifier?: {
country?: string,
reference?: string,
scheme?: string,
state?: string
},
cdp?: {
urls?: string[]
},
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
extended_key_usage?: {
additional_values?: string[],
critical?: boolean
},
extensions_order?: string[],
issuer_alt_name?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
key_usage?: {
additional_values?: string[],
critical?: boolean,
skip_validation?: boolean
},
lei?: {
value?: string
},
lei_role?: {
value?: string
},
microsoft_application_certificate_policies?: {
additional_values?: string[],
critical?: boolean
},
microsoft_certificate_template_name?: string,
microsoft_certificate_template_v2?: {
major_version?: number,
minor_version?: number,
oid?: string
},
private_key_usage_period?: {
critical?: any,
not_after?: string,
not_before?: string
},
qc_statements?: {
critical?: boolean,
etsi-psd2-qcStatement?: string[],
id-etsi-qcs-QcPDS?: {
language?: string,
uri?: string
}[],
id-etsi-qcs-QcRetentionPeriod?: number,
id-etsi-qcs-QcType?: string[],
id-qcs-pkixQCSyntax-v2?: {
semantics_id?: string
},
oids?: string[]
},
san?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
security_identifier?: {
oid?: string,
value?: string
}[],
ski?: {
include?: string,
method?: string
},
ski_extension?: string,
smime_capabilities?: {
values?: string[]
},
subject_directory_attributes?: {
encoded_value?: number[]
}
}
hsm_provider full type
hsm_provider full type
{
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
}
issuer full type
issuer full type
{
hosted_type?: online | offline | third_party | string,
id?: string,
name?: string,
valid_from?: string,
valid_to?: string
}
key_generation full type
key_generation full type
{
dilithium_key_size?: string,
ecc_curve?: string,
ecdsa_curve?: string,
falcon_key_size?: string,
key_type?: string,
rsa_key_bits?: number,
sphincs_key_size?: string
}
notification full type
notification full type
{
enabled?: boolean,
frequency?: number[],
recipients?: string[]
}
private_key full type
private_key full type
{
password?: string,
pkcs12?: number[],
pre_installed?: boolean
}
validity full type
validity full type
{
duration_unit?: string,
duration_value?: number,
valid_from?: string,
valid_to?: string
}
postCreateAPendingOcspResponder
privateCAApi.postCreateAPendingOcspResponder
Create a pending OCSP responder
Risk: write
await corsair.digicert.api.privateCAApi.postCreateAPendingOcspResponder({
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
blob?: string,
created_date?: string,
csr?: number[],
csr_blob?: string,
delegated_scope?: {
ica_rules?: {
}
},
extensions?: {
adobe_archive_rev_info?: {
version?: number
},
adobe_timestamp?: {
location?: string,
requires_auth?: boolean,
version?: number
},
aia?: {
issuer_urls?: string[]
},
aki?: {
authority_name_serial_number?: boolean,
include?: string,
key_identifier?: boolean
},
basic_constraints?: {
ca?: boolean,
critical?: boolean,
path_length?: number
},
cabf_organization_identifier?: {
country?: string,
reference?: string,
scheme?: string,
state?: string
},
cdp?: {
urls?: string[]
},
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
extended_key_usage?: {
additional_values?: string[],
critical?: boolean
},
extensions_order?: string[],
issuer_alt_name?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
key_usage?: {
additional_values?: string[],
critical?: boolean,
skip_validation?: boolean
},
lei?: {
value?: string
},
lei_role?: {
value?: string
},
microsoft_application_certificate_policies?: {
additional_values?: string[],
critical?: boolean
},
microsoft_certificate_template_name?: string,
microsoft_certificate_template_v2?: {
major_version?: number,
minor_version?: number,
oid?: string
},
private_key_usage_period?: {
critical?: any,
not_after?: string,
not_before?: string
},
qc_statements?: {
critical?: boolean,
etsi-psd2-qcStatement?: string[],
id-etsi-qcs-QcPDS?: {
language?: string,
uri?: string
}[],
id-etsi-qcs-QcRetentionPeriod?: number,
id-etsi-qcs-QcType?: string[],
id-qcs-pkixQCSyntax-v2?: {
semantics_id?: string
},
oids?: string[]
},
san?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
security_identifier?: {
oid?: string,
value?: string
}[],
ski?: {
include?: string,
method?: string
},
ski_extension?: string,
smime_capabilities?: {
values?: string[]
},
subject_directory_attributes?: {
encoded_value?: number[]
}
},
hsm_provider?: {
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
},
id?: string,
issuer?: {
hosted_type?: online | offline | third_party,
id?: string,
name?: string,
valid_from?: string,
valid_to?: string
},
key_generation?: {
dilithium_key_size?: string,
ecc_curve?: string,
ecdsa_curve?: string,
falcon_key_size?: string,
key_type?: string,
rsa_key_bits?: number,
sphincs_key_size?: string
},
key_name?: string,
name?: string,
notification?: {
enabled?: boolean,
frequency?: number[],
recipients?: string[]
},
private_key?: {
password?: string,
pkcs12?: number[],
pre_installed?: boolean
},
responder_type?: string,
serial_number?: string,
signature_algorithm?: string,
status?: string,
updated_date?: string,
validity?: {
duration_unit?: string,
duration_value?: number,
valid_from?: string,
valid_to?: string
},
validity_truncate?: boolean
}
| Name | Type | Required | Description |
|---|---|---|---|
blob | string | No | — |
created_date | string | No | — |
csr | number[] | No | — |
csr_blob | string | No | — |
delegated_scope | object | No | — |
extensions | object | No | — |
hsm_provider | object | No | — |
id | string | No | — |
issuer | object | No | — |
key_generation | object | No | — |
key_name | string | No | — |
name | string | No | — |
notification | object | No | — |
private_key | object | No | — |
responder_type | string | No | — |
serial_number | string | No | — |
signature_algorithm | string | No | — |
status | string | No | — |
updated_date | string | No | — |
validity | object | No | — |
validity_truncate | boolean | No | — |
delegated_scope full type
delegated_scope full type
{
ica_rules?: {
}
}
extensions full type
extensions full type
{
adobe_archive_rev_info?: {
version?: number
},
adobe_timestamp?: {
location?: string,
requires_auth?: boolean,
version?: number
},
aia?: {
issuer_urls?: string[]
},
aki?: {
authority_name_serial_number?: boolean,
include?: string,
key_identifier?: boolean
},
basic_constraints?: {
ca?: boolean,
critical?: boolean,
path_length?: number
},
cabf_organization_identifier?: {
country?: string,
reference?: string,
scheme?: string,
state?: string
},
cdp?: {
urls?: string[]
},
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
extended_key_usage?: {
additional_values?: string[],
critical?: boolean
},
extensions_order?: string[],
issuer_alt_name?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
key_usage?: {
additional_values?: string[],
critical?: boolean,
skip_validation?: boolean
},
lei?: {
value?: string
},
lei_role?: {
value?: string
},
microsoft_application_certificate_policies?: {
additional_values?: string[],
critical?: boolean
},
microsoft_certificate_template_name?: string,
microsoft_certificate_template_v2?: {
major_version?: number,
minor_version?: number,
oid?: string
},
private_key_usage_period?: {
critical?: any,
not_after?: string,
not_before?: string
},
qc_statements?: {
critical?: boolean,
etsi-psd2-qcStatement?: string[],
id-etsi-qcs-QcPDS?: {
language?: string,
uri?: string
}[],
id-etsi-qcs-QcRetentionPeriod?: number,
id-etsi-qcs-QcType?: string[],
id-qcs-pkixQCSyntax-v2?: {
semantics_id?: string
},
oids?: string[]
},
san?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
security_identifier?: {
oid?: string,
value?: string
}[],
ski?: {
include?: string,
method?: string
},
ski_extension?: string,
smime_capabilities?: {
values?: string[]
},
subject_directory_attributes?: {
encoded_value?: number[]
}
}
hsm_provider full type
hsm_provider full type
{
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
}
issuer full type
issuer full type
{
hosted_type?: online | offline | third_party | string,
id?: string,
name?: string,
valid_from?: string,
valid_to?: string
}
key_generation full type
key_generation full type
{
dilithium_key_size?: string,
ecc_curve?: string,
ecdsa_curve?: string,
falcon_key_size?: string,
key_type?: string,
rsa_key_bits?: number,
sphincs_key_size?: string
}
notification full type
notification full type
{
enabled?: boolean,
frequency?: number[],
recipients?: string[]
}
private_key full type
private_key full type
{
password?: string,
pkcs12?: number[],
pre_installed?: boolean
}
validity full type
validity full type
{
duration_unit?: string,
duration_value?: number,
valid_from?: string,
valid_to?: string
}
postCreateCaNote
privateCAApi.postCreateCaNote
Create CA Note
Risk: write
await corsair.digicert.api.privateCAApi.postCreateCaNote({
path: { id: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
created_date?: string,
id?: string,
text?: string,
user_email?: string,
user_full_name?: string,
user_id?: string
}
undefined
postCreateCaReinstateRequest
privateCAApi.postCreateCaReinstateRequest
Create CA Reinstate Request
Risk: write
await corsair.digicert.api.privateCAApi.postCreateCaReinstateRequest({
path: { id: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
comments?: string,
id?: string,
requester_user_id?: string,
requester_username?: string,
reviewer_user_id?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
comments | string | No | — |
id | string | No | — |
requester_user_id | string | No | — |
requester_username | string | No | — |
reviewer_user_id | string | No | — |
postCreateCaRevokeRequest
privateCAApi.postCreateCaRevokeRequest
Create CA Revoke Request
Risk: write
await corsair.digicert.api.privateCAApi.postCreateCaRevokeRequest({
path: { id: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
comments?: string,
id?: string,
reason?: string,
requester_user_id?: string,
requester_username?: string,
reviewer_user_id?: string,
revocation_date?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
comments | string | No | — |
id | string | No | — |
reason | string | No | — |
requester_user_id | string | No | — |
requester_username | string | No | — |
reviewer_user_id | string | No | — |
revocation_date | string | No | — |
postCreateCertificate
privateCAApi.postCreateCertificate
Create Certificate
Risk: write
await corsair.digicert.api.privateCAApi.postCreateCertificate({
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account_assignments?: {
id?: string,
name?: string
}[],
account_id?: string,
blob?: number[],
cert_type?: string,
chain?: {
blob?: string,
cert_type?: string,
subject?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
}[],
csr?: string,
csr_type?: string,
custom_values?: {
},
escrow_private_key?: boolean,
extensions?: {
adobe_archive_rev_info?: {
version?: number
},
adobe_timestamp?: {
location?: string,
requires_auth?: boolean,
version?: number
},
aia?: {
issuer_urls?: string[]
},
aki?: {
authority_name_serial_number?: boolean,
include?: string,
key_identifier?: boolean
},
basic_constraints?: {
ca?: boolean,
critical?: boolean,
path_length?: number
},
cabf_organization_identifier?: {
country?: string,
reference?: string,
scheme?: string,
state?: string
},
cdp?: {
urls?: string[]
},
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
extended_key_usage?: {
additional_values?: string[],
critical?: boolean
},
extensions_order?: string[],
issuer_alt_name?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
key_usage?: {
additional_values?: string[],
critical?: boolean,
skip_validation?: boolean
},
lei?: {
value?: string
},
lei_role?: {
value?: string
},
microsoft_application_certificate_policies?: {
additional_values?: string[],
critical?: boolean
},
microsoft_certificate_template_name?: string,
microsoft_certificate_template_v2?: {
major_version?: number,
minor_version?: number,
oid?: string
},
private_key_usage_period?: {
critical?: any,
not_after?: string,
not_before?: string
},
qc_statements?: {
critical?: boolean,
etsi-psd2-qcStatement?: string[],
id-etsi-qcs-QcPDS?: {
language?: string,
uri?: string
}[],
id-etsi-qcs-QcRetentionPeriod?: number,
id-etsi-qcs-QcType?: string[],
id-qcs-pkixQCSyntax-v2?: {
semantics_id?: string
},
oids?: string[]
},
san?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
security_identifier?: {
oid?: string,
value?: string
}[],
ski?: {
include?: string,
method?: string
},
ski_extension?: string,
smime_capabilities?: {
values?: string[]
},
subject_directory_attributes?: {
encoded_value?: number[]
}
},
hosted_type?: string,
id?: string,
issuer?: {
id?: string,
name?: string,
trust_type?: string
},
issuer_subject?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
},
key_generation?: {
dilithium_key_size?: string,
ecc_curve?: string,
ecdsa_curve?: string,
falcon_key_size?: string,
key_type?: string,
rsa_key_bits?: number,
sphincs_key_size?: string
},
kind?: string,
notification?: {
enabled?: boolean,
frequency?: number[],
recipients?: string[]
},
ocsp_key_hash_alg?: string,
options?: {
chain_name?: string
},
revocation?: {
comments?: string,
reason?: string,
revoke_date?: string,
revoked?: boolean
},
serial_number?: string,
signature_algorithm?: string,
subject?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
},
template?: string,
template_id?: string,
thumbprint_sha256?: string,
trust_type?: string,
validity?: {
duration_unit?: string,
duration_value?: number,
valid_from?: string,
valid_to?: string
}
}
| Name | Type | Required | Description |
|---|---|---|---|
account_assignments | object[] | No | — |
account_id | string | No | — |
blob | number[] | No | — |
cert_type | string | No | — |
chain | object[] | No | — |
csr | string | No | — |
csr_type | string | No | — |
custom_values | object | No | — |
escrow_private_key | boolean | No | — |
extensions | object | No | — |
hosted_type | string | No | — |
id | string | No | — |
issuer | object | No | — |
issuer_subject | object | No | — |
key_generation | object | No | — |
kind | string | No | — |
notification | object | No | — |
ocsp_key_hash_alg | string | No | — |
options | object | No | — |
revocation | object | No | — |
serial_number | string | No | — |
signature_algorithm | string | No | — |
subject | object | No | — |
template | string | No | — |
template_id | string | No | — |
thumbprint_sha256 | string | No | — |
trust_type | string | No | — |
validity | object | No | — |
account_assignments full type
account_assignments full type
{
id?: string,
name?: string
}[]
chain full type
chain full type
{
blob?: string,
cert_type?: string,
subject?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
}[]
custom_values full type
custom_values full type
{
}
extensions full type
extensions full type
{
adobe_archive_rev_info?: {
version?: number
},
adobe_timestamp?: {
location?: string,
requires_auth?: boolean,
version?: number
},
aia?: {
issuer_urls?: string[]
},
aki?: {
authority_name_serial_number?: boolean,
include?: string,
key_identifier?: boolean
},
basic_constraints?: {
ca?: boolean,
critical?: boolean,
path_length?: number
},
cabf_organization_identifier?: {
country?: string,
reference?: string,
scheme?: string,
state?: string
},
cdp?: {
urls?: string[]
},
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
extended_key_usage?: {
additional_values?: string[],
critical?: boolean
},
extensions_order?: string[],
issuer_alt_name?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
key_usage?: {
additional_values?: string[],
critical?: boolean,
skip_validation?: boolean
},
lei?: {
value?: string
},
lei_role?: {
value?: string
},
microsoft_application_certificate_policies?: {
additional_values?: string[],
critical?: boolean
},
microsoft_certificate_template_name?: string,
microsoft_certificate_template_v2?: {
major_version?: number,
minor_version?: number,
oid?: string
},
private_key_usage_period?: {
critical?: any,
not_after?: string,
not_before?: string
},
qc_statements?: {
critical?: boolean,
etsi-psd2-qcStatement?: string[],
id-etsi-qcs-QcPDS?: {
language?: string,
uri?: string
}[],
id-etsi-qcs-QcRetentionPeriod?: number,
id-etsi-qcs-QcType?: string[],
id-qcs-pkixQCSyntax-v2?: {
semantics_id?: string
},
oids?: string[]
},
san?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
security_identifier?: {
oid?: string,
value?: string
}[],
ski?: {
include?: string,
method?: string
},
ski_extension?: string,
smime_capabilities?: {
values?: string[]
},
subject_directory_attributes?: {
encoded_value?: number[]
}
}
issuer full type
issuer full type
{
id?: string,
name?: string,
trust_type?: string
}
issuer_subject full type
issuer_subject full type
{
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
key_generation full type
key_generation full type
{
dilithium_key_size?: string,
ecc_curve?: string,
ecdsa_curve?: string,
falcon_key_size?: string,
key_type?: string,
rsa_key_bits?: number,
sphincs_key_size?: string
}
notification full type
notification full type
{
enabled?: boolean,
frequency?: number[],
recipients?: string[]
}
options full type
options full type
{
chain_name?: string
}
revocation full type
revocation full type
{
comments?: string,
reason?: string,
revoke_date?: string,
revoked?: boolean
}
subject full type
subject full type
{
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
validity full type
validity full type
{
duration_unit?: string,
duration_value?: number,
valid_from?: string,
valid_to?: string
}
postCreateCrlNow
privateCAApi.postCreateCrlNow
Create CRL Now
Risk: write
await corsair.digicert.api.privateCAApi.postCreateCrlNow({
path: { id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
postCreateOrUpdateSamlConfiguration
privateCAApi.postCreateOrUpdateSamlConfiguration
Create or Update SAML Configuration
Risk: write
await corsair.digicert.api.privateCAApi.postCreateOrUpdateSamlConfiguration({
body: {
idpCertificate: 'example',
idpEntityId: 'example',
idpMetadataXml: 'example',
idpSsoUrl: 'example',
spAcsUrl: 'example',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
enabled?: boolean,
idpCertificate: string,
idpEntityId: string,
idpMetadataUrl?: string,
idpMetadataXml: string,
idpSloUrl?: string,
idpSsoUrl: string,
roleMappingJson?: string,
spAcsUrl: string,
spEntityId?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
message | string | No | — |
postDecryptAPkcs7
privateCAApi.postDecryptAPkcs7
Decrypt a PKCS7
Risk: write
await corsair.digicert.api.privateCAApi.postDecryptAPkcs7({
path: { id: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
pkcs7?: number[]
}
| Name | Type | Required | Description |
|---|---|---|---|
content_data | number[] | No | — |
content_type | string | No | — |
encryption_algorithm | string | No | — |
signers | object[] | No | — |
signers full type
signers full type
{
authenticated_attributes?: {
oid?: string,
raw_value?: number[],
simple_value?: string,
value_type?: string
}[],
certificate?: number[],
signature_algorithm?: string
}[]
postEncryptAPkcs7
privateCAApi.postEncryptAPkcs7
Encrypt a PKCS7
Risk: write
await corsair.digicert.api.privateCAApi.postEncryptAPkcs7({
path: { id: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
pkcs7?: number[]
}
| Name | Type | Required | Description |
|---|---|---|---|
pkcs7 | number[] | No | — |
postHandleScepPkiOperation
privateCAApi.postHandleScepPkiOperation
Handle SCEP PKI operation
Risk: write
await corsair.digicert.api.privateCAApi.postHandleScepPkiOperation({
path: { profileID: 'example' },
body: [1],
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | number[] | Yes | — |
path full type
path full type
{
profileID: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
number[]
postImportACa
privateCAApi.postImportACa
Import a CA
Risk: write
await corsair.digicert.api.privateCAApi.postImportACa({
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account_assignments?: {
id?: string,
name?: string
}[],
active_aia_issuer?: {
file_name?: string,
id?: string
},
active_arl?: {
file_name?: string,
file_path?: string,
id?: string
},
active_crl?: {
file_name?: string,
file_path?: string,
id?: string
},
active_crl_cdps?: {
cdps?: string[]
},
active_eerl?: {
file_name?: string,
file_path?: string,
id?: string
},
allow_unmatched_cdp?: boolean,
blob?: string,
ca_type?: string,
cert_type?: string,
configuration?: {
aia_issuer?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap,
type?: string[]
}[],
include?: string,
override_global?: boolean
},
allow_extended_validity?: boolean,
allow_pkcs7_operations?: boolean,
allowed_signature_algorithms?: string[],
available_signature_algorithms?: string[],
certificate_policies?: {
allowed_sources?: string[],
default_policies?: {
critical?: boolean,
policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[]
},
include?: string,
override_global?: boolean
},
chains?: {
certificates?: {
blob?: string,
cert_type?: string,
subject?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
}[],
default?: boolean,
id?: string,
name?: string
}[],
crl?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap,
type?: string[]
}[],
end_validity_years?: number,
include?: string,
override_global?: boolean
},
include_all_certificates_in_crl?: boolean,
issue_end_entities?: boolean,
issue_ica_intermediates?: boolean,
issue_types?: string[],
issue_unmanaged_ca?: boolean,
ocsp?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap,
type?: string[]
}[],
include?: string,
override_global?: boolean,
uri_path?: string
},
ocsp_responder?: {
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
certificate_template?: {
access?: string,
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
category?: string,
cert_type?: root | intermediate | end_entity,
created_date?: string,
id?: string,
install_type?: string,
issue_types?: string[],
kind?: string,
name?: string,
template_json?: string,
trust_type?: string,
updated_date?: string
},
delete_expired_responders?: boolean,
generation_enabled?: boolean,
hsm_partition?: {
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
},
override_global?: boolean,
responder_create_within_days?: number,
responder_validity_days?: number
}
},
create_default_aia_issuer?: boolean,
create_default_crl?: boolean,
create_preview_cert?: boolean,
csr?: string,
exportable?: boolean,
extensions?: {
adobe_archive_rev_info?: {
version?: number
},
adobe_timestamp?: {
location?: string,
requires_auth?: boolean,
version?: number
},
aia?: {
issuer_urls?: string[]
},
aki?: {
authority_name_serial_number?: boolean,
include?: string,
key_identifier?: boolean
},
basic_constraints?: {
ca?: boolean,
critical?: boolean,
path_length?: number
},
cabf_organization_identifier?: {
country?: string,
reference?: string,
scheme?: string,
state?: string
},
cdp?: {
urls?: string[]
},
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
extended_key_usage?: {
additional_values?: string[],
critical?: boolean
},
extensions_order?: string[],
issuer_alt_name?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
key_usage?: {
additional_values?: string[],
critical?: boolean,
skip_validation?: boolean
},
lei?: {
value?: string
},
lei_role?: {
value?: string
},
microsoft_application_certificate_policies?: {
additional_values?: string[],
critical?: boolean
},
microsoft_certificate_template_name?: string,
microsoft_certificate_template_v2?: {
major_version?: number,
minor_version?: number,
oid?: string
},
private_key_usage_period?: {
critical?: any,
not_after?: string,
not_before?: string
},
qc_statements?: {
critical?: boolean,
etsi-psd2-qcStatement?: string[],
id-etsi-qcs-QcPDS?: {
language?: string,
uri?: string
}[],
id-etsi-qcs-QcRetentionPeriod?: number,
id-etsi-qcs-QcType?: string[],
id-qcs-pkixQCSyntax-v2?: {
semantics_id?: string
},
oids?: string[]
},
san?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
security_identifier?: {
oid?: string,
value?: string
}[],
ski?: {
include?: string,
method?: string
},
ski_extension?: string,
smime_capabilities?: {
values?: string[]
},
subject_directory_attributes?: {
encoded_value?: number[]
}
},
hosted_type?: online | offline | external | third_party,
hsm_key_label?: string,
hsm_partition?: {
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
},
id?: string,
is_composite_ca?: boolean,
issue_types?: string[],
issuer?: {
hosted_type?: online | offline | third_party,
id?: string,
name?: string,
valid_from?: string,
valid_to?: string
},
key_generation?: {
dilithium_key_size?: string,
ecc_curve?: string,
ecdsa_curve?: string,
falcon_key_size?: string,
key_type?: string,
rsa_key_bits?: number,
sphincs_key_size?: string
},
key_type?: rsa | ecc,
name?: string,
notification?: {
enabled?: boolean,
frequency?: number[],
recipients?: string[]
},
number_of_ica?: number,
pem?: string,
private_key?: {
password?: string,
pkcs12?: number[],
pre_installed?: boolean
},
recertification_links?: {
created_date?: string,
link_type?: string,
linked_ca?: string
}[],
reinstate_requests?: {
comments?: string,
id?: string,
requester_user_id?: string,
requester_username?: string,
reviewer_user_id?: string
}[],
revocation?: {
comments?: string,
reason?: string,
revoke_date?: string,
revoked?: boolean
},
revocation_requests?: {
comments?: string,
id?: string,
reason?: string,
requester_user_id?: string,
requester_username?: string,
reviewer_user_id?: string,
revocation_date?: string
}[],
serial_number?: string,
signature_algorithm?: string,
status?: active | pending_sign | disabled,
subject?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
},
template?: string,
template_id?: string,
thumbprint_sha256?: string,
trust_type?: string,
trust_types?: string[],
validity?: {
duration_unit?: string,
duration_value?: number,
valid_from?: string,
valid_to?: string
}
}
| Name | Type | Required | Description |
|---|---|---|---|
account_assignments | object[] | No | — |
active_aia_issuer | object | No | — |
active_arl | object | No | — |
active_crl | object | No | — |
active_crl_cdps | object | No | — |
active_eerl | object | No | — |
allow_unmatched_cdp | boolean | No | — |
blob | string | No | — |
ca_type | string | No | — |
cert_type | string | No | — |
configuration | object | No | — |
create_default_aia_issuer | boolean | No | — |
create_default_crl | boolean | No | — |
create_preview_cert | boolean | No | — |
csr | string | No | — |
exportable | boolean | No | — |
extensions | object | No | — |
hosted_type | online | offline | external | third_party | No | — |
hsm_key_label | string | No | — |
hsm_partition | object | No | — |
id | string | No | — |
is_composite_ca | boolean | No | — |
issue_types | string[] | No | — |
issuer | object | No | — |
key_generation | object | No | — |
key_type | rsa | ecc | string | No | — |
name | string | No | — |
notification | object | No | — |
number_of_ica | number | No | — |
pem | string | No | — |
private_key | object | No | — |
recertification_links | object[] | No | — |
reinstate_requests | object[] | No | — |
revocation | object | No | — |
revocation_requests | object[] | No | — |
serial_number | string | No | — |
signature_algorithm | string | No | — |
status | active | pending_sign | disabled | string | No | — |
subject | object | No | — |
template | string | No | — |
template_id | string | No | — |
thumbprint_sha256 | string | No | — |
trust_type | string | No | — |
trust_types | string[] | No | — |
validity | object | No | — |
account_assignments full type
account_assignments full type
{
id?: string,
name?: string
}[]
active_aia_issuer full type
active_aia_issuer full type
{
file_name?: string,
id?: string
}
active_arl full type
active_arl full type
{
file_name?: string,
file_path?: string,
id?: string
}
active_crl full type
active_crl full type
{
file_name?: string,
file_path?: string,
id?: string
}
active_crl_cdps full type
active_crl_cdps full type
{
cdps?: string[]
}
active_eerl full type
active_eerl full type
{
file_name?: string,
file_path?: string,
id?: string
}
configuration full type
configuration full type
{
aia_issuer?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap | string,
type?: string[]
}[],
include?: string,
override_global?: boolean
},
allow_extended_validity?: boolean,
allow_pkcs7_operations?: boolean,
allowed_signature_algorithms?: string[],
available_signature_algorithms?: string[],
certificate_policies?: {
allowed_sources?: string[],
default_policies?: {
critical?: boolean,
policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[]
},
include?: string,
override_global?: boolean
},
chains?: {
certificates?: {
blob?: string,
cert_type?: string,
subject?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
}[],
default?: boolean,
id?: string,
name?: string
}[],
crl?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap | string,
type?: string[]
}[],
end_validity_years?: number,
include?: string,
override_global?: boolean
},
include_all_certificates_in_crl?: boolean,
issue_end_entities?: boolean,
issue_ica_intermediates?: boolean,
issue_types?: string[],
issue_unmanaged_ca?: boolean,
ocsp?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap | string,
type?: string[]
}[],
include?: string,
override_global?: boolean,
uri_path?: string
},
ocsp_responder?: {
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
certificate_template?: {
access?: string,
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
category?: string,
cert_type?: root | intermediate | end_entity,
created_date?: string,
id?: string,
install_type?: string,
issue_types?: string[],
kind?: string,
name?: string,
template_json?: string,
trust_type?: string,
updated_date?: string
},
delete_expired_responders?: boolean,
generation_enabled?: boolean,
hsm_partition?: {
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
},
override_global?: boolean,
responder_create_within_days?: number,
responder_validity_days?: number
}
}
extensions full type
extensions full type
{
adobe_archive_rev_info?: {
version?: number
},
adobe_timestamp?: {
location?: string,
requires_auth?: boolean,
version?: number
},
aia?: {
issuer_urls?: string[]
},
aki?: {
authority_name_serial_number?: boolean,
include?: string,
key_identifier?: boolean
},
basic_constraints?: {
ca?: boolean,
critical?: boolean,
path_length?: number
},
cabf_organization_identifier?: {
country?: string,
reference?: string,
scheme?: string,
state?: string
},
cdp?: {
urls?: string[]
},
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
extended_key_usage?: {
additional_values?: string[],
critical?: boolean
},
extensions_order?: string[],
issuer_alt_name?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
key_usage?: {
additional_values?: string[],
critical?: boolean,
skip_validation?: boolean
},
lei?: {
value?: string
},
lei_role?: {
value?: string
},
microsoft_application_certificate_policies?: {
additional_values?: string[],
critical?: boolean
},
microsoft_certificate_template_name?: string,
microsoft_certificate_template_v2?: {
major_version?: number,
minor_version?: number,
oid?: string
},
private_key_usage_period?: {
critical?: any,
not_after?: string,
not_before?: string
},
qc_statements?: {
critical?: boolean,
etsi-psd2-qcStatement?: string[],
id-etsi-qcs-QcPDS?: {
language?: string,
uri?: string
}[],
id-etsi-qcs-QcRetentionPeriod?: number,
id-etsi-qcs-QcType?: string[],
id-qcs-pkixQCSyntax-v2?: {
semantics_id?: string
},
oids?: string[]
},
san?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
security_identifier?: {
oid?: string,
value?: string
}[],
ski?: {
include?: string,
method?: string
},
ski_extension?: string,
smime_capabilities?: {
values?: string[]
},
subject_directory_attributes?: {
encoded_value?: number[]
}
}
hsm_partition full type
hsm_partition full type
{
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
}
issuer full type
issuer full type
{
hosted_type?: online | offline | third_party | string,
id?: string,
name?: string,
valid_from?: string,
valid_to?: string
}
key_generation full type
key_generation full type
{
dilithium_key_size?: string,
ecc_curve?: string,
ecdsa_curve?: string,
falcon_key_size?: string,
key_type?: string,
rsa_key_bits?: number,
sphincs_key_size?: string
}
notification full type
notification full type
{
enabled?: boolean,
frequency?: number[],
recipients?: string[]
}
private_key full type
private_key full type
{
password?: string,
pkcs12?: number[],
pre_installed?: boolean
}
recertification_links full type
recertification_links full type
{
created_date?: string,
link_type?: string,
linked_ca?: string
}[]
reinstate_requests full type
reinstate_requests full type
{
comments?: string,
id?: string,
requester_user_id?: string,
requester_username?: string,
reviewer_user_id?: string
}[]
revocation full type
revocation full type
{
comments?: string,
reason?: string,
revoke_date?: string,
revoked?: boolean
}
revocation_requests full type
revocation_requests full type
{
comments?: string,
id?: string,
reason?: string,
requester_user_id?: string,
requester_username?: string,
reviewer_user_id?: string,
revocation_date?: string
}[]
subject full type
subject full type
{
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
validity full type
validity full type
{
duration_unit?: string,
duration_value?: number,
valid_from?: string,
valid_to?: string
}
postImportACertificate
privateCAApi.postImportACertificate
Import a certificate
Risk: write
await corsair.digicert.api.privateCAApi.postImportACertificate({
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
blob?: string,
revocation?: {
comments?: string,
reason?: string,
revoke_date?: string,
revoked?: boolean
}
}
| Name | Type | Required | Description |
|---|---|---|---|
account_assignments | object[] | No | — |
account_id | string | No | — |
blob | number[] | No | — |
cert_type | string | No | — |
chain | object[] | No | — |
csr | string | No | — |
csr_type | string | No | — |
custom_values | object | No | — |
escrow_private_key | boolean | No | — |
extensions | object | No | — |
hosted_type | string | No | — |
id | string | No | — |
issuer | object | No | — |
issuer_subject | object | No | — |
key_generation | object | No | — |
kind | string | No | — |
notification | object | No | — |
ocsp_key_hash_alg | string | No | — |
options | object | No | — |
revocation | object | No | — |
serial_number | string | No | — |
signature_algorithm | string | No | — |
subject | object | No | — |
template | string | No | — |
template_id | string | No | — |
thumbprint_sha256 | string | No | — |
trust_type | string | No | — |
validity | object | No | — |
account_assignments full type
account_assignments full type
{
id?: string,
name?: string
}[]
chain full type
chain full type
{
blob?: string,
cert_type?: string,
subject?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
}[]
custom_values full type
custom_values full type
{
}
extensions full type
extensions full type
{
adobe_archive_rev_info?: {
version?: number
},
adobe_timestamp?: {
location?: string,
requires_auth?: boolean,
version?: number
},
aia?: {
issuer_urls?: string[]
},
aki?: {
authority_name_serial_number?: boolean,
include?: string,
key_identifier?: boolean
},
basic_constraints?: {
ca?: boolean,
critical?: boolean,
path_length?: number
},
cabf_organization_identifier?: {
country?: string,
reference?: string,
scheme?: string,
state?: string
},
cdp?: {
urls?: string[]
},
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
extended_key_usage?: {
additional_values?: string[],
critical?: boolean
},
extensions_order?: string[],
issuer_alt_name?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
key_usage?: {
additional_values?: string[],
critical?: boolean,
skip_validation?: boolean
},
lei?: {
value?: string
},
lei_role?: {
value?: string
},
microsoft_application_certificate_policies?: {
additional_values?: string[],
critical?: boolean
},
microsoft_certificate_template_name?: string,
microsoft_certificate_template_v2?: {
major_version?: number,
minor_version?: number,
oid?: string
},
private_key_usage_period?: {
critical?: any,
not_after?: string,
not_before?: string
},
qc_statements?: {
critical?: boolean,
etsi-psd2-qcStatement?: string[],
id-etsi-qcs-QcPDS?: {
language?: string,
uri?: string
}[],
id-etsi-qcs-QcRetentionPeriod?: number,
id-etsi-qcs-QcType?: string[],
id-qcs-pkixQCSyntax-v2?: {
semantics_id?: string
},
oids?: string[]
},
san?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
security_identifier?: {
oid?: string,
value?: string
}[],
ski?: {
include?: string,
method?: string
},
ski_extension?: string,
smime_capabilities?: {
values?: string[]
},
subject_directory_attributes?: {
encoded_value?: number[]
}
}
issuer full type
issuer full type
{
id?: string,
name?: string,
trust_type?: string
}
issuer_subject full type
issuer_subject full type
{
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
key_generation full type
key_generation full type
{
dilithium_key_size?: string,
ecc_curve?: string,
ecdsa_curve?: string,
falcon_key_size?: string,
key_type?: string,
rsa_key_bits?: number,
sphincs_key_size?: string
}
notification full type
notification full type
{
enabled?: boolean,
frequency?: number[],
recipients?: string[]
}
options full type
options full type
{
chain_name?: string
}
revocation full type
revocation full type
{
comments?: string,
reason?: string,
revoke_date?: string,
revoked?: boolean
}
subject full type
subject full type
{
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
validity full type
validity full type
{
duration_unit?: string,
duration_value?: number,
valid_from?: string,
valid_to?: string
}
postImportAClientKey
privateCAApi.postImportAClientKey
Import a client key
Risk: write
await corsair.digicert.api.privateCAApi.postImportAClientKey({
body: { app_reference_id: 'example', partition_id: 'example', provider: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account_id?: string,
allowed_uses?: string[],
app_reference_id: string,
ec_point?: string,
ecdsa_curve?: string,
expiration_date?: string,
key_alg?: string,
key_label?: string,
key_size?: number,
modulus?: string,
partition_id: string,
provider: string,
rsa_public_exponent?: number
}
| Name | Type | Required | Description |
|---|---|---|---|
app_reference_id | string | No | — |
id | string | No | — |
subject_public_key_info | number[] | No | — |
postImportAnOcspResponder
privateCAApi.postImportAnOcspResponder
Import an OCSP responder
Risk: write
await corsair.digicert.api.privateCAApi.postImportAnOcspResponder({
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
blob?: string,
created_date?: string,
csr?: number[],
csr_blob?: string,
delegated_scope?: {
ica_rules?: {
}
},
extensions?: {
adobe_archive_rev_info?: {
version?: number
},
adobe_timestamp?: {
location?: string,
requires_auth?: boolean,
version?: number
},
aia?: {
issuer_urls?: string[]
},
aki?: {
authority_name_serial_number?: boolean,
include?: string,
key_identifier?: boolean
},
basic_constraints?: {
ca?: boolean,
critical?: boolean,
path_length?: number
},
cabf_organization_identifier?: {
country?: string,
reference?: string,
scheme?: string,
state?: string
},
cdp?: {
urls?: string[]
},
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
extended_key_usage?: {
additional_values?: string[],
critical?: boolean
},
extensions_order?: string[],
issuer_alt_name?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
key_usage?: {
additional_values?: string[],
critical?: boolean,
skip_validation?: boolean
},
lei?: {
value?: string
},
lei_role?: {
value?: string
},
microsoft_application_certificate_policies?: {
additional_values?: string[],
critical?: boolean
},
microsoft_certificate_template_name?: string,
microsoft_certificate_template_v2?: {
major_version?: number,
minor_version?: number,
oid?: string
},
private_key_usage_period?: {
critical?: any,
not_after?: string,
not_before?: string
},
qc_statements?: {
critical?: boolean,
etsi-psd2-qcStatement?: string[],
id-etsi-qcs-QcPDS?: {
language?: string,
uri?: string
}[],
id-etsi-qcs-QcRetentionPeriod?: number,
id-etsi-qcs-QcType?: string[],
id-qcs-pkixQCSyntax-v2?: {
semantics_id?: string
},
oids?: string[]
},
san?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
security_identifier?: {
oid?: string,
value?: string
}[],
ski?: {
include?: string,
method?: string
},
ski_extension?: string,
smime_capabilities?: {
values?: string[]
},
subject_directory_attributes?: {
encoded_value?: number[]
}
},
hsm_provider?: {
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
},
id?: string,
issuer?: {
hosted_type?: online | offline | third_party,
id?: string,
name?: string,
valid_from?: string,
valid_to?: string
},
key_generation?: {
dilithium_key_size?: string,
ecc_curve?: string,
ecdsa_curve?: string,
falcon_key_size?: string,
key_type?: string,
rsa_key_bits?: number,
sphincs_key_size?: string
},
key_name?: string,
name?: string,
notification?: {
enabled?: boolean,
frequency?: number[],
recipients?: string[]
},
private_key?: {
password?: string,
pkcs12?: number[],
pre_installed?: boolean
},
responder_type?: string,
serial_number?: string,
signature_algorithm?: string,
status?: string,
updated_date?: string,
validity?: {
duration_unit?: string,
duration_value?: number,
valid_from?: string,
valid_to?: string
},
validity_truncate?: boolean
}
| Name | Type | Required | Description |
|---|---|---|---|
blob | string | No | — |
created_date | string | No | — |
csr | number[] | No | — |
csr_blob | string | No | — |
delegated_scope | object | No | — |
extensions | object | No | — |
hsm_provider | object | No | — |
id | string | No | — |
issuer | object | No | — |
key_generation | object | No | — |
key_name | string | No | — |
name | string | No | — |
notification | object | No | — |
private_key | object | No | — |
responder_type | string | No | — |
serial_number | string | No | — |
signature_algorithm | string | No | — |
status | string | No | — |
updated_date | string | No | — |
validity | object | No | — |
validity_truncate | boolean | No | — |
delegated_scope full type
delegated_scope full type
{
ica_rules?: {
}
}
extensions full type
extensions full type
{
adobe_archive_rev_info?: {
version?: number
},
adobe_timestamp?: {
location?: string,
requires_auth?: boolean,
version?: number
},
aia?: {
issuer_urls?: string[]
},
aki?: {
authority_name_serial_number?: boolean,
include?: string,
key_identifier?: boolean
},
basic_constraints?: {
ca?: boolean,
critical?: boolean,
path_length?: number
},
cabf_organization_identifier?: {
country?: string,
reference?: string,
scheme?: string,
state?: string
},
cdp?: {
urls?: string[]
},
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
extended_key_usage?: {
additional_values?: string[],
critical?: boolean
},
extensions_order?: string[],
issuer_alt_name?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
key_usage?: {
additional_values?: string[],
critical?: boolean,
skip_validation?: boolean
},
lei?: {
value?: string
},
lei_role?: {
value?: string
},
microsoft_application_certificate_policies?: {
additional_values?: string[],
critical?: boolean
},
microsoft_certificate_template_name?: string,
microsoft_certificate_template_v2?: {
major_version?: number,
minor_version?: number,
oid?: string
},
private_key_usage_period?: {
critical?: any,
not_after?: string,
not_before?: string
},
qc_statements?: {
critical?: boolean,
etsi-psd2-qcStatement?: string[],
id-etsi-qcs-QcPDS?: {
language?: string,
uri?: string
}[],
id-etsi-qcs-QcRetentionPeriod?: number,
id-etsi-qcs-QcType?: string[],
id-qcs-pkixQCSyntax-v2?: {
semantics_id?: string
},
oids?: string[]
},
san?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
security_identifier?: {
oid?: string,
value?: string
}[],
ski?: {
include?: string,
method?: string
},
ski_extension?: string,
smime_capabilities?: {
values?: string[]
},
subject_directory_attributes?: {
encoded_value?: number[]
}
}
hsm_provider full type
hsm_provider full type
{
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
}
issuer full type
issuer full type
{
hosted_type?: online | offline | third_party | string,
id?: string,
name?: string,
valid_from?: string,
valid_to?: string
}
key_generation full type
key_generation full type
{
dilithium_key_size?: string,
ecc_curve?: string,
ecdsa_curve?: string,
falcon_key_size?: string,
key_type?: string,
rsa_key_bits?: number,
sphincs_key_size?: string
}
notification full type
notification full type
{
enabled?: boolean,
frequency?: number[],
recipients?: string[]
}
private_key full type
private_key full type
{
password?: string,
pkcs12?: number[],
pre_installed?: boolean
}
validity full type
validity full type
{
duration_unit?: string,
duration_value?: number,
valid_from?: string,
valid_to?: string
}
postImportAnOfflineCa
privateCAApi.postImportAnOfflineCa
Import an offline CA
Risk: write
await corsair.digicert.api.privateCAApi.postImportAnOfflineCa({
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account_assignments?: {
id?: string,
name?: string
}[],
active_aia_issuer?: {
file_name?: string,
id?: string
},
active_arl?: {
file_name?: string,
file_path?: string,
id?: string
},
active_crl?: {
file_name?: string,
file_path?: string,
id?: string
},
active_crl_cdps?: {
cdps?: string[]
},
active_eerl?: {
file_name?: string,
file_path?: string,
id?: string
},
allow_unmatched_cdp?: boolean,
blob?: string,
ca_type?: string,
cert_type?: string,
configuration?: {
aia_issuer?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap,
type?: string[]
}[],
include?: string,
override_global?: boolean
},
allow_extended_validity?: boolean,
allow_pkcs7_operations?: boolean,
allowed_signature_algorithms?: string[],
available_signature_algorithms?: string[],
certificate_policies?: {
allowed_sources?: string[],
default_policies?: {
critical?: boolean,
policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[]
},
include?: string,
override_global?: boolean
},
chains?: {
certificates?: {
blob?: string,
cert_type?: string,
subject?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
}[],
default?: boolean,
id?: string,
name?: string
}[],
crl?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap,
type?: string[]
}[],
end_validity_years?: number,
include?: string,
override_global?: boolean
},
include_all_certificates_in_crl?: boolean,
issue_end_entities?: boolean,
issue_ica_intermediates?: boolean,
issue_types?: string[],
issue_unmanaged_ca?: boolean,
ocsp?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap,
type?: string[]
}[],
include?: string,
override_global?: boolean,
uri_path?: string
},
ocsp_responder?: {
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
certificate_template?: {
access?: string,
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
category?: string,
cert_type?: root | intermediate | end_entity,
created_date?: string,
id?: string,
install_type?: string,
issue_types?: string[],
kind?: string,
name?: string,
template_json?: string,
trust_type?: string,
updated_date?: string
},
delete_expired_responders?: boolean,
generation_enabled?: boolean,
hsm_partition?: {
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
},
override_global?: boolean,
responder_create_within_days?: number,
responder_validity_days?: number
}
},
create_default_aia_issuer?: boolean,
create_default_crl?: boolean,
create_preview_cert?: boolean,
csr?: string,
exportable?: boolean,
extensions?: {
adobe_archive_rev_info?: {
version?: number
},
adobe_timestamp?: {
location?: string,
requires_auth?: boolean,
version?: number
},
aia?: {
issuer_urls?: string[]
},
aki?: {
authority_name_serial_number?: boolean,
include?: string,
key_identifier?: boolean
},
basic_constraints?: {
ca?: boolean,
critical?: boolean,
path_length?: number
},
cabf_organization_identifier?: {
country?: string,
reference?: string,
scheme?: string,
state?: string
},
cdp?: {
urls?: string[]
},
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
extended_key_usage?: {
additional_values?: string[],
critical?: boolean
},
extensions_order?: string[],
issuer_alt_name?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
key_usage?: {
additional_values?: string[],
critical?: boolean,
skip_validation?: boolean
},
lei?: {
value?: string
},
lei_role?: {
value?: string
},
microsoft_application_certificate_policies?: {
additional_values?: string[],
critical?: boolean
},
microsoft_certificate_template_name?: string,
microsoft_certificate_template_v2?: {
major_version?: number,
minor_version?: number,
oid?: string
},
private_key_usage_period?: {
critical?: any,
not_after?: string,
not_before?: string
},
qc_statements?: {
critical?: boolean,
etsi-psd2-qcStatement?: string[],
id-etsi-qcs-QcPDS?: {
language?: string,
uri?: string
}[],
id-etsi-qcs-QcRetentionPeriod?: number,
id-etsi-qcs-QcType?: string[],
id-qcs-pkixQCSyntax-v2?: {
semantics_id?: string
},
oids?: string[]
},
san?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
security_identifier?: {
oid?: string,
value?: string
}[],
ski?: {
include?: string,
method?: string
},
ski_extension?: string,
smime_capabilities?: {
values?: string[]
},
subject_directory_attributes?: {
encoded_value?: number[]
}
},
hosted_type?: online | offline | external | third_party,
hsm_key_label?: string,
hsm_partition?: {
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
},
id?: string,
is_composite_ca?: boolean,
issue_types?: string[],
issuer?: {
hosted_type?: online | offline | third_party,
id?: string,
name?: string,
valid_from?: string,
valid_to?: string
},
key_generation?: {
dilithium_key_size?: string,
ecc_curve?: string,
ecdsa_curve?: string,
falcon_key_size?: string,
key_type?: string,
rsa_key_bits?: number,
sphincs_key_size?: string
},
key_type?: rsa | ecc,
name?: string,
notification?: {
enabled?: boolean,
frequency?: number[],
recipients?: string[]
},
number_of_ica?: number,
pem?: string,
private_key?: {
password?: string,
pkcs12?: number[],
pre_installed?: boolean
},
recertification_links?: {
created_date?: string,
link_type?: string,
linked_ca?: string
}[],
reinstate_requests?: {
comments?: string,
id?: string,
requester_user_id?: string,
requester_username?: string,
reviewer_user_id?: string
}[],
revocation?: {
comments?: string,
reason?: string,
revoke_date?: string,
revoked?: boolean
},
revocation_requests?: {
comments?: string,
id?: string,
reason?: string,
requester_user_id?: string,
requester_username?: string,
reviewer_user_id?: string,
revocation_date?: string
}[],
serial_number?: string,
signature_algorithm?: string,
status?: active | pending_sign | disabled,
subject?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
},
template?: string,
template_id?: string,
thumbprint_sha256?: string,
trust_type?: string,
trust_types?: string[],
validity?: {
duration_unit?: string,
duration_value?: number,
valid_from?: string,
valid_to?: string
}
}
| Name | Type | Required | Description |
|---|---|---|---|
account_assignments | object[] | No | — |
active_aia_issuer | object | No | — |
active_arl | object | No | — |
active_crl | object | No | — |
active_crl_cdps | object | No | — |
active_eerl | object | No | — |
allow_unmatched_cdp | boolean | No | — |
blob | string | No | — |
ca_type | string | No | — |
cert_type | string | No | — |
configuration | object | No | — |
create_default_aia_issuer | boolean | No | — |
create_default_crl | boolean | No | — |
create_preview_cert | boolean | No | — |
csr | string | No | — |
exportable | boolean | No | — |
extensions | object | No | — |
hosted_type | online | offline | external | third_party | No | — |
hsm_key_label | string | No | — |
hsm_partition | object | No | — |
id | string | No | — |
is_composite_ca | boolean | No | — |
issue_types | string[] | No | — |
issuer | object | No | — |
key_generation | object | No | — |
key_type | rsa | ecc | string | No | — |
name | string | No | — |
notification | object | No | — |
number_of_ica | number | No | — |
pem | string | No | — |
private_key | object | No | — |
recertification_links | object[] | No | — |
reinstate_requests | object[] | No | — |
revocation | object | No | — |
revocation_requests | object[] | No | — |
serial_number | string | No | — |
signature_algorithm | string | No | — |
status | active | pending_sign | disabled | string | No | — |
subject | object | No | — |
template | string | No | — |
template_id | string | No | — |
thumbprint_sha256 | string | No | — |
trust_type | string | No | — |
trust_types | string[] | No | — |
validity | object | No | — |
account_assignments full type
account_assignments full type
{
id?: string,
name?: string
}[]
active_aia_issuer full type
active_aia_issuer full type
{
file_name?: string,
id?: string
}
active_arl full type
active_arl full type
{
file_name?: string,
file_path?: string,
id?: string
}
active_crl full type
active_crl full type
{
file_name?: string,
file_path?: string,
id?: string
}
active_crl_cdps full type
active_crl_cdps full type
{
cdps?: string[]
}
active_eerl full type
active_eerl full type
{
file_name?: string,
file_path?: string,
id?: string
}
configuration full type
configuration full type
{
aia_issuer?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap | string,
type?: string[]
}[],
include?: string,
override_global?: boolean
},
allow_extended_validity?: boolean,
allow_pkcs7_operations?: boolean,
allowed_signature_algorithms?: string[],
available_signature_algorithms?: string[],
certificate_policies?: {
allowed_sources?: string[],
default_policies?: {
critical?: boolean,
policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[]
},
include?: string,
override_global?: boolean
},
chains?: {
certificates?: {
blob?: string,
cert_type?: string,
subject?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
}[],
default?: boolean,
id?: string,
name?: string
}[],
crl?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap | string,
type?: string[]
}[],
end_validity_years?: number,
include?: string,
override_global?: boolean
},
include_all_certificates_in_crl?: boolean,
issue_end_entities?: boolean,
issue_ica_intermediates?: boolean,
issue_types?: string[],
issue_unmanaged_ca?: boolean,
ocsp?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap | string,
type?: string[]
}[],
include?: string,
override_global?: boolean,
uri_path?: string
},
ocsp_responder?: {
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
certificate_template?: {
access?: string,
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
category?: string,
cert_type?: root | intermediate | end_entity,
created_date?: string,
id?: string,
install_type?: string,
issue_types?: string[],
kind?: string,
name?: string,
template_json?: string,
trust_type?: string,
updated_date?: string
},
delete_expired_responders?: boolean,
generation_enabled?: boolean,
hsm_partition?: {
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
},
override_global?: boolean,
responder_create_within_days?: number,
responder_validity_days?: number
}
}
extensions full type
extensions full type
{
adobe_archive_rev_info?: {
version?: number
},
adobe_timestamp?: {
location?: string,
requires_auth?: boolean,
version?: number
},
aia?: {
issuer_urls?: string[]
},
aki?: {
authority_name_serial_number?: boolean,
include?: string,
key_identifier?: boolean
},
basic_constraints?: {
ca?: boolean,
critical?: boolean,
path_length?: number
},
cabf_organization_identifier?: {
country?: string,
reference?: string,
scheme?: string,
state?: string
},
cdp?: {
urls?: string[]
},
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
extended_key_usage?: {
additional_values?: string[],
critical?: boolean
},
extensions_order?: string[],
issuer_alt_name?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
key_usage?: {
additional_values?: string[],
critical?: boolean,
skip_validation?: boolean
},
lei?: {
value?: string
},
lei_role?: {
value?: string
},
microsoft_application_certificate_policies?: {
additional_values?: string[],
critical?: boolean
},
microsoft_certificate_template_name?: string,
microsoft_certificate_template_v2?: {
major_version?: number,
minor_version?: number,
oid?: string
},
private_key_usage_period?: {
critical?: any,
not_after?: string,
not_before?: string
},
qc_statements?: {
critical?: boolean,
etsi-psd2-qcStatement?: string[],
id-etsi-qcs-QcPDS?: {
language?: string,
uri?: string
}[],
id-etsi-qcs-QcRetentionPeriod?: number,
id-etsi-qcs-QcType?: string[],
id-qcs-pkixQCSyntax-v2?: {
semantics_id?: string
},
oids?: string[]
},
san?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
security_identifier?: {
oid?: string,
value?: string
}[],
ski?: {
include?: string,
method?: string
},
ski_extension?: string,
smime_capabilities?: {
values?: string[]
},
subject_directory_attributes?: {
encoded_value?: number[]
}
}
hsm_partition full type
hsm_partition full type
{
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
}
issuer full type
issuer full type
{
hosted_type?: online | offline | third_party | string,
id?: string,
name?: string,
valid_from?: string,
valid_to?: string
}
key_generation full type
key_generation full type
{
dilithium_key_size?: string,
ecc_curve?: string,
ecdsa_curve?: string,
falcon_key_size?: string,
key_type?: string,
rsa_key_bits?: number,
sphincs_key_size?: string
}
notification full type
notification full type
{
enabled?: boolean,
frequency?: number[],
recipients?: string[]
}
private_key full type
private_key full type
{
password?: string,
pkcs12?: number[],
pre_installed?: boolean
}
recertification_links full type
recertification_links full type
{
created_date?: string,
link_type?: string,
linked_ca?: string
}[]
reinstate_requests full type
reinstate_requests full type
{
comments?: string,
id?: string,
requester_user_id?: string,
requester_username?: string,
reviewer_user_id?: string
}[]
revocation full type
revocation full type
{
comments?: string,
reason?: string,
revoke_date?: string,
revoked?: boolean
}
revocation_requests full type
revocation_requests full type
{
comments?: string,
id?: string,
reason?: string,
requester_user_id?: string,
requester_username?: string,
reviewer_user_id?: string,
revocation_date?: string
}[]
subject full type
subject full type
{
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
validity full type
validity full type
{
duration_unit?: string,
duration_value?: number,
valid_from?: string,
valid_to?: string
}
postImportAThirdPartyCa
privateCAApi.postImportAThirdPartyCa
Import a third party CA
Risk: write
await corsair.digicert.api.privateCAApi.postImportAThirdPartyCa({
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account_assignments?: {
id?: string,
name?: string
}[],
active_aia_issuer?: {
file_name?: string,
id?: string
},
active_arl?: {
file_name?: string,
file_path?: string,
id?: string
},
active_crl?: {
file_name?: string,
file_path?: string,
id?: string
},
active_crl_cdps?: {
cdps?: string[]
},
active_eerl?: {
file_name?: string,
file_path?: string,
id?: string
},
allow_unmatched_cdp?: boolean,
blob?: string,
ca_type?: string,
cert_type?: string,
configuration?: {
aia_issuer?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap,
type?: string[]
}[],
include?: string,
override_global?: boolean
},
allow_extended_validity?: boolean,
allow_pkcs7_operations?: boolean,
allowed_signature_algorithms?: string[],
available_signature_algorithms?: string[],
certificate_policies?: {
allowed_sources?: string[],
default_policies?: {
critical?: boolean,
policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[]
},
include?: string,
override_global?: boolean
},
chains?: {
certificates?: {
blob?: string,
cert_type?: string,
subject?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
}[],
default?: boolean,
id?: string,
name?: string
}[],
crl?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap,
type?: string[]
}[],
end_validity_years?: number,
include?: string,
override_global?: boolean
},
include_all_certificates_in_crl?: boolean,
issue_end_entities?: boolean,
issue_ica_intermediates?: boolean,
issue_types?: string[],
issue_unmanaged_ca?: boolean,
ocsp?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap,
type?: string[]
}[],
include?: string,
override_global?: boolean,
uri_path?: string
},
ocsp_responder?: {
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
certificate_template?: {
access?: string,
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
category?: string,
cert_type?: root | intermediate | end_entity,
created_date?: string,
id?: string,
install_type?: string,
issue_types?: string[],
kind?: string,
name?: string,
template_json?: string,
trust_type?: string,
updated_date?: string
},
delete_expired_responders?: boolean,
generation_enabled?: boolean,
hsm_partition?: {
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
},
override_global?: boolean,
responder_create_within_days?: number,
responder_validity_days?: number
}
},
create_default_aia_issuer?: boolean,
create_default_crl?: boolean,
create_preview_cert?: boolean,
csr?: string,
exportable?: boolean,
extensions?: {
adobe_archive_rev_info?: {
version?: number
},
adobe_timestamp?: {
location?: string,
requires_auth?: boolean,
version?: number
},
aia?: {
issuer_urls?: string[]
},
aki?: {
authority_name_serial_number?: boolean,
include?: string,
key_identifier?: boolean
},
basic_constraints?: {
ca?: boolean,
critical?: boolean,
path_length?: number
},
cabf_organization_identifier?: {
country?: string,
reference?: string,
scheme?: string,
state?: string
},
cdp?: {
urls?: string[]
},
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
extended_key_usage?: {
additional_values?: string[],
critical?: boolean
},
extensions_order?: string[],
issuer_alt_name?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
key_usage?: {
additional_values?: string[],
critical?: boolean,
skip_validation?: boolean
},
lei?: {
value?: string
},
lei_role?: {
value?: string
},
microsoft_application_certificate_policies?: {
additional_values?: string[],
critical?: boolean
},
microsoft_certificate_template_name?: string,
microsoft_certificate_template_v2?: {
major_version?: number,
minor_version?: number,
oid?: string
},
private_key_usage_period?: {
critical?: any,
not_after?: string,
not_before?: string
},
qc_statements?: {
critical?: boolean,
etsi-psd2-qcStatement?: string[],
id-etsi-qcs-QcPDS?: {
language?: string,
uri?: string
}[],
id-etsi-qcs-QcRetentionPeriod?: number,
id-etsi-qcs-QcType?: string[],
id-qcs-pkixQCSyntax-v2?: {
semantics_id?: string
},
oids?: string[]
},
san?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
security_identifier?: {
oid?: string,
value?: string
}[],
ski?: {
include?: string,
method?: string
},
ski_extension?: string,
smime_capabilities?: {
values?: string[]
},
subject_directory_attributes?: {
encoded_value?: number[]
}
},
hosted_type?: online | offline | external | third_party,
hsm_key_label?: string,
hsm_partition?: {
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
},
id?: string,
is_composite_ca?: boolean,
issue_types?: string[],
issuer?: {
hosted_type?: online | offline | third_party,
id?: string,
name?: string,
valid_from?: string,
valid_to?: string
},
key_generation?: {
dilithium_key_size?: string,
ecc_curve?: string,
ecdsa_curve?: string,
falcon_key_size?: string,
key_type?: string,
rsa_key_bits?: number,
sphincs_key_size?: string
},
key_type?: rsa | ecc,
name?: string,
notification?: {
enabled?: boolean,
frequency?: number[],
recipients?: string[]
},
number_of_ica?: number,
pem?: string,
private_key?: {
password?: string,
pkcs12?: number[],
pre_installed?: boolean
},
recertification_links?: {
created_date?: string,
link_type?: string,
linked_ca?: string
}[],
reinstate_requests?: {
comments?: string,
id?: string,
requester_user_id?: string,
requester_username?: string,
reviewer_user_id?: string
}[],
revocation?: {
comments?: string,
reason?: string,
revoke_date?: string,
revoked?: boolean
},
revocation_requests?: {
comments?: string,
id?: string,
reason?: string,
requester_user_id?: string,
requester_username?: string,
reviewer_user_id?: string,
revocation_date?: string
}[],
serial_number?: string,
signature_algorithm?: string,
status?: active | pending_sign | disabled,
subject?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
},
template?: string,
template_id?: string,
thumbprint_sha256?: string,
trust_type?: string,
trust_types?: string[],
validity?: {
duration_unit?: string,
duration_value?: number,
valid_from?: string,
valid_to?: string
}
}
| Name | Type | Required | Description |
|---|---|---|---|
account_assignments | object[] | No | — |
active_aia_issuer | object | No | — |
active_arl | object | No | — |
active_crl | object | No | — |
active_crl_cdps | object | No | — |
active_eerl | object | No | — |
allow_unmatched_cdp | boolean | No | — |
blob | string | No | — |
ca_type | string | No | — |
cert_type | string | No | — |
configuration | object | No | — |
create_default_aia_issuer | boolean | No | — |
create_default_crl | boolean | No | — |
create_preview_cert | boolean | No | — |
csr | string | No | — |
exportable | boolean | No | — |
extensions | object | No | — |
hosted_type | online | offline | external | third_party | No | — |
hsm_key_label | string | No | — |
hsm_partition | object | No | — |
id | string | No | — |
is_composite_ca | boolean | No | — |
issue_types | string[] | No | — |
issuer | object | No | — |
key_generation | object | No | — |
key_type | rsa | ecc | string | No | — |
name | string | No | — |
notification | object | No | — |
number_of_ica | number | No | — |
pem | string | No | — |
private_key | object | No | — |
recertification_links | object[] | No | — |
reinstate_requests | object[] | No | — |
revocation | object | No | — |
revocation_requests | object[] | No | — |
serial_number | string | No | — |
signature_algorithm | string | No | — |
status | active | pending_sign | disabled | string | No | — |
subject | object | No | — |
template | string | No | — |
template_id | string | No | — |
thumbprint_sha256 | string | No | — |
trust_type | string | No | — |
trust_types | string[] | No | — |
validity | object | No | — |
account_assignments full type
account_assignments full type
{
id?: string,
name?: string
}[]
active_aia_issuer full type
active_aia_issuer full type
{
file_name?: string,
id?: string
}
active_arl full type
active_arl full type
{
file_name?: string,
file_path?: string,
id?: string
}
active_crl full type
active_crl full type
{
file_name?: string,
file_path?: string,
id?: string
}
active_crl_cdps full type
active_crl_cdps full type
{
cdps?: string[]
}
active_eerl full type
active_eerl full type
{
file_name?: string,
file_path?: string,
id?: string
}
configuration full type
configuration full type
{
aia_issuer?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap | string,
type?: string[]
}[],
include?: string,
override_global?: boolean
},
allow_extended_validity?: boolean,
allow_pkcs7_operations?: boolean,
allowed_signature_algorithms?: string[],
available_signature_algorithms?: string[],
certificate_policies?: {
allowed_sources?: string[],
default_policies?: {
critical?: boolean,
policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[]
},
include?: string,
override_global?: boolean
},
chains?: {
certificates?: {
blob?: string,
cert_type?: string,
subject?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
}[],
default?: boolean,
id?: string,
name?: string
}[],
crl?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap | string,
type?: string[]
}[],
end_validity_years?: number,
include?: string,
override_global?: boolean
},
include_all_certificates_in_crl?: boolean,
issue_end_entities?: boolean,
issue_ica_intermediates?: boolean,
issue_types?: string[],
issue_unmanaged_ca?: boolean,
ocsp?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap | string,
type?: string[]
}[],
include?: string,
override_global?: boolean,
uri_path?: string
},
ocsp_responder?: {
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
certificate_template?: {
access?: string,
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
category?: string,
cert_type?: root | intermediate | end_entity,
created_date?: string,
id?: string,
install_type?: string,
issue_types?: string[],
kind?: string,
name?: string,
template_json?: string,
trust_type?: string,
updated_date?: string
},
delete_expired_responders?: boolean,
generation_enabled?: boolean,
hsm_partition?: {
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
},
override_global?: boolean,
responder_create_within_days?: number,
responder_validity_days?: number
}
}
extensions full type
extensions full type
{
adobe_archive_rev_info?: {
version?: number
},
adobe_timestamp?: {
location?: string,
requires_auth?: boolean,
version?: number
},
aia?: {
issuer_urls?: string[]
},
aki?: {
authority_name_serial_number?: boolean,
include?: string,
key_identifier?: boolean
},
basic_constraints?: {
ca?: boolean,
critical?: boolean,
path_length?: number
},
cabf_organization_identifier?: {
country?: string,
reference?: string,
scheme?: string,
state?: string
},
cdp?: {
urls?: string[]
},
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
extended_key_usage?: {
additional_values?: string[],
critical?: boolean
},
extensions_order?: string[],
issuer_alt_name?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
key_usage?: {
additional_values?: string[],
critical?: boolean,
skip_validation?: boolean
},
lei?: {
value?: string
},
lei_role?: {
value?: string
},
microsoft_application_certificate_policies?: {
additional_values?: string[],
critical?: boolean
},
microsoft_certificate_template_name?: string,
microsoft_certificate_template_v2?: {
major_version?: number,
minor_version?: number,
oid?: string
},
private_key_usage_period?: {
critical?: any,
not_after?: string,
not_before?: string
},
qc_statements?: {
critical?: boolean,
etsi-psd2-qcStatement?: string[],
id-etsi-qcs-QcPDS?: {
language?: string,
uri?: string
}[],
id-etsi-qcs-QcRetentionPeriod?: number,
id-etsi-qcs-QcType?: string[],
id-qcs-pkixQCSyntax-v2?: {
semantics_id?: string
},
oids?: string[]
},
san?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
security_identifier?: {
oid?: string,
value?: string
}[],
ski?: {
include?: string,
method?: string
},
ski_extension?: string,
smime_capabilities?: {
values?: string[]
},
subject_directory_attributes?: {
encoded_value?: number[]
}
}
hsm_partition full type
hsm_partition full type
{
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
}
issuer full type
issuer full type
{
hosted_type?: online | offline | third_party | string,
id?: string,
name?: string,
valid_from?: string,
valid_to?: string
}
key_generation full type
key_generation full type
{
dilithium_key_size?: string,
ecc_curve?: string,
ecdsa_curve?: string,
falcon_key_size?: string,
key_type?: string,
rsa_key_bits?: number,
sphincs_key_size?: string
}
notification full type
notification full type
{
enabled?: boolean,
frequency?: number[],
recipients?: string[]
}
private_key full type
private_key full type
{
password?: string,
pkcs12?: number[],
pre_installed?: boolean
}
recertification_links full type
recertification_links full type
{
created_date?: string,
link_type?: string,
linked_ca?: string
}[]
reinstate_requests full type
reinstate_requests full type
{
comments?: string,
id?: string,
requester_user_id?: string,
requester_username?: string,
reviewer_user_id?: string
}[]
revocation full type
revocation full type
{
comments?: string,
reason?: string,
revoke_date?: string,
revoked?: boolean
}
revocation_requests full type
revocation_requests full type
{
comments?: string,
id?: string,
reason?: string,
requester_user_id?: string,
requester_username?: string,
reviewer_user_id?: string,
revocation_date?: string
}[]
subject full type
subject full type
{
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
validity full type
validity full type
{
duration_unit?: string,
duration_value?: number,
valid_from?: string,
valid_to?: string
}
postImportCrlBlob
privateCAApi.postImportCrlBlob
Import CRL Blob
Risk: write
await corsair.digicert.api.privateCAApi.postImportCrlBlob({
path: { id: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
blob?: number[]
}
| Name | Type | Required | Description |
|---|---|---|---|
blob | number[] | No | — |
crl_id | string | No | — |
crl_number | number | No | — |
generated_date | string | No | — |
next_update | string | No | — |
this_update | string | No | — |
postInitiateLogout
privateCAApi.postInitiateLogout
Initiate Logout
Risk: write
await corsair.digicert.api.privateCAApi.postInitiateLogout({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
message | string | No | — |
postLinkACaKey
privateCAApi.postLinkACaKey
Link a CA key
Risk: write
await corsair.digicert.api.privateCAApi.postLinkACaKey({
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account_assignments?: {
id?: string,
name?: string
}[],
active_aia_issuer?: {
file_name?: string,
id?: string
},
active_arl?: {
file_name?: string,
file_path?: string,
id?: string
},
active_crl?: {
file_name?: string,
file_path?: string,
id?: string
},
active_crl_cdps?: {
cdps?: string[]
},
active_eerl?: {
file_name?: string,
file_path?: string,
id?: string
},
allow_unmatched_cdp?: boolean,
blob?: string,
ca_type?: string,
cert_type?: string,
configuration?: {
aia_issuer?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap,
type?: string[]
}[],
include?: string,
override_global?: boolean
},
allow_extended_validity?: boolean,
allow_pkcs7_operations?: boolean,
allowed_signature_algorithms?: string[],
available_signature_algorithms?: string[],
certificate_policies?: {
allowed_sources?: string[],
default_policies?: {
critical?: boolean,
policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[]
},
include?: string,
override_global?: boolean
},
chains?: {
certificates?: {
blob?: string,
cert_type?: string,
subject?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
}[],
default?: boolean,
id?: string,
name?: string
}[],
crl?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap,
type?: string[]
}[],
end_validity_years?: number,
include?: string,
override_global?: boolean
},
include_all_certificates_in_crl?: boolean,
issue_end_entities?: boolean,
issue_ica_intermediates?: boolean,
issue_types?: string[],
issue_unmanaged_ca?: boolean,
ocsp?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap,
type?: string[]
}[],
include?: string,
override_global?: boolean,
uri_path?: string
},
ocsp_responder?: {
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
certificate_template?: {
access?: string,
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
category?: string,
cert_type?: root | intermediate | end_entity,
created_date?: string,
id?: string,
install_type?: string,
issue_types?: string[],
kind?: string,
name?: string,
template_json?: string,
trust_type?: string,
updated_date?: string
},
delete_expired_responders?: boolean,
generation_enabled?: boolean,
hsm_partition?: {
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
},
override_global?: boolean,
responder_create_within_days?: number,
responder_validity_days?: number
}
},
create_default_aia_issuer?: boolean,
create_default_crl?: boolean,
create_preview_cert?: boolean,
csr?: string,
exportable?: boolean,
extensions?: {
adobe_archive_rev_info?: {
version?: number
},
adobe_timestamp?: {
location?: string,
requires_auth?: boolean,
version?: number
},
aia?: {
issuer_urls?: string[]
},
aki?: {
authority_name_serial_number?: boolean,
include?: string,
key_identifier?: boolean
},
basic_constraints?: {
ca?: boolean,
critical?: boolean,
path_length?: number
},
cabf_organization_identifier?: {
country?: string,
reference?: string,
scheme?: string,
state?: string
},
cdp?: {
urls?: string[]
},
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
extended_key_usage?: {
additional_values?: string[],
critical?: boolean
},
extensions_order?: string[],
issuer_alt_name?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
key_usage?: {
additional_values?: string[],
critical?: boolean,
skip_validation?: boolean
},
lei?: {
value?: string
},
lei_role?: {
value?: string
},
microsoft_application_certificate_policies?: {
additional_values?: string[],
critical?: boolean
},
microsoft_certificate_template_name?: string,
microsoft_certificate_template_v2?: {
major_version?: number,
minor_version?: number,
oid?: string
},
private_key_usage_period?: {
critical?: any,
not_after?: string,
not_before?: string
},
qc_statements?: {
critical?: boolean,
etsi-psd2-qcStatement?: string[],
id-etsi-qcs-QcPDS?: {
language?: string,
uri?: string
}[],
id-etsi-qcs-QcRetentionPeriod?: number,
id-etsi-qcs-QcType?: string[],
id-qcs-pkixQCSyntax-v2?: {
semantics_id?: string
},
oids?: string[]
},
san?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
security_identifier?: {
oid?: string,
value?: string
}[],
ski?: {
include?: string,
method?: string
},
ski_extension?: string,
smime_capabilities?: {
values?: string[]
},
subject_directory_attributes?: {
encoded_value?: number[]
}
},
hosted_type?: online | offline | external | third_party,
hsm_key_label?: string,
hsm_partition?: {
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
},
id?: string,
is_composite_ca?: boolean,
issue_types?: string[],
issuer?: {
hosted_type?: online | offline | third_party,
id?: string,
name?: string,
valid_from?: string,
valid_to?: string
},
key_generation?: {
dilithium_key_size?: string,
ecc_curve?: string,
ecdsa_curve?: string,
falcon_key_size?: string,
key_type?: string,
rsa_key_bits?: number,
sphincs_key_size?: string
},
key_type?: rsa | ecc,
name?: string,
notification?: {
enabled?: boolean,
frequency?: number[],
recipients?: string[]
},
number_of_ica?: number,
pem?: string,
private_key?: {
password?: string,
pkcs12?: number[],
pre_installed?: boolean
},
recertification_links?: {
created_date?: string,
link_type?: string,
linked_ca?: string
}[],
reinstate_requests?: {
comments?: string,
id?: string,
requester_user_id?: string,
requester_username?: string,
reviewer_user_id?: string
}[],
revocation?: {
comments?: string,
reason?: string,
revoke_date?: string,
revoked?: boolean
},
revocation_requests?: {
comments?: string,
id?: string,
reason?: string,
requester_user_id?: string,
requester_username?: string,
reviewer_user_id?: string,
revocation_date?: string
}[],
serial_number?: string,
signature_algorithm?: string,
status?: active | pending_sign | disabled,
subject?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
},
template?: string,
template_id?: string,
thumbprint_sha256?: string,
trust_type?: string,
trust_types?: string[],
validity?: {
duration_unit?: string,
duration_value?: number,
valid_from?: string,
valid_to?: string
}
}
| Name | Type | Required | Description |
|---|---|---|---|
account_assignments | object[] | No | — |
active_aia_issuer | object | No | — |
active_arl | object | No | — |
active_crl | object | No | — |
active_crl_cdps | object | No | — |
active_eerl | object | No | — |
allow_unmatched_cdp | boolean | No | — |
blob | string | No | — |
ca_type | string | No | — |
cert_type | string | No | — |
configuration | object | No | — |
create_default_aia_issuer | boolean | No | — |
create_default_crl | boolean | No | — |
create_preview_cert | boolean | No | — |
csr | string | No | — |
exportable | boolean | No | — |
extensions | object | No | — |
hosted_type | online | offline | external | third_party | No | — |
hsm_key_label | string | No | — |
hsm_partition | object | No | — |
id | string | No | — |
is_composite_ca | boolean | No | — |
issue_types | string[] | No | — |
issuer | object | No | — |
key_generation | object | No | — |
key_type | rsa | ecc | string | No | — |
name | string | No | — |
notification | object | No | — |
number_of_ica | number | No | — |
pem | string | No | — |
private_key | object | No | — |
recertification_links | object[] | No | — |
reinstate_requests | object[] | No | — |
revocation | object | No | — |
revocation_requests | object[] | No | — |
serial_number | string | No | — |
signature_algorithm | string | No | — |
status | active | pending_sign | disabled | string | No | — |
subject | object | No | — |
template | string | No | — |
template_id | string | No | — |
thumbprint_sha256 | string | No | — |
trust_type | string | No | — |
trust_types | string[] | No | — |
validity | object | No | — |
account_assignments full type
account_assignments full type
{
id?: string,
name?: string
}[]
active_aia_issuer full type
active_aia_issuer full type
{
file_name?: string,
id?: string
}
active_arl full type
active_arl full type
{
file_name?: string,
file_path?: string,
id?: string
}
active_crl full type
active_crl full type
{
file_name?: string,
file_path?: string,
id?: string
}
active_crl_cdps full type
active_crl_cdps full type
{
cdps?: string[]
}
active_eerl full type
active_eerl full type
{
file_name?: string,
file_path?: string,
id?: string
}
configuration full type
configuration full type
{
aia_issuer?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap | string,
type?: string[]
}[],
include?: string,
override_global?: boolean
},
allow_extended_validity?: boolean,
allow_pkcs7_operations?: boolean,
allowed_signature_algorithms?: string[],
available_signature_algorithms?: string[],
certificate_policies?: {
allowed_sources?: string[],
default_policies?: {
critical?: boolean,
policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[]
},
include?: string,
override_global?: boolean
},
chains?: {
certificates?: {
blob?: string,
cert_type?: string,
subject?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
}[],
default?: boolean,
id?: string,
name?: string
}[],
crl?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap | string,
type?: string[]
}[],
end_validity_years?: number,
include?: string,
override_global?: boolean
},
include_all_certificates_in_crl?: boolean,
issue_end_entities?: boolean,
issue_ica_intermediates?: boolean,
issue_types?: string[],
issue_unmanaged_ca?: boolean,
ocsp?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap | string,
type?: string[]
}[],
include?: string,
override_global?: boolean,
uri_path?: string
},
ocsp_responder?: {
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
certificate_template?: {
access?: string,
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
category?: string,
cert_type?: root | intermediate | end_entity,
created_date?: string,
id?: string,
install_type?: string,
issue_types?: string[],
kind?: string,
name?: string,
template_json?: string,
trust_type?: string,
updated_date?: string
},
delete_expired_responders?: boolean,
generation_enabled?: boolean,
hsm_partition?: {
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
},
override_global?: boolean,
responder_create_within_days?: number,
responder_validity_days?: number
}
}
extensions full type
extensions full type
{
adobe_archive_rev_info?: {
version?: number
},
adobe_timestamp?: {
location?: string,
requires_auth?: boolean,
version?: number
},
aia?: {
issuer_urls?: string[]
},
aki?: {
authority_name_serial_number?: boolean,
include?: string,
key_identifier?: boolean
},
basic_constraints?: {
ca?: boolean,
critical?: boolean,
path_length?: number
},
cabf_organization_identifier?: {
country?: string,
reference?: string,
scheme?: string,
state?: string
},
cdp?: {
urls?: string[]
},
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
extended_key_usage?: {
additional_values?: string[],
critical?: boolean
},
extensions_order?: string[],
issuer_alt_name?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
key_usage?: {
additional_values?: string[],
critical?: boolean,
skip_validation?: boolean
},
lei?: {
value?: string
},
lei_role?: {
value?: string
},
microsoft_application_certificate_policies?: {
additional_values?: string[],
critical?: boolean
},
microsoft_certificate_template_name?: string,
microsoft_certificate_template_v2?: {
major_version?: number,
minor_version?: number,
oid?: string
},
private_key_usage_period?: {
critical?: any,
not_after?: string,
not_before?: string
},
qc_statements?: {
critical?: boolean,
etsi-psd2-qcStatement?: string[],
id-etsi-qcs-QcPDS?: {
language?: string,
uri?: string
}[],
id-etsi-qcs-QcRetentionPeriod?: number,
id-etsi-qcs-QcType?: string[],
id-qcs-pkixQCSyntax-v2?: {
semantics_id?: string
},
oids?: string[]
},
san?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
security_identifier?: {
oid?: string,
value?: string
}[],
ski?: {
include?: string,
method?: string
},
ski_extension?: string,
smime_capabilities?: {
values?: string[]
},
subject_directory_attributes?: {
encoded_value?: number[]
}
}
hsm_partition full type
hsm_partition full type
{
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
}
issuer full type
issuer full type
{
hosted_type?: online | offline | third_party | string,
id?: string,
name?: string,
valid_from?: string,
valid_to?: string
}
key_generation full type
key_generation full type
{
dilithium_key_size?: string,
ecc_curve?: string,
ecdsa_curve?: string,
falcon_key_size?: string,
key_type?: string,
rsa_key_bits?: number,
sphincs_key_size?: string
}
notification full type
notification full type
{
enabled?: boolean,
frequency?: number[],
recipients?: string[]
}
private_key full type
private_key full type
{
password?: string,
pkcs12?: number[],
pre_installed?: boolean
}
recertification_links full type
recertification_links full type
{
created_date?: string,
link_type?: string,
linked_ca?: string
}[]
reinstate_requests full type
reinstate_requests full type
{
comments?: string,
id?: string,
requester_user_id?: string,
requester_username?: string,
reviewer_user_id?: string
}[]
revocation full type
revocation full type
{
comments?: string,
reason?: string,
revoke_date?: string,
revoked?: boolean
}
revocation_requests full type
revocation_requests full type
{
comments?: string,
id?: string,
reason?: string,
requester_user_id?: string,
requester_username?: string,
reviewer_user_id?: string,
revocation_date?: string
}[]
subject full type
subject full type
{
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
validity full type
validity full type
{
duration_unit?: string,
duration_value?: number,
valid_from?: string,
valid_to?: string
}
postParseIdPMetadata
privateCAApi.postParseIdPMetadata
Parse IdP Metadata
Risk: write
await corsair.digicert.api.privateCAApi.postParseIdPMetadata({
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
metadataUrl?: string,
metadataXml?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
certificate | string | No | — |
entityId | string | No | — |
metadataXml | string | No | — |
ssoUrl | string | No | — |
postRecertifiesACaWithANewImportedCertificate
privateCAApi.postRecertifiesACaWithANewImportedCertificate
Recertifies a CA with a new imported certificate
Risk: write
await corsair.digicert.api.privateCAApi.postRecertifiesACaWithANewImportedCertificate({
path: { id: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
blob?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
account_assignments | object[] | No | — |
active_aia_issuer | object | No | — |
active_arl | object | No | — |
active_crl | object | No | — |
active_crl_cdps | object | No | — |
active_eerl | object | No | — |
allow_unmatched_cdp | boolean | No | — |
blob | string | No | — |
ca_type | string | No | — |
cert_type | string | No | — |
configuration | object | No | — |
create_default_aia_issuer | boolean | No | — |
create_default_crl | boolean | No | — |
create_preview_cert | boolean | No | — |
csr | string | No | — |
exportable | boolean | No | — |
extensions | object | No | — |
hosted_type | online | offline | external | third_party | No | — |
hsm_key_label | string | No | — |
hsm_partition | object | No | — |
id | string | No | — |
is_composite_ca | boolean | No | — |
issue_types | string[] | No | — |
issuer | object | No | — |
key_generation | object | No | — |
key_type | rsa | ecc | string | No | — |
name | string | No | — |
notification | object | No | — |
number_of_ica | number | No | — |
pem | string | No | — |
private_key | object | No | — |
recertification_links | object[] | No | — |
reinstate_requests | object[] | No | — |
revocation | object | No | — |
revocation_requests | object[] | No | — |
serial_number | string | No | — |
signature_algorithm | string | No | — |
status | active | pending_sign | disabled | string | No | — |
subject | object | No | — |
template | string | No | — |
template_id | string | No | — |
thumbprint_sha256 | string | No | — |
trust_type | string | No | — |
trust_types | string[] | No | — |
validity | object | No | — |
account_assignments full type
account_assignments full type
{
id?: string,
name?: string
}[]
active_aia_issuer full type
active_aia_issuer full type
{
file_name?: string,
id?: string
}
active_arl full type
active_arl full type
{
file_name?: string,
file_path?: string,
id?: string
}
active_crl full type
active_crl full type
{
file_name?: string,
file_path?: string,
id?: string
}
active_crl_cdps full type
active_crl_cdps full type
{
cdps?: string[]
}
active_eerl full type
active_eerl full type
{
file_name?: string,
file_path?: string,
id?: string
}
configuration full type
configuration full type
{
aia_issuer?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap | string,
type?: string[]
}[],
include?: string,
override_global?: boolean
},
allow_extended_validity?: boolean,
allow_pkcs7_operations?: boolean,
allowed_signature_algorithms?: string[],
available_signature_algorithms?: string[],
certificate_policies?: {
allowed_sources?: string[],
default_policies?: {
critical?: boolean,
policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[]
},
include?: string,
override_global?: boolean
},
chains?: {
certificates?: {
blob?: string,
cert_type?: string,
subject?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
}[],
default?: boolean,
id?: string,
name?: string
}[],
crl?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap | string,
type?: string[]
}[],
end_validity_years?: number,
include?: string,
override_global?: boolean
},
include_all_certificates_in_crl?: boolean,
issue_end_entities?: boolean,
issue_ica_intermediates?: boolean,
issue_types?: string[],
issue_unmanaged_ca?: boolean,
ocsp?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap | string,
type?: string[]
}[],
include?: string,
override_global?: boolean,
uri_path?: string
},
ocsp_responder?: {
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
certificate_template?: {
access?: string,
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
category?: string,
cert_type?: root | intermediate | end_entity,
created_date?: string,
id?: string,
install_type?: string,
issue_types?: string[],
kind?: string,
name?: string,
template_json?: string,
trust_type?: string,
updated_date?: string
},
delete_expired_responders?: boolean,
generation_enabled?: boolean,
hsm_partition?: {
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
},
override_global?: boolean,
responder_create_within_days?: number,
responder_validity_days?: number
}
}
extensions full type
extensions full type
{
adobe_archive_rev_info?: {
version?: number
},
adobe_timestamp?: {
location?: string,
requires_auth?: boolean,
version?: number
},
aia?: {
issuer_urls?: string[]
},
aki?: {
authority_name_serial_number?: boolean,
include?: string,
key_identifier?: boolean
},
basic_constraints?: {
ca?: boolean,
critical?: boolean,
path_length?: number
},
cabf_organization_identifier?: {
country?: string,
reference?: string,
scheme?: string,
state?: string
},
cdp?: {
urls?: string[]
},
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
extended_key_usage?: {
additional_values?: string[],
critical?: boolean
},
extensions_order?: string[],
issuer_alt_name?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
key_usage?: {
additional_values?: string[],
critical?: boolean,
skip_validation?: boolean
},
lei?: {
value?: string
},
lei_role?: {
value?: string
},
microsoft_application_certificate_policies?: {
additional_values?: string[],
critical?: boolean
},
microsoft_certificate_template_name?: string,
microsoft_certificate_template_v2?: {
major_version?: number,
minor_version?: number,
oid?: string
},
private_key_usage_period?: {
critical?: any,
not_after?: string,
not_before?: string
},
qc_statements?: {
critical?: boolean,
etsi-psd2-qcStatement?: string[],
id-etsi-qcs-QcPDS?: {
language?: string,
uri?: string
}[],
id-etsi-qcs-QcRetentionPeriod?: number,
id-etsi-qcs-QcType?: string[],
id-qcs-pkixQCSyntax-v2?: {
semantics_id?: string
},
oids?: string[]
},
san?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
security_identifier?: {
oid?: string,
value?: string
}[],
ski?: {
include?: string,
method?: string
},
ski_extension?: string,
smime_capabilities?: {
values?: string[]
},
subject_directory_attributes?: {
encoded_value?: number[]
}
}
hsm_partition full type
hsm_partition full type
{
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
}
issuer full type
issuer full type
{
hosted_type?: online | offline | third_party | string,
id?: string,
name?: string,
valid_from?: string,
valid_to?: string
}
key_generation full type
key_generation full type
{
dilithium_key_size?: string,
ecc_curve?: string,
ecdsa_curve?: string,
falcon_key_size?: string,
key_type?: string,
rsa_key_bits?: number,
sphincs_key_size?: string
}
notification full type
notification full type
{
enabled?: boolean,
frequency?: number[],
recipients?: string[]
}
private_key full type
private_key full type
{
password?: string,
pkcs12?: number[],
pre_installed?: boolean
}
recertification_links full type
recertification_links full type
{
created_date?: string,
link_type?: string,
linked_ca?: string
}[]
reinstate_requests full type
reinstate_requests full type
{
comments?: string,
id?: string,
requester_user_id?: string,
requester_username?: string,
reviewer_user_id?: string
}[]
revocation full type
revocation full type
{
comments?: string,
reason?: string,
revoke_date?: string,
revoked?: boolean
}
revocation_requests full type
revocation_requests full type
{
comments?: string,
id?: string,
reason?: string,
requester_user_id?: string,
requester_username?: string,
reviewer_user_id?: string,
revocation_date?: string
}[]
subject full type
subject full type
{
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
validity full type
validity full type
{
duration_unit?: string,
duration_value?: number,
valid_from?: string,
valid_to?: string
}
postRecertifiesExistingCaByCaId
privateCAApi.postRecertifiesExistingCaByCaId
Recertifies existing CA by CA ID
Risk: write
await corsair.digicert.api.privateCAApi.postRecertifiesExistingCaByCaId({
path: { id: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
validity?: {
duration_unit?: string,
duration_value?: number,
valid_from?: string,
valid_to?: string
}
}
| Name | Type | Required | Description |
|---|---|---|---|
account_assignments | object[] | No | — |
active_aia_issuer | object | No | — |
active_arl | object | No | — |
active_crl | object | No | — |
active_crl_cdps | object | No | — |
active_eerl | object | No | — |
allow_unmatched_cdp | boolean | No | — |
blob | string | No | — |
ca_type | string | No | — |
cert_type | string | No | — |
configuration | object | No | — |
create_default_aia_issuer | boolean | No | — |
create_default_crl | boolean | No | — |
create_preview_cert | boolean | No | — |
csr | string | No | — |
exportable | boolean | No | — |
extensions | object | No | — |
hosted_type | online | offline | external | third_party | No | — |
hsm_key_label | string | No | — |
hsm_partition | object | No | — |
id | string | No | — |
is_composite_ca | boolean | No | — |
issue_types | string[] | No | — |
issuer | object | No | — |
key_generation | object | No | — |
key_type | rsa | ecc | string | No | — |
name | string | No | — |
notification | object | No | — |
number_of_ica | number | No | — |
pem | string | No | — |
private_key | object | No | — |
recertification_links | object[] | No | — |
reinstate_requests | object[] | No | — |
revocation | object | No | — |
revocation_requests | object[] | No | — |
serial_number | string | No | — |
signature_algorithm | string | No | — |
status | active | pending_sign | disabled | string | No | — |
subject | object | No | — |
template | string | No | — |
template_id | string | No | — |
thumbprint_sha256 | string | No | — |
trust_type | string | No | — |
trust_types | string[] | No | — |
validity | object | No | — |
account_assignments full type
account_assignments full type
{
id?: string,
name?: string
}[]
active_aia_issuer full type
active_aia_issuer full type
{
file_name?: string,
id?: string
}
active_arl full type
active_arl full type
{
file_name?: string,
file_path?: string,
id?: string
}
active_crl full type
active_crl full type
{
file_name?: string,
file_path?: string,
id?: string
}
active_crl_cdps full type
active_crl_cdps full type
{
cdps?: string[]
}
active_eerl full type
active_eerl full type
{
file_name?: string,
file_path?: string,
id?: string
}
configuration full type
configuration full type
{
aia_issuer?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap | string,
type?: string[]
}[],
include?: string,
override_global?: boolean
},
allow_extended_validity?: boolean,
allow_pkcs7_operations?: boolean,
allowed_signature_algorithms?: string[],
available_signature_algorithms?: string[],
certificate_policies?: {
allowed_sources?: string[],
default_policies?: {
critical?: boolean,
policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[]
},
include?: string,
override_global?: boolean
},
chains?: {
certificates?: {
blob?: string,
cert_type?: string,
subject?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
}[],
default?: boolean,
id?: string,
name?: string
}[],
crl?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap | string,
type?: string[]
}[],
end_validity_years?: number,
include?: string,
override_global?: boolean
},
include_all_certificates_in_crl?: boolean,
issue_end_entities?: boolean,
issue_ica_intermediates?: boolean,
issue_types?: string[],
issue_unmanaged_ca?: boolean,
ocsp?: {
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap | string,
type?: string[]
}[],
include?: string,
override_global?: boolean,
uri_path?: string
},
ocsp_responder?: {
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
certificate_template?: {
access?: string,
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
category?: string,
cert_type?: root | intermediate | end_entity,
created_date?: string,
id?: string,
install_type?: string,
issue_types?: string[],
kind?: string,
name?: string,
template_json?: string,
trust_type?: string,
updated_date?: string
},
delete_expired_responders?: boolean,
generation_enabled?: boolean,
hsm_partition?: {
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
},
override_global?: boolean,
responder_create_within_days?: number,
responder_validity_days?: number
}
}
extensions full type
extensions full type
{
adobe_archive_rev_info?: {
version?: number
},
adobe_timestamp?: {
location?: string,
requires_auth?: boolean,
version?: number
},
aia?: {
issuer_urls?: string[]
},
aki?: {
authority_name_serial_number?: boolean,
include?: string,
key_identifier?: boolean
},
basic_constraints?: {
ca?: boolean,
critical?: boolean,
path_length?: number
},
cabf_organization_identifier?: {
country?: string,
reference?: string,
scheme?: string,
state?: string
},
cdp?: {
urls?: string[]
},
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
extended_key_usage?: {
additional_values?: string[],
critical?: boolean
},
extensions_order?: string[],
issuer_alt_name?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
key_usage?: {
additional_values?: string[],
critical?: boolean,
skip_validation?: boolean
},
lei?: {
value?: string
},
lei_role?: {
value?: string
},
microsoft_application_certificate_policies?: {
additional_values?: string[],
critical?: boolean
},
microsoft_certificate_template_name?: string,
microsoft_certificate_template_v2?: {
major_version?: number,
minor_version?: number,
oid?: string
},
private_key_usage_period?: {
critical?: any,
not_after?: string,
not_before?: string
},
qc_statements?: {
critical?: boolean,
etsi-psd2-qcStatement?: string[],
id-etsi-qcs-QcPDS?: {
language?: string,
uri?: string
}[],
id-etsi-qcs-QcRetentionPeriod?: number,
id-etsi-qcs-QcType?: string[],
id-qcs-pkixQCSyntax-v2?: {
semantics_id?: string
},
oids?: string[]
},
san?: {
directory_names?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}[],
dns_names?: string[],
emails?: string[],
ip_addresses?: string[],
other_names?: {
domain_controller_id?: string[],
guid?: string[],
hardware_module_name?: {
serial_num?: number[],
type?: string
}[],
raw_other_names?: {
oid?: string,
value?: string
}[]
},
uris?: string[],
user_principal_names?: string[]
},
security_identifier?: {
oid?: string,
value?: string
}[],
ski?: {
include?: string,
method?: string
},
ski_extension?: string,
smime_capabilities?: {
values?: string[]
},
subject_directory_attributes?: {
encoded_value?: number[]
}
}
hsm_partition full type
hsm_partition full type
{
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
}
issuer full type
issuer full type
{
hosted_type?: online | offline | third_party | string,
id?: string,
name?: string,
valid_from?: string,
valid_to?: string
}
key_generation full type
key_generation full type
{
dilithium_key_size?: string,
ecc_curve?: string,
ecdsa_curve?: string,
falcon_key_size?: string,
key_type?: string,
rsa_key_bits?: number,
sphincs_key_size?: string
}
notification full type
notification full type
{
enabled?: boolean,
frequency?: number[],
recipients?: string[]
}
private_key full type
private_key full type
{
password?: string,
pkcs12?: number[],
pre_installed?: boolean
}
recertification_links full type
recertification_links full type
{
created_date?: string,
link_type?: string,
linked_ca?: string
}[]
reinstate_requests full type
reinstate_requests full type
{
comments?: string,
id?: string,
requester_user_id?: string,
requester_username?: string,
reviewer_user_id?: string
}[]
revocation full type
revocation full type
{
comments?: string,
reason?: string,
revoke_date?: string,
revoked?: boolean
}
revocation_requests full type
revocation_requests full type
{
comments?: string,
id?: string,
reason?: string,
requester_user_id?: string,
requester_username?: string,
reviewer_user_id?: string,
revocation_date?: string
}[]
subject full type
subject full type
{
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
validity full type
validity full type
{
duration_unit?: string,
duration_value?: number,
valid_from?: string,
valid_to?: string
}
postRejectCaReinstateRequest
privateCAApi.postRejectCaReinstateRequest
Reject CA Reinstate Request
Risk: write
await corsair.digicert.api.privateCAApi.postRejectCaReinstateRequest({
path: { id: 'example', requestId: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string,
requestId: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
postSetACaBlob
privateCAApi.postSetACaBlob
Set a CA blob
Risk: write
await corsair.digicert.api.privateCAApi.postSetACaBlob({
path: { id: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
blobs?: string[]
}
undefined
postSetCaActiveStatus
privateCAApi.postSetCaActiveStatus
Set CA Active Status
Risk: write
await corsair.digicert.api.privateCAApi.postSetCaActiveStatus({
path: { id: 'example' },
query: { active_status: 'active' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string
}
query full type
query full type
{
active_status: active | disabled
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
postSignACmpRequest
privateCAApi.postSignACmpRequest
Sign a CMP request
Risk: write
await corsair.digicert.api.privateCAApi.postSignACmpRequest({
path: { id: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
protected_part?: number[],
signature?: string,
signature_algorithm?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
protected_part | number[] | No | — |
signature | string | No | — |
signature_algorithm | string | No | — |
postSignAGlobalPlatformRequest
privateCAApi.postSignAGlobalPlatformRequest
Sign a GlobalPlatform request
Risk: write
await corsair.digicert.api.privateCAApi.postSignAGlobalPlatformRequest({
path: { id: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate_type?: string,
create_certificate?: boolean,
csr?: string,
ecdsa?: boolean,
id?: string,
protected_part?: number[],
signature?: string,
signature_algorithm?: string,
signature_length?: number
}
| Name | Type | Required | Description |
|---|---|---|---|
certificate_type | string | No | — |
create_certificate | boolean | No | — |
csr | string | No | — |
ecdsa | boolean | No | — |
id | string | No | — |
protected_part | number[] | No | — |
signature | string | No | — |
signature_algorithm | string | No | — |
signature_length | number | No | — |
postSignAnAttributeCertificate
privateCAApi.postSignAnAttributeCertificate
Sign an Attribute Certificate
Risk: write
await corsair.digicert.api.privateCAApi.postSignAnAttributeCertificate({
path: { id: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
protected_part?: number[],
signature?: string,
signature_algorithm?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
protected_part | number[] | No | — |
signature | string | No | — |
signature_algorithm | string | No | — |
postSingleLogoutService
privateCAApi.postSingleLogoutService
Single Logout Service
Risk: write
await corsair.digicert.api.privateCAApi.postSingleLogoutService({
body: { SAMLRequest: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
SAMLRequest: string
}
string
postVerifyAsn1Template
privateCAApi.postVerifyAsn1Template
Verify ASN1 Template
Risk: write
await corsair.digicert.api.privateCAApi.postVerifyAsn1Template({
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
critical?: boolean,
custom_values?: {
},
oid?: string,
template?: {
},
values_name?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
value | number[] | No | — |
putActivateACustomCertificateTemplate
privateCAApi.putActivateACustomCertificateTemplate
Activate a custom certificate template
Risk: write
await corsair.digicert.api.privateCAApi.putActivateACustomCertificateTemplate({
path: { id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
access | string | No | — |
accounts | object[] | No | — |
active | boolean | No | — |
category | string | No | — |
cert_type | root | intermediate | end_entity | string | No | — |
created_date | string | No | — |
id | string | No | — |
install_type | string | No | — |
issue_types | string[] | No | — |
kind | string | No | — |
name | string | No | — |
template_json | string | No | — |
trust_type | string | No | — |
updated_date | string | No | — |
accounts full type
accounts full type
{
id?: string,
name?: string
}[]
putDeactivateACustomCertificateTemplate
privateCAApi.putDeactivateACustomCertificateTemplate
Deactivate a custom certificate template
Risk: write
await corsair.digicert.api.privateCAApi.putDeactivateACustomCertificateTemplate({
path: { id: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
access | string | No | — |
accounts | object[] | No | — |
active | boolean | No | — |
category | string | No | — |
cert_type | root | intermediate | end_entity | string | No | — |
created_date | string | No | — |
id | string | No | — |
install_type | string | No | — |
issue_types | string[] | No | — |
kind | string | No | — |
name | string | No | — |
template_json | string | No | — |
trust_type | string | No | — |
updated_date | string | No | — |
accounts full type
accounts full type
{
id?: string,
name?: string
}[]
putRevokeCertificate
privateCAApi.putRevokeCertificate
Revoke Certificate
Risk: destructive
await corsair.digicert.api.privateCAApi.putRevokeCertificate({
path: { id: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
comments?: string,
reason?: string,
revoke_date?: string,
revoked?: boolean
}
undefined
putSetAdditionalSettings
privateCAApi.putSetAdditionalSettings
Set Additional Settings
Risk: write
await corsair.digicert.api.privateCAApi.putSetAdditionalSettings({
path: { id: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
allow_extended_validity?: boolean,
allow_pkcs7_operations?: boolean,
allowed_signature_algorithms?: string[]
}
undefined
putSetAnOcspBlob
privateCAApi.putSetAnOcspBlob
Set an OCSP blob
Risk: write
await corsair.digicert.api.privateCAApi.putSetAnOcspBlob({
path: { id: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
blob?: string
}
undefined
putSetAnOcspResponderStatus
privateCAApi.putSetAnOcspResponderStatus
Set an OCSP responder status
Risk: write
await corsair.digicert.api.privateCAApi.putSetAnOcspResponderStatus({
path: { id: 'example', action: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: string,
action: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
putSetCaAccounts
privateCAApi.putSetCaAccounts
Set CA Accounts
Risk: write
await corsair.digicert.api.privateCAApi.putSetCaAccounts({
path: { id: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
accounts?: string[]
}
undefined
putSetCaAiaIssuerConfiguration
privateCAApi.putSetCaAiaIssuerConfiguration
Set CA AIA Issuer Configuration
Risk: write
await corsair.digicert.api.privateCAApi.putSetCaAiaIssuerConfiguration({
path: { id: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap,
type?: string[]
}[],
include?: string,
override_global?: boolean
}
undefined
putSetCaCertPoliciesConfiguration
privateCAApi.putSetCaCertPoliciesConfiguration
Set CA Cert Policies Configuration
Risk: write
await corsair.digicert.api.privateCAApi.putSetCaCertPoliciesConfiguration({
path: { id: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
allowed_sources?: string[],
default_policies?: {
critical?: boolean,
policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[]
},
include?: string,
override_global?: boolean
}
undefined
putSetCaCrlIssuanceConfig
privateCAApi.putSetCaCrlIssuanceConfig
Set CA CRL issuance config
Risk: write
await corsair.digicert.api.privateCAApi.putSetCaCrlIssuanceConfig({
path: { id: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap,
type?: string[]
}[],
end_validity_years?: number,
include?: string,
override_global?: boolean
}
undefined
putSetCaIssuanceCertConfig
privateCAApi.putSetCaIssuanceCertConfig
Set CA issuance cert config
Risk: write
await corsair.digicert.api.privateCAApi.putSetCaIssuanceCertConfig({
path: { id: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
issue_end_entities?: any,
issue_ica_intermediates?: any,
issue_unmanaged_ca?: any
}
undefined
putSetCaOcspGenerationConfig
privateCAApi.putSetCaOcspGenerationConfig
Set CA OCSP generation config
Risk: write
await corsair.digicert.api.privateCAApi.putSetCaOcspGenerationConfig({
path: { id: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
delegated?: boolean,
generation_frequency_hours?: number,
include_chain?: boolean,
offline_cas_option?: sign_with_ca_key_and_fallback | sign_with_responder_and_fallback | sign_only_with_responder | sign_only_with_ca_key,
on_demand?: boolean,
online_cas_option?: sign_with_ca_key_and_fallback | sign_with_responder_and_fallback | sign_only_with_responder | sign_only_with_ca_key,
override_global?: boolean,
response_duration_hours?: number
}
undefined
putSetCaOcspIssuanceConfig
privateCAApi.putSetCaOcspIssuanceConfig
Set CA OCSP issuance config
Risk: write
await corsair.digicert.api.privateCAApi.putSetCaOcspIssuanceConfig({
path: { id: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
domains?: {
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
created_date?: string,
id?: string,
name?: string,
scheme?: http | https | ldap,
type?: string[]
}[],
include?: string,
override_global?: boolean,
uri_path?: string
}
undefined
putSetCaOcspResponderConfig
privateCAApi.putSetCaOcspResponderConfig
Set CA OCSP responder config
Risk: write
await corsair.digicert.api.privateCAApi.putSetCaOcspResponderConfig({
path: { id: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate_policies?: {
cps_uri?: string,
oid?: string,
user_notice?: string
}[],
certificate_template?: {
access?: string,
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
category?: string,
cert_type?: root | intermediate | end_entity,
created_date?: string,
id?: string,
install_type?: string,
issue_types?: string[],
kind?: string,
name?: string,
template_json?: string,
trust_type?: string,
updated_date?: string
},
delete_expired_responders?: boolean,
generation_enabled?: boolean,
hsm_partition?: {
display_name?: string,
id?: string,
partition_name?: string,
provider_name?: string,
security_level?: level_1 | level_2 | level_3 | level_4
},
override_global?: boolean,
responder_create_within_days?: number,
responder_validity_days?: number
}
undefined
putSetCrlConfig
privateCAApi.putSetCrlConfig
Set CRL Config
Risk: write
await corsair.digicert.api.privateCAApi.putSetCrlConfig({
path: { id: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
auto_partition?: {
limit?: number,
on_size?: boolean,
size?: number
},
auto_partition_generation_enabled?: boolean,
crl_scope?: string,
generation?: {
crl_frequency_hours?: any,
crl_validity_hours?: any,
override_global?: any
},
generation_enabled?: boolean,
include_idp?: boolean,
master_crl_enabled?: boolean,
publish_enabled?: boolean,
selected_domains?: string[],
signature_algorithm?: string
}
undefined
putSetIncludeAllCertsInCrl
privateCAApi.putSetIncludeAllCertsInCrl
Set include all certs in CRL
Risk: write
await corsair.digicert.api.privateCAApi.putSetIncludeAllCertsInCrl({
path: { id: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
enabled?: boolean
}
undefined
putSetTheActiveAiaIssuerForACa
privateCAApi.putSetTheActiveAiaIssuerForACa
Set the Active AIA Issuer for a CA
Risk: write
await corsair.digicert.api.privateCAApi.putSetTheActiveAiaIssuerForACa({
path: { id: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
file_name?: string,
id?: string
}
undefined
putSetTheActiveCrlForACa
privateCAApi.putSetTheActiveCrlForACa
Set the Active CRL for a CA
Risk: write
await corsair.digicert.api.privateCAApi.putSetTheActiveCrlForACa({
path: { id: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
file_name?: string,
file_path?: string,
id?: string
}
undefined
putUpdateACertificateChain
privateCAApi.putUpdateACertificateChain
Update a certificate chain
Risk: write
await corsair.digicert.api.privateCAApi.putUpdateACertificateChain({
path: { id: 'example', chainID: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: string,
chainID: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificates?: {
blob?: string,
cert_type?: string,
subject?: {
common_name?: string,
country?: string,
custom_attributes?: {
oid?: string,
type?: string,
values?: string[]
}[],
description?: string[],
dn_qualifier?: string,
domain_component?: string[],
email?: string,
given_name?: string[],
locality?: string,
organization_identifier?: string,
organization_name?: string,
organization_units?: string[],
postal_code?: string,
product_identifier?: string,
pseudonym?: string,
serial_number?: string,
state?: string,
street_address?: string[],
subject_order?: string[],
surname?: string[],
title?: string[],
unique_identifier?: string,
unstructured_address?: string[],
unstructured_name?: string[],
user_identifier?: string,
vendor_identifier?: string
}
}[],
default?: boolean,
id?: string,
name?: string
}
undefined
putUpdateACustomCertificateTemplate
privateCAApi.putUpdateACustomCertificateTemplate
Update a custom certificate template
Risk: write
await corsair.digicert.api.privateCAApi.putUpdateACustomCertificateTemplate({
path: { id: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
access?: string,
accounts?: {
id?: string,
name?: string
}[],
active?: boolean,
category?: string,
cert_type?: root | intermediate | end_entity,
created_date?: string,
id?: string,
install_type?: string,
issue_types?: string[],
kind?: string,
name?: string,
template_json?: string,
trust_type?: string,
updated_date?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
access | string | No | — |
accounts | object[] | No | — |
active | boolean | No | — |
category | string | No | — |
cert_type | root | intermediate | end_entity | string | No | — |
created_date | string | No | — |
id | string | No | — |
install_type | string | No | — |
issue_types | string[] | No | — |
kind | string | No | — |
name | string | No | — |
template_json | string | No | — |
trust_type | string | No | — |
updated_date | string | No | — |
accounts full type
accounts full type
{
id?: string,
name?: string
}[]
putUpdateAnAiaIssuerFile
privateCAApi.putUpdateAnAiaIssuerFile
Update an AIA Issuer File
Risk: write
await corsair.digicert.api.privateCAApi.putUpdateAnAiaIssuerFile({
path: { id: 'example' },
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
active?: boolean,
blob?: string,
ca?: {
id?: string,
name?: string
},
created_date?: string,
file_format?: string,
file_name?: string,
file_path?: string,
id?: string,
is_aia_file_warning?: boolean,
updated_date?: string
}
undefined
Report Library
details
reportLibrary.details
Read a Report Library report configuration.
Risk: read
await corsair.digicert.api.reportLibrary.details({ reportIdentifier: '00000000-0000-4000-8000-000000000001' });
| Name | Type | Required | Description |
|---|---|---|---|
reportIdentifier | string | Yes | — |
language_id | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
report | object | Yes | — |
report full type
report full type
{
report_display_name: string,
report_identifier: string,
created_by_user_id: number | string,
created_by_user_name: string,
created_date: string,
report_metadata: {
report_type: string,
columns: {
identifier: string
}[],
filters?: {
filter_identifier: string,
column_identifier: string,
values?: string[]
}[],
sources?: {
division_filter_type?: string,
sub_account_filter_type?: string,
divisions?: number[] | null,
sub_accounts?: number[] | null
}
},
schedule: {
frequency: string,
weekday_to_run?: string,
weekday_frequency?: string,
run_until?: string,
repeat_every?: number,
repeat_on?: string,
repeat_on_date?: {
date?: number,
last_day_of_the_month?: boolean
}
},
next_run_date?: string,
format: string[],
status: string,
notification_emails?: {
user_id: number,
first_name: string,
last_name: string,
email: string
}[] | null
}
history
reportLibrary.history
List scheduled reports and individual report runs.
Risk: read
await corsair.digicert.api.reportLibrary.history({});
| Name | Type | Required | Description |
|---|---|---|---|
offset | number | No | — |
limit | number | No | — |
report_display_name | string | No | — |
schedule | ON_DEMAND | WEEKLY | MONTHLY | No | — |
status | SCHEDULED | GENERATING | READY | FAILED | No | — |
report_type | string | No | — |
report_type_display_name | string | No | — |
search | string | No | — |
sort_by | report_display_name | report_type | schedule | format | report_start_date | No | — |
sort_direction | ASC | DESC | No | — |
language_id | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
page | object | Yes | — |
report_history | object[] | Yes | — |
page full type
page full type
{
total: number,
limit: number,
offset: number
}
report_history full type
report_history full type
{
report_display_name: string,
report_identifier: string,
report_run_identifier?: string,
created_by_user_id: number | string,
created_by_user_name: string,
created_date: string,
report_type: string,
report_type_display_name: string,
report_start_date?: string,
report_end_date?: string,
schedule?: string,
format?: string[],
status: string,
manually_triggered?: boolean,
split_report_count?: number,
data_from_date?: string,
data_to_date?: string
}[]
names
reportLibrary.names
List Report Library report names.
Risk: read
await corsair.digicert.api.reportLibrary.names({});
| Name | Type | Required | Description |
|---|---|---|---|
report_display_name | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
report_names | string[] | Yes | — |
types
reportLibrary.types
List Report Library report types and supported formats.
Risk: read
await corsair.digicert.api.reportLibrary.types({});
| Name | Type | Required | Description |
|---|---|---|---|
language_id | number | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
report_types | object[] | Yes | — |
report_types full type
report_types full type
{
report_type: string,
display_name: string,
supported_formats: string[],
custom_fields_enabled: boolean,
sub_account_enabled: boolean,
division_enabled: boolean,
report_description: string,
status: boolean,
is_customizable?: boolean,
is_customisable?: boolean
}[]
Report Library Api
createReport
reportLibraryApi.createReport
Create report
Risk: write
await corsair.digicert.api.reportLibraryApi.createReport({
body: {
display_name: 'example',
schedule: { frequency: 'example' },
format: ['example'],
report_metadata: { report_type: 'example' },
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
language_id?: number
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
display_name: string,
schedule: {
frequency: string,
weekday_to_run?: string,
weekday_frequency?: string,
repeat_every?: string | number,
repeat_on?: string,
repeat_on_date?: {
date?: number,
last_day_of_the_month?: boolean
},
run_until?: string
},
format: string[],
notification_emails?: {
user_id: number,
first_name: string,
last_name: string,
email: string
}[],
report_metadata: {
report_type: string,
columns?: {
identifier: string
}[],
filters?: {
column_identifier: string,
values?: string[],
filter_identifier: string
}[],
sources?: {
division_filter_type?: string,
divisions?: number[],
sub_account_filter_type?: string,
sub_accounts?: number[]
}
}
}
| Name | Type | Required | Description |
|---|---|---|---|
report_identifier | string | No | — |
message | string | No | — |
deleteReport
reportLibraryApi.deleteReport
Delete report
Risk: destructive
await corsair.digicert.api.reportLibraryApi.deleteReport({
path: { report_identifier: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
report_identifier: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
message | string | No | — |
deleteReportRun
reportLibraryApi.deleteReportRun
Delete report run
Risk: destructive
await corsair.digicert.api.reportLibraryApi.deleteReportRun({
path: { report_identifier: 'example', report_run_identifier: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
report_identifier: string,
report_run_identifier: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
message | string | No | — |
deleteScheduledReport
reportLibraryApi.deleteScheduledReport
Delete scheduled report
Risk: destructive
await corsair.digicert.api.reportLibraryApi.deleteScheduledReport({
path: { report_identifier: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
report_identifier: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
message | string | No | — |
downloadReport
reportLibraryApi.downloadReport
Download report
Risk: read
await corsair.digicert.api.reportLibraryApi.downloadReport({
path: { report_identifier: '00000000-0000-4000-8000-000000000001', report_run_identifier: '00000000-0000-4000-8000-000000000002' },
query: { report_format: 'EXCEL' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
report_identifier: string,
report_run_identifier: string
}
query full type
query full type
{
report_format: JSON | CSV | EXCEL | ZIP,
split_report_sequence?: number
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
number[]
editReport
reportLibraryApi.editReport
Edit report
Risk: write
await corsair.digicert.api.reportLibraryApi.editReport({
path: { report_identifier: 'example' },
body: {
display_name: 'example',
schedule: { frequency: 'example' },
format: ['example'],
report_metadata: { report_type: 'example' },
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
report_identifier: string
}
query full type
query full type
{
language_id?: number
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
display_name: string,
schedule: {
frequency: string,
weekday_to_run?: string,
weekday_frequency?: string,
repeat_every?: string | number,
repeat_on?: string,
repeat_on_date?: {
date?: number,
last_day_of_the_month?: boolean
},
run_until?: string
},
format: string[],
notification_emails?: {
user_id: number,
first_name: string,
last_name: string,
email: string
}[],
report_metadata: {
report_type: string,
columns?: {
identifier: string
}[],
filters?: {
column_identifier: string,
values?: string[],
filter_identifier: string
}[],
sources?: {
division_filter_type?: string,
divisions?: number[],
sub_account_filter_type?: string,
sub_accounts?: number[]
}
}
}
JsonValue
getJsonReport
reportLibraryApi.getJsonReport
Get JSON report
Risk: read
await corsair.digicert.api.reportLibraryApi.getJsonReport({
path: { report_identifier: 'example', report_run_identifier: 'example' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
report_identifier: string,
report_run_identifier: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
JsonValue
listColumns
reportLibraryApi.listColumns
List columns
Risk: read
await corsair.digicert.api.reportLibraryApi.listColumns({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
language_id?: number
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
display_categories | JsonValue[] | No | — |
display_category_name | string | No | — |
display_sub_categories | JsonValue[] | No | — |
startReportRun
reportLibraryApi.startReportRun
Start report run
Risk: write
await corsair.digicert.api.reportLibraryApi.startReportRun({
path: { report_identifier: '00000000-0000-4000-8000-000000000001' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
report_identifier: string
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
report_identifier | string | No | — |
message | string | No | — |
Trust Lifecycle
addCertificateTags
trustLifecycle.addCertificateTags
Add custom tags to a Trust Lifecycle Manager certificate.
Risk: write
await corsair.digicert.api.trustLifecycle.addCertificateTags({ certificateId: '00000000-0000-0000-0000-000000000000', tags: ['reviewed'] });
| Name | Type | Required | Description |
|---|---|---|---|
certificateId | string | Yes | — |
tags | string[] | Yes | — |
undefined
version
trustLifecycle.version
Read the unauthenticated Trust Lifecycle Manager version.
Risk: read
await corsair.digicert.api.trustLifecycle.version({});
| Name | Type | Required | Description |
|---|---|---|---|
version | string | Yes | — |
Trust Lifecycle Api
abortScanUsingPost
trustLifecycleApi.abortScanUsingPost
Abort scan
Risk: write
await corsair.digicert.api.trustLifecycleApi.abortScanUsingPost({
path: {
scan_id: {},
},
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
scan_id: any
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
abortSystemScanUsingPostpublic
trustLifecycleApi.abortSystemScanUsingPostpublic
Abort system scan
Risk: write
await corsair.digicert.api.trustLifecycleApi.abortSystemScanUsingPostpublic({
path: {
agentId: {},
},
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
agentId: any
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
addScanUsingPost
trustLifecycleApi.addScanUsingPost
Add scan
Risk: write
await corsair.digicert.api.trustLifecycleApi.addScanUsingPost({
body: {
account_id: {},
config: {},
frequency: 'DAILY',
name: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account_id: any,
business_unit_id?: any,
cipher_scan?: any,
config: {
day_of_month?: any,
days_to_run?: any,
disable_ping?: any,
do_not_follow_http_redirects?: any,
extra_tls_protocols_discovery?: any,
ipv6?: any,
is_os_discovery?: any,
is_server_application_discovery?: any,
refresh_host_ip_inventory?: any,
restrict_emulated_tls_issues_scan?: any,
scan_option?: CUSTOM | OPTIMIZE,
sensor_with_ip_port?: any,
sni?: any,
speed?: FAST | MEDIUM | SLOW,
ssh_discovery?: any,
start_time?: any,
time_to_complete?: any,
timezone?: any,
tls_ssl_critical_issues?: any,
tls_ssl_non_critical_issues?: any,
week_of_month?: FIRST | FOURTH | LAST | SECOND | THIRD
},
data_business_unit_id?: any,
enable_debug_ports?: any,
frequency: DAILY | MONTHLY | ONE_TIME | WEEKLY,
id?: any,
name: any,
save_only?: any,
tags?: any
}
undefined
addSystemScanUsingPostpublic
trustLifecycleApi.addSystemScanUsingPostpublic
Add and update system scan
Risk: write
await corsair.digicert.api.trustLifecycleApi.addSystemScanUsingPostpublic({
body: {
account_id: {},
targets: {},
options: {},
schedule: {
frequency: 'ONE_TIME',
start_time: {},
},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account_id: any,
targets: {
agents?: any,
groups?: any
},
options: {
os_certificate_store_scan?: any,
file_system_scan?: any,
file_system_scan_types?: any,
keystore_credentials?: any,
os_cert_store_scan_options?: {
local_machine_stores?: any,
current_user_stores?: any
},
data_business_unit_id?: any,
tags?: any
},
schedule: {
frequency: ONE_TIME | DAILY | WEEKLY | MONTHLY,
start_time: any,
timezone?: any,
days_to_run?: any,
day_of_month?: any,
week_of_month?: FIRST | SECOND | THIRD | FOURTH | LAST | null
}
}
undefined
allocateNewSensorUsingPost
trustLifecycleApi.allocateNewSensorUsingPost
Allocate sensor
Risk: write
await corsair.digicert.api.trustLifecycleApi.allocateNewSensorUsingPost({
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
account_id: any,
business_unit_id?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | any | No | — |
name | any | No | — |
status | ACTIVE | ALLOCATE | COMMUNICATION_LOST_ERROR | SHUTDOWN | SUSPEND | VOID | No | — |
version | any | No | — |
license_key | any | No | — |
debug_enabled | any | No | — |
allowed_actions | any | No | — |
business_unit | object | No | — |
business_unit full type
business_unit full type
{
id: any,
name?: any
}& any
cancelAutomationUsingPut
trustLifecycleApi.cancelAutomationUsingPut
Cancel certificate automation request
Risk: write
await corsair.digicert.api.trustLifecycleApi.cancelAutomationUsingPut({
path: {
automation_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
automation_id: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
certRevokeBySerial
trustLifecycleApi.certRevokeBySerial
Revoke certificate
Risk: destructive
await corsair.digicert.api.trustLifecycleApi.certRevokeBySerial({
path: {
serial_number: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
serial_number: any
}
query full type
query full type
{
thumbprint_sha256?: any,
account_id?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
revocation_reason: unspecified | key_compromise | affiliation_changed | superseded | cessation_of_operation | privilege_withdrawn | certificate_hold
}
undefined
checkEligibilityOfBulkAutomationUsingPost
trustLifecycleApi.checkEligibilityOfBulkAutomationUsingPost
Check eligibility for bulk automation
Risk: write
await corsair.digicert.api.trustLifecycleApi.checkEligibilityOfBulkAutomationUsingPost({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account_id?: any,
record_ids?: any,
awr_profile_id?: any,
sensor_profile_id?: any,
agent_profile_id?: any,
ca_name?: any,
bulk_action_type?: {
primaryAction?: ENROLL | GET_NEXT_CERT | REISSUE | RENEW | TRANSFER,
renewalStartDate?: any,
secondaryActions?: any
}
}
undefined
checkScanExistPost
trustLifecycleApi.checkScanExistPost
Check if scan exists
Risk: write
await corsair.digicert.api.trustLifecycleApi.checkScanExistPost({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account_id: any,
name: any
}
undefined
createAutomationUsingPost
trustLifecycleApi.createAutomationUsingPost
Create certificate lifecycle automation event
Risk: write
await corsair.digicert.api.trustLifecycleApi.createAutomationUsingPost({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
automation_id: any,
account_id: any,
action_type: ENROLL | GET_NEXT_CERT | REISSUE | RENEW | TRANSFER,
auto_renew_settings?: {
auto_renew_certificate_and_order: any,
auto_renew_time?: {
days?: any,
hours?: any,
minutes?: any,
time_format: any,
zone: any
},
before_expiration: any
},
cn: any,
custom_fields?: any,
dns_integration_id?: any,
profile_id: any,
redirect_port?: any,
run_now?: any,
sans?: any,
schedule_settings?: {
hours?: any,
minutes?: any,
start_date: any,
time_format: any,
zone?: any
},
match_wildcard_subdomain?: any,
custom_attributes_field?: any
}
undefined
createAwrAutomationUsingPost
trustLifecycleApi.createAwrAutomationUsingPost
Create certificate lifecycle event with automated distribution
Risk: write
await corsair.digicert.api.trustLifecycleApi.createAwrAutomationUsingPost({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
profile_id?: any,
cn?: any,
sans?: any,
account_id?: any,
auto_renew_settings?: {
auto_renew_certificate_and_order: any,
auto_renew_time?: {
days?: any,
hours?: any,
minutes?: any,
time_format: any,
zone: any
},
before_expiration: any
},
additional_order_options?: {
comments_to_administrator?: any,
order_specific_renewal_message?: any,
additional_emails?: any
},
cert_delivery_settings?: any,
tags?: any,
action_type?: ENROLL | GET_NEXT_CERT | REISSUE | RENEW | TRANSFER,
inventory_id?: any,
source_certificate_id?: any,
custom_attributes_field?: any
}
undefined
createSensorIntegration
trustLifecycleApi.createSensorIntegration
Create sensor integration
Risk: write
await corsair.digicert.api.trustLifecycleApi.createSensorIntegration({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
name: any,
integration_type?: AWS | AWS-CLOUDFRONT | BIGIP | NETSCALER | A10,
sensor_id: any,
category: APPLIANCE | CLOUD_SERVICE | DNS_INTEGRATION,
parameters: any
}
| Name | Type | Required | Description |
|---|---|---|---|
id | any | No | — |
name | any | No | — |
status | INITIAL | NOT_CONFIGURED | REFRESHING_CONFIG | CONFIGURED | COMMUNICATION_ERROR | SUSPENDED | VOIDED | NETWORK_ERROR | AUTHENTICATION_ERROR | TESTING_CONNECTION | LICENSE_REQUESTED | UPGRADING | ACTION_NEEDED | No | — |
status_details | any | No | — |
type | AWS | AWS-CLOUDFRONT | BIGIP | NETSCALER | A10 | No | — |
application_name | AWS | AWS-CLOUDFRONT | BIGIP | NETSCALER | No | — |
parameter_id | any | No | — |
account_id | any | No | — |
business_unit_id | any | No | — |
app_info | object | No | — |
management_key | any | No | — |
is_fips_present | any | No | — |
created_at | any | No | — |
updated | any | No | — |
category | CLOUD_SERVICE | APPLIANCE | DNS_INTEGRATION | No | — |
ha_peers | any | No | — |
parameters | any | No | — |
sensor_ids | any | No | — |
app_info full type
app_info full type
{
name?: any,
version?: any,
arch?: any,
flavor?: any,
automation_order?: any
}
createUsingPost1
trustLifecycleApi.createUsingPost1
Create a connector
Risk: write
await corsair.digicert.api.trustLifecycleApi.createUsingPost1({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
name: any,
business_unit_id: any,
account_id: any,
preset_id: 36cbd4c2-f6e7-4a35-a4e6-e03ebf939cb4,
tags?: any,
username: any,
password: any,
api_key: any,
credentials?: any,
region: US | EU,
import_attributes?: {
all_valid_certificates_from_last_4_years?: any,
all_expired_certificates_within?: any,
all_revoked_certificates_that_are_valid?: any,
business_unit_id?: any,
tags?: any,
schedule_frequency?: {
units?: HOURS | MINUTES | WEEKS,
value?: any
},
cc_division_bu_mapping?: any,
import_all_data?: any,
business_unit_name?: any
}
} | {
account_id: any,
business_unit_id?: any,
name: any,
preset_id: a7f721aa-4796-4815-9128-6796fedbb917,
username: any,
password: any,
url: any
} | {
account_id: any,
business_unit_id: any,
name: any,
preset_id: any,
core_attributes: any,
config_attributes: any,
additional_attributes?: {
all_valid_certificates_from_last_4_years?: any,
all_expired_certificates_within?: any,
all_revoked_certificates_that_are_valid?: any,
business_unit_id?: any,
s3_bucket_name?: any,
is_new_s3_bucket_required?: any,
last_fetched_time?: any,
tags?: any,
schedule_frequency?: {
units?: HOURS | MINUTES | WEEKS,
value?: any
}
}
}
undefined
deleteBulkUnmapDevicesFromProfiles
trustLifecycleApi.deleteBulkUnmapDevicesFromProfiles
Bulk unmap devices from profiles
Risk: destructive
await corsair.digicert.api.trustLifecycleApi.deleteBulkUnmapDevicesFromProfiles({
query: {
account_id: {},
},
body: {
deviceInventoryIds: {},
profileIds: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
deviceInventoryIds: any,
profileIds: any
}
| Name | Type | Required | Description |
|---|---|---|---|
count | any | No | — |
message | any | No | — |
rejectedProfiles | any | No | — |
deleteByIdUsingDelete
trustLifecycleApi.deleteByIdUsingDelete
Delete connector
Risk: destructive
await corsair.digicert.api.trustLifecycleApi.deleteByIdUsingDelete({
path: {
connector_id: {},
},
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
connector_id: any
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
deleteCertificatesBySourceTypes
trustLifecycleApi.deleteCertificatesBySourceTypes
Delete discovered certificates by source types
Risk: destructive
await corsair.digicert.api.trustLifecycleApi.deleteCertificatesBySourceTypes({
query: {
account_id: {},
source_type: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
account_id: any,
source_type: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
connector_filter?: {
cn_san_filter?: {
common_names?: any,
sans?: any
}
}& {
connector_ids?: any
},
network_scan_filter?: {
cn_san_filter?: {
common_names?: any,
sans?: any
}
}& {
network_scan_ids?: any
},
system_scan_filter?: {
cn_san_filter?: {
common_names?: any,
sans?: any
}
}& any,
ct_log_scan_filter?: {
cn_san_filter?: {
common_names?: any,
sans?: any
}
}& any
}
undefined
deleteDeleteBusinessUnit
trustLifecycleApi.deleteDeleteBusinessUnit
Delete business unit
Risk: destructive
await corsair.digicert.api.trustLifecycleApi.deleteDeleteBusinessUnit({
path: {
bu_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
bu_id: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
deleteDeleteCertificateOwner
trustLifecycleApi.deleteDeleteCertificateOwner
Delete certificate owner
Risk: destructive
await corsair.digicert.api.trustLifecycleApi.deleteDeleteCertificateOwner({
path: {
id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
status | any | No | — |
affected_profiles | any | No | — |
deleteDeleteCertificateOwnerMappingsForACertificate
trustLifecycleApi.deleteDeleteCertificateOwnerMappingsForACertificate
Delete certificate owner mappings for a certificate
Risk: destructive
await corsair.digicert.api.trustLifecycleApi.deleteDeleteCertificateOwnerMappingsForACertificate({
path: {
id: {},
},
body: {
account_id: {},
certificate_owner_ids: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account_id: any,
certificate_owner_ids: any
}
undefined
deleteDeleteCustomAttribute
trustLifecycleApi.deleteDeleteCustomAttribute
Delete custom attribute
Risk: destructive
await corsair.digicert.api.trustLifecycleApi.deleteDeleteCustomAttribute({
path: {
id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
status | any | No | — |
affected_profiles | any | No | — |
deleteDeleteCustomAttributesMappingForCertificate
trustLifecycleApi.deleteDeleteCustomAttributesMappingForCertificate
Delete custom attributes mapping for certificate
Risk: destructive
await corsair.digicert.api.trustLifecycleApi.deleteDeleteCustomAttributesMappingForCertificate({
path: {
id: {},
},
body: {
account_id: {},
custom_attribute_ids: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account_id: any,
custom_attribute_ids: any
}
undefined
deleteDeleteDevice
trustLifecycleApi.deleteDeleteDevice
Delete device
Risk: destructive
await corsair.digicert.api.trustLifecycleApi.deleteDeleteDevice({
path: {
id: {},
},
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: any
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
deleteDeleteDevicesBulk
trustLifecycleApi.deleteDeleteDevicesBulk
Delete devices (bulk)
Risk: destructive
await corsair.digicert.api.trustLifecycleApi.deleteDeleteDevicesBulk({
query: {
account_id: {},
},
body: {
deviceInventoryIds: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
deviceInventoryIds: any
}
| Name | Type | Required | Description |
|---|---|---|---|
count | any | No | — |
message | any | No | — |
rejectedProfiles | any | No | — |
deleteDeleteRules
trustLifecycleApi.deleteDeleteRules
Delete rules
Risk: destructive
await corsair.digicert.api.trustLifecycleApi.deleteDeleteRules({
query: {
account_id: {},
},
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | any | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
deleteDeleteSeat
trustLifecycleApi.deleteDeleteSeat
Delete seat
Risk: destructive
await corsair.digicert.api.trustLifecycleApi.deleteDeleteSeat({
path: {
seat_id: {},
},
query: { seat_type_id: 'USER_SEAT' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
seat_id: any
}
query full type
query full type
{
seat_type_id: USER_SEAT | DEVICE_SEAT | SERVER_SEAT | CERTIFICATE_MANAGEMENT_SEAT | IMPORTED_SEAT | DISCOVERY_SEAT | ORGANIZATION_SEAT,
business_unit_id?: any,
revocation_reason?: cessation_of_operation | key_compromise | affiliation_changed | superseded
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
deletePastSystemScanUsingPostpublic
trustLifecycleApi.deletePastSystemScanUsingPostpublic
Delete past system scan instance
Risk: destructive
await corsair.digicert.api.trustLifecycleApi.deletePastSystemScanUsingPostpublic({
path: {
agentId: {},
scanId: {},
},
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
agentId: any,
scanId: any
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
deleteRemoveAnAdminFromABusinessUnit
trustLifecycleApi.deleteRemoveAnAdminFromABusinessUnit
Remove an admin from a Business Unit
Risk: destructive
await corsair.digicert.api.trustLifecycleApi.deleteRemoveAnAdminFromABusinessUnit({
path: {
id: {},
adminId: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: any,
adminId: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
deleteResumeSuspendedCertificate
trustLifecycleApi.deleteResumeSuspendedCertificate
Resume suspended certificate
Risk: destructive
await corsair.digicert.api.trustLifecycleApi.deleteResumeSuspendedCertificate({
path: {
serial_number: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
serial_number: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
deleteScanUsingPost
trustLifecycleApi.deleteScanUsingPost
Delete scan
Risk: destructive
await corsair.digicert.api.trustLifecycleApi.deleteScanUsingPost({
query: {
account_id: {},
},
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
scans?: any
}
undefined
editScanUsingPut
trustLifecycleApi.editScanUsingPut
Edit scan
Risk: write
await corsair.digicert.api.trustLifecycleApi.editScanUsingPut({
body: {
account_id: {},
config: {},
frequency: 'DAILY',
name: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account_id: any,
business_unit_id?: any,
cipher_scan?: any,
config: {
day_of_month?: any,
days_to_run?: any,
disable_ping?: any,
do_not_follow_http_redirects?: any,
extra_tls_protocols_discovery?: any,
ipv6?: any,
is_os_discovery?: any,
is_server_application_discovery?: any,
refresh_host_ip_inventory?: any,
restrict_emulated_tls_issues_scan?: any,
scan_option?: CUSTOM | OPTIMIZE,
sensor_with_ip_port?: any,
sni?: any,
speed?: FAST | MEDIUM | SLOW,
ssh_discovery?: any,
start_time?: any,
time_to_complete?: any,
timezone?: any,
tls_ssl_critical_issues?: any,
tls_ssl_non_critical_issues?: any,
week_of_month?: FIRST | FOURTH | LAST | SECOND | THIRD
},
data_business_unit_id?: any,
enable_debug_ports?: any,
frequency: DAILY | MONTHLY | ONE_TIME | WEEKLY,
id?: any,
name: any,
save_only?: any,
tags?: any
}
undefined
getAdditionalFormatsBySerialNumber
trustLifecycleApi.getAdditionalFormatsBySerialNumber
Get additional formats for certificate by serial number
Risk: read
await corsair.digicert.api.trustLifecycleApi.getAdditionalFormatsBySerialNumber({
path: {
serial_number: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
serial_number: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
pkcs7 | any | No | — |
x509_cert_chain | any | No | — |
getAttributesOfRenewableCertificateUsingCertIdUsingGet
trustLifecycleApi.getAttributesOfRenewableCertificateUsingCertIdUsingGet
Get enrollment details for renewable certificate using Certificate-Id
Risk: read
await corsair.digicert.api.trustLifecycleApi.getAttributesOfRenewableCertificateUsingCertIdUsingGet({
path: {
certificate_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
certificate_id: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
attributes | object | No | — |
email | any | No | — |
enrollment_id | any | No | — |
enrollment_secret | any | No | — |
enrollment_status | approved | created | expired | in_progress | locked | pending | pending_second_approval | redeemed | rejected | No | — |
has_parent | any | No | — |
profile | object | No | — |
serial_number | any | No | — |
attributes full type
attributes full type
{
custom_values?: any
}
profile full type
profile full type
{
account?: {
id: any,
name?: any
},
acme_credentials?: {
directory_url?: any,
eab_hmac?: any,
eab_kid?: any
},
action_needed_reason?: any,
active?: any,
additional_recipients?: any,
admin_contact?: {
account_id?: any,
email?: any,
enabled?: any,
id?: any,
name?: any,
phone?: any,
profile_id?: any
},
allow_validity_from_rest_api?: any,
api_token_ids?: any,
authentication_fields?: any,
authentication_method?: any,
automated_renewal?: any,
business_unit?: {
id: any,
name?: any
},
ca_chain_value?: any,
ca_settings?: {
auto_renew_settings?: {
auto_renew_certificate_and_order: any,
auto_renew_time?: {
days?: any,
hours?: any,
minutes?: any,
time_format: any,
zone: any
},
before_expiration: any
},
contacts?: any,
msca_settings?: {
certificate_fields?: any,
extensions?: any,
name?: any
},
organization?: {
id: any,
name: any
}
},
cc_settings?: any,
cert_delivery_format?: pkcs12 | pkcs12_der | pkcs12_pem | pkcs7 | x509,
connector?: {
id: any,
name?: any
},
days_till_enrollment_expires?: any,
digicert_desktop_client_settings?: any,
digicert_trust_assistant_settings?: any,
duplicate_certificate_allowed?: any,
email_templates?: any,
embed_enrollment_code_in_url?: any,
enable_dual_admin_approval?: any,
enable_ldap_search?: any,
enrollment_code_length?: any,
enrollment_method?: any,
enrollment_urls?: any,
fields?: any,
fixed_enrollment_url?: any,
global_enrollment_code?: any,
global_enrollment_code_enabled?: any,
ica?: {
id: any,
name?: any
},
id?: any,
instruction_file_id?: any,
instruction_file_name?: any,
instruction_format?: doc | docx | pdf | ppt | pptx | txt,
intune_settings?: {
intune_app_id?: any,
intune_app_key?: any,
intune_push_enabled?: any,
intune_tenant_name?: any
},
key_escrow_policy?: {
dual_admin_recovery?: any,
key_escrow_deployment_mode?: CLOUD | LOCAL | string,
key_escrow_enabled?: any
},
max_number_of_bad_attempts?: any,
microsoft_auto_enrollment_client_settings?: {
crypto_providers?: {
modifiable?: any,
providers?: any
},
end_entity_type?: machine | user | string,
enroll_on_behalf_of?: any,
enroll_on_behalf_of_modifiable?: any,
enrollment_mode?: {
mode: inform_user | silent | string,
modifiable?: any
},
key_spec?: at_keyexchange | at_signature | xcn_at_none,
private_key_export?: {
allowed?: any,
modifiable?: any
},
publish_to_ad?: any,
template_oid?: any,
template_schema_version?: any,
windows_hello_logon?: any
},
name?: any,
notify_requestor?: any,
platform8_api_key?: {
id?: any,
name?: any,
value?: any
},
renewal_window_days?: any,
saml_settings?: {
enforce_manual_approval?: any,
idp_certificate?: any,
idp_issuer?: any,
idp_single_logout_url?: any,
idp_url?: any,
sp_certificate?: any
},
scep_settings?: {
encryption_algorithm: aes128WithCBC | aes128WithGCM | aes256WithCBC | aes256WithGCM | desEDEWith3CBC | desWithCBC | string,
standard: DRAFT_NOURSE_SCEP_23 | RFC_8894_DRAFT_GUTMANN_SCEP_16 | string
},
seat_id_mapping?: common_name | dns_names | email | other_name_guid | registered_ids | san_emails | serial_number | subject_email | unique_identifier | upn,
seat_type_id?: any,
seat_type_name?: any,
suspended?: any,
template?: {
id: any,
name?: any,
trust_type?: private | public | string
},
use_custom_contact?: any
}
getAutomatableCount
trustLifecycleApi.getAutomatableCount
Get automatable endpoints count
Risk: read
await corsair.digicert.api.trustLifecycleApi.getAutomatableCount({
query: {
account: {
id: {},
name: {},
},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
account: {
id: any,
name: any
},
ip?: any,
port?: any,
connector?: any,
application?: any,
tags?: any,
automationStatus?: ACME_ACCOUNT_CREATED | ACME_CLIENT_APP_UPGRADE_IN_PROGRESS | ACTION_REQUIRED | AGENT_ERROR | AUTOMATED_BY_AGENT | AUTOMATED_BY_AGENTLESS | AUTOMATION_AT_RISK | AUTOMATION_FAILED | AUTOMATION_PROFILE_BLOCKED | AUTOMATION_REQUESTED | AUTOMATION_SCHEDULED | AUTOMATION_SUCCESSFUL | AUTO_RENEW_SCHEDULED | CERT_PENDING_APPROVAL | CERT_READY_TO_INSTALL | CERT_REQ_DENIED_BY_CIS | CONFIGURATION_ERROR | CONFIGURATION_IN_PROGRESS | CONFIGURED | CONFLICTED | CSR_GENERATION_FAILED | CSR_GENERATION_IN_PROGRESS | CSR_GENERATION_SUCCEEDED | DELETED | DISABLED_FOR_AUTOMATION | DNS_INTEGRATION_FAILED | IGNORED | INSTALL_FAILED | INSTALL_IN_PROGRESS | INSTALL_SUCCEEDED | INSTALL_VALIDATED | INSTALL_VALIDATION_FAILED | INSTALL_VALIDATION_IN_PROGRESS | IS_UPGRADE | NOT_CONFIGURED | NOT_SCANNED | POST_CSR_FAILED | REMOVED | SCAN_IN_PROGRESS,
virtualServerName?: any,
isAutoRenew?: any,
hasBeenAutomated?: any,
certificateThumbprint?: any,
common_name?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
getAutomatableEndpoint
trustLifecycleApi.getAutomatableEndpoint
Get automatable endpoints
Risk: read
await corsair.digicert.api.trustLifecycleApi.getAutomatableEndpoint({
query: {
account: {
id: {},
name: {},
},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
offset?: any,
limit?: any,
sort?: any,
account: {
id: any,
name: any
},
ip?: any,
port?: any,
connector?: any,
application?: any,
tags?: any,
automationStatus?: ACME_ACCOUNT_CREATED | ACME_CLIENT_APP_UPGRADE_IN_PROGRESS | ACTION_REQUIRED | AGENT_ERROR | AUTOMATED_BY_AGENT | AUTOMATED_BY_AGENTLESS | AUTOMATION_AT_RISK | AUTOMATION_FAILED | AUTOMATION_PROFILE_BLOCKED | AUTOMATION_REQUESTED | AUTOMATION_SCHEDULED | AUTOMATION_SUCCESSFUL | AUTO_RENEW_SCHEDULED | CERT_PENDING_APPROVAL | CERT_READY_TO_INSTALL | CERT_REQ_DENIED_BY_CIS | CONFIGURATION_ERROR | CONFIGURATION_IN_PROGRESS | CONFIGURED | CONFLICTED | CSR_GENERATION_FAILED | CSR_GENERATION_IN_PROGRESS | CSR_GENERATION_SUCCEEDED | DELETED | DISABLED_FOR_AUTOMATION | DNS_INTEGRATION_FAILED | IGNORED | INSTALL_FAILED | INSTALL_IN_PROGRESS | INSTALL_SUCCEEDED | INSTALL_VALIDATED | INSTALL_VALIDATION_FAILED | INSTALL_VALIDATION_IN_PROGRESS | IS_UPGRADE | NOT_CONFIGURED | NOT_SCANNED | POST_CSR_FAILED | REMOVED | SCAN_IN_PROGRESS,
virtualServerName?: any,
isAutoRenew?: any,
hasBeenAutomated?: any,
certificateThumbprint?: any,
common_name?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
getAutomationDetailsUsingGet
trustLifecycleApi.getAutomationDetailsUsingGet
Get certificate lifecycle automation details by inventory ID
Risk: read
await corsair.digicert.api.trustLifecycleApi.getAutomationDetailsUsingGet({
path: {
automation_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
automation_id: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | any | No | — |
automation_flow_details | object | No | — |
automation_status | (ACME_ACCOUNT_CREATED | ACME_CLIENT_APP_UPGRADE_IN_PROGRESS | ACTION_REQUIRED | AGENT_ERROR | AUTOMATED_BY_AGENT | AUTOMATED_BY_AGENTLESS | AUTOMATION_AT_RISK | AUTOMATION_FAILED | AUTOMATION_PROFILE_BLOCKED | AUTOMATION_REQUESTED | AUTOMATION_SCHEDULED | AUTOMATION_SUCCESSFUL | AUTO_RENEW_SCHEDULED | CERT_PENDING_APPROVAL | CERT_READY_TO_INSTALL | CERT_REQ_DENIED_BY_CIS | CONFIGURATION_ERROR | CONFIGURATION_IN_PROGRESS | CONFIGURED | CONFLICTED | CSR_GENERATION_FAILED | CSR_GENERATION_IN_PROGRESS | CSR_GENERATION_SUCCEEDED | DELETED | DISABLED_FOR_AUTOMATION | DNS_INTEGRATION_FAILED | IGNORED | INSTALL_FAILED | INSTALL_IN_PROGRESS | INSTALL_SUCCEEDED | INSTALL_VALIDATED | INSTALL_VALIDATION_FAILED | INSTALL_VALIDATION_IN_PROGRESS | IS_UPGRADE | NOT_CONFIGURED | NOT_SCANNED | POST_CSR_FAILED | REMOVED | SCAN_IN_PROGRESS | string) & any | No | — |
certificate_details | object | No | — |
automation_flow_details full type
automation_flow_details full type
{
auto_renew_enabled?: any,
auto_renew_settings?: {
auto_renew_certificate_and_order: any,
auto_renew_time?: {
days?: any,
hours?: any,
minutes?: any,
time_format: any,
zone: any
},
before_expiration: any
},
automation_error?: {
error_code?: any,
error_message?: any,
solution?: any
},
is_retry_applicable?: any,
last_initiated_time?: any,
last_run_time?: any,
next_run_time?: any,
organization?: {
id: any,
name?: any
},
dns_integration?: {
id: any,
name?: any
},
profile?: {
id: any,
name?: any
},
schedule_settings?: {
hours?: any,
minutes?: any,
start_date: any,
time_format: any,
zone?: any
},
template?: {
id?: any,
name?: any,
trust_type?: any
}
}
certificate_details full type
certificate_details full type
{
cert_validity?: any,
common_name?: any,
ip?: any,
key_algorithm?: any,
key_size?: any,
order_id?: any,
order_valid_till?: any,
port?: any,
previous_action_type?: ENROLL | GET_NEXT_CERT | REISSUE | RENEW | TRANSFER,
product_name?: any,
product_type?: any,
redirect_port?: any,
sans?: any,
serial_number?: any,
signature_hash?: any
}
getCertificateCountsBySourceTypes
trustLifecycleApi.getCertificateCountsBySourceTypes
Get certificate counts for deletion preview
Risk: read
await corsair.digicert.api.trustLifecycleApi.getCertificateCountsBySourceTypes({
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
connector_filter?: {
cn_san_filter?: {
common_names?: any,
sans?: any
}
}& {
connector_ids?: any
},
network_scan_filter?: {
cn_san_filter?: {
common_names?: any,
sans?: any
}
}& {
network_scan_ids?: any
},
system_scan_filter?: {
cn_san_filter?: {
common_names?: any,
sans?: any
}
}& any,
ct_log_scan_filter?: {
cn_san_filter?: {
common_names?: any,
sans?: any
}
}& any
}
any
getConnectorMetadataUsingGet
trustLifecycleApi.getConnectorMetadataUsingGet
Get connector metadata
Risk: read
await corsair.digicert.api.trustLifecycleApi.getConnectorMetadataUsingGet({
path: {
connector_id: {},
},
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
connector_id: any
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
getDetailsByIdUsingGet
trustLifecycleApi.getDetailsByIdUsingGet
Get connector details
Risk: read
await corsair.digicert.api.trustLifecycleApi.getDetailsByIdUsingGet({
path: {
connector_id: {},
},
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
connector_id: any
}
query full type
query full type
{
account_id: any,
template_id?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
getDetailsUsingGet1
trustLifecycleApi.getDetailsUsingGet1
Get scan details
Risk: read
await corsair.digicert.api.trustLifecycleApi.getDetailsUsingGet1({
path: {
scan_id: {},
},
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
scan_id: any
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
getDiscoveredEndpoints
trustLifecycleApi.getDiscoveredEndpoints
Get discovered endpoints
Risk: read
await corsair.digicert.api.trustLifecycleApi.getDiscoveredEndpoints({
query: {
account: {
id: {},
name: {},
},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
offset?: any,
limit?: any,
sort?: any,
account: {
id: any,
name: any
},
businessUnitName?: any,
ip?: any,
port?: any,
connector?: any,
source?: any,
tags?: any,
scanName?: any,
commonName?: any,
certificateThumbprint?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
getDiscoveredEndpointsCount
trustLifecycleApi.getDiscoveredEndpointsCount
Get discovered endpoints count
Risk: read
await corsair.digicert.api.trustLifecycleApi.getDiscoveredEndpointsCount({
query: {
account: {
id: {},
name: {},
},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
account: {
id: any,
name: any
},
businessUnitName?: any,
ip?: any,
port?: any,
connector?: any,
source?: any,
tags?: any,
scanName?: any,
commonName?: any,
certificateThumbprint?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
getExportDevicesToCsv
trustLifecycleApi.getExportDevicesToCsv
Export devices to CSV
Risk: read
await corsair.digicert.api.trustLifecycleApi.getExportDevicesToCsv({
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
account_id: any,
search?: any,
profile_id?: any,
unassigned?: any,
status?: ACTIVE | INACTIVE
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
string
getGetAgentById
trustLifecycleApi.getGetAgentById
Get agent by ID
Risk: read
await corsair.digicert.api.trustLifecycleApi.getGetAgentById({
path: {
id: {},
},
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: any
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | any | No | — |
name | any | No | — |
status | any | No | — |
status_details | any | No | — |
version | any | No | — |
account_id | any | No | — |
business_unit | object | No | — |
app_info | object | No | — |
management_key | any | No | — |
created_at | any | No | — |
updated_at | any | No | — |
inventories | any | No | — |
os_name | any | No | — |
os_version | any | No | — |
agent_group | any | No | — |
host_name | any | No | — |
sni | object | No | — |
error_message | any | No | — |
auto_update_enabled | any | No | — |
deployed_at | any | No | — |
os_info | any | No | — |
hb_interval | any | No | — |
recipients | any | No | — |
upgradable | any | No | — |
post_install_service_restart | any | No | — |
proxy_host | any | No | — |
license_key | any | No | — |
business_unit full type
business_unit full type
{
id: any,
name?: any
}
app_info full type
app_info full type
{
name?: any,
version?: any,
arch?: any,
flavor?: any,
automation_order?: any
}
sni full type
sni full type
{
is_enabled?: any,
items?: any
}
getGetAgentScriptById
trustLifecycleApi.getGetAgentScriptById
Get agent script by ID
Risk: read
await corsair.digicert.api.trustLifecycleApi.getGetAgentScriptById({
path: {
id: {},
},
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: any
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
getGetAuditLogCount
trustLifecycleApi.getGetAuditLogCount
Get audit log count
Risk: read
await corsair.digicert.api.trustLifecycleApi.getGetAuditLogCount({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
exclude_context_data?: any,
account_id?: any,
business_unit_id?: any,
resource_id?: any,
admin_id?: any,
admin_name?: any,
resource_name?: any,
seat_identifier?: any,
seat_id?: any,
resource_type?: enrollment | end_entity_certificate | ca_certificate | account | business_unit | seat | user | profile | sensor | agent | cc_api_token | integration | automation | acme_credentials | acme_order | report | email | connector | truststore | notification | self_service_portal,
action?: create | get | update | delete | reject | approve | login | logout | expire | suspend | ssp_suspend | resume | ssp_resume | import | recover | ssp_recover | revoke | ssp_revoke | revoke_failed | revoke_initiated | refresh_config | create_acme_account | create_acme_order | place_order | acme_challenge | acme_authz | finalize_acme_order | get_acme_order_details | revoke_cert | parse_acme_order | place_duplicate_cert_order | update_account_details | validate_license_seat | validate_hmac | run | download | stop | not_after_validity,
status?: success | warning | failure,
from?: any,
to?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
object
Output full type
Output full type
{
total: any
}& {
total?: any
}
getGetAuditLogEventById
trustLifecycleApi.getGetAuditLogEventById
Get audit log event by ID
Risk: read
await corsair.digicert.api.trustLifecycleApi.getGetAuditLogEventById({
path: {
event_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
event_id: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | any | No | — |
account | object | No | — |
business_unit | object | No | — |
resource_type | enrollment | end_entity_certificate | ca_certificate | account | business_unit | seat | user | profile | sensor | agent | cc_api_token | integration | automation | acme_credentials | acme_order | report | email | connector | truststore | notification | self_service_portal | No | — |
resource_id | any | No | — |
action | create | get | update | delete | reject | approve | login | logout | expire | suspend | ssp_suspend | resume | ssp_resume | import | recover | ssp_recover | revoke | ssp_revoke | revoke_failed | revoke_initiated | refresh_config | create_acme_account | create_acme_order | place_order | acme_challenge | acme_authz | finalize_acme_order | get_acme_order_details | revoke_cert | parse_acme_order | place_duplicate_cert_order | update_account_details | validate_license_seat | validate_hmac | run | download | stop | not_after_validity | No | — |
user | object | No | — |
timestamp | any | No | — |
description | any | No | — |
status | success | warning | failure | string | No | — |
error_message | any | No | — |
detailed_error_message | any | No | — |
data | any | No | — |
new_data | any | No | — |
account full type
account full type
{
id?: any
}
business_unit full type
business_unit full type
{
id?: any
}
user full type
user full type
{
id?: any,
name?: any
}
getGetAvailableSeatTypes
trustLifecycleApi.getGetAvailableSeatTypes
Get available seat types
Risk: read
await corsair.digicert.api.trustLifecycleApi.getGetAvailableSeatTypes({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
account_id?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
any
getGetBusinessUnitById
trustLifecycleApi.getGetBusinessUnitById
Get Business unit by ID
Risk: read
await corsair.digicert.api.trustLifecycleApi.getGetBusinessUnitById({
path: {
bu_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
bu_id: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | any | No | — |
name | any | No | — |
active | any | No | — |
created_at | any | No | — |
account | object | No | — |
admins | any | No | — |
available_seats_stats | any | No | — |
account full type
account full type
{
id?: any,
name?: any
}
getGetCertificateBySerialNumber
trustLifecycleApi.getGetCertificateBySerialNumber
Get certificate by serial number
Risk: read
await corsair.digicert.api.trustLifecycleApi.getGetCertificateBySerialNumber({
path: {
serial_number: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
serial_number: any
}
query full type
query full type
{
thumbprint_sha256?: any,
account_id?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
profile | object | No | — |
seat | object | No | — |
seat_type | object | No | — |
business_unit | object | No | — |
account | object | No | — |
certificate | any | No | — |
ica | object | No | — |
common_name | any | No | — |
status | issued | revoked | expired | suspended | string | No | — |
serial_number | any | No | — |
thumbprint | any | No | — |
valid_from | any | No | — |
valid_to | any | No | — |
notes | any | No | — |
revocation | object | No | — |
ca_response_attributes | object | No | — |
template_name | any | No | — |
issuing_ca_name | any | No | — |
key_size | any | No | — |
signature_algorithm | any | No | — |
subject | object | No | — |
cert_security_rating | any | No | — |
security_rating_info | object | No | — |
file_path | any | No | — |
file_name | any | No | — |
file_type | any | No | — |
ip | any | No | — |
port | any | No | — |
net_scan_domain_name | any | No | — |
application | any | No | — |
automation_status | any | No | — |
ca_vendor | any | No | — |
connector | any | No | — |
dcone_user_id | any | No | — |
enrollment_method | any | No | — |
system_name | any | No | — |
source | any | No | — |
scan_name | any | No | — |
expires_in_days | any | No | — |
instance_count | any | No | — |
extended_key_usage | any | No | — |
msca_template_name | any | No | — |
escrow | any | No | — |
attributes | any | No | — |
profile full type
profile full type
{
id: any,
name?: any
}
seat full type
seat full type
{
seat_id?: any
}
seat_type full type
seat_type full type
{
id: any,
name?: any
}
business_unit full type
business_unit full type
{
id: any,
name?: any
}
account full type
account full type
{
id: any
}
ica full type
ica full type
{
id: any
}
revocation full type
revocation full type
{
reason?: aa_compromise | affiliation_changed | ca_compromise | certificate_hold | cessation_of_operation | key_compromise | privilege_withdrawn | remove_from_crl | superseded | unspecified,
revocation_date?: any,
comments?: any
}
ca_response_attributes full type
ca_response_attributes full type
{
schema?: {
order_id?: any
}
}
subject full type
subject full type
{
common_name?: any,
organization_name?: any,
organization_units?: any,
description?: any,
serial_number?: any,
pseudonym?: any,
unique_identifier?: any,
user_identifier?: any,
domain_component?: any,
dn_qualifier?: any,
unstructured_name?: any,
unstructured_address?: any,
street_address?: any,
locality?: any,
state?: any,
postal_code?: any,
country?: any,
email?: any,
title?: any,
given_name?: any,
surname?: any,
organization_identifier?: any
}
security_rating_info full type
security_rating_info full type
{
security_rating?: any,
handshake_protocols?: {
cipher_algorithm?: any,
key_size?: any,
protocol?: any
},
security_headers?: any,
http_response_headers?: any,
certificate_chain?: {
cert_chain_details?: any,
no_of_cert_chain_found?: any
},
security_rating_score?: any,
certificate_chain_score?: any,
handshake_protocols_score?: any,
security_headers_score?: any,
http_response_headers_score?: any,
protocol_ciphers?: any,
protocol_ciphers_score?: {
protocols?: any,
score?: any
}
}
getGetCertificateOwnerById
trustLifecycleApi.getGetCertificateOwnerById
Get certificate owner by ID
Risk: read
await corsair.digicert.api.trustLifecycleApi.getGetCertificateOwnerById({
path: {
id: {},
},
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: any
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | any | No | — |
first_name | any | No | — |
last_name | any | No | — |
email | any | No | — |
account_id | any | No | — |
custom_identifier | any | No | — |
getGetCustomAttributeById
trustLifecycleApi.getGetCustomAttributeById
Get custom attribute by ID
Risk: read
await corsair.digicert.api.trustLifecycleApi.getGetCustomAttributeById({
path: {
id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | any | No | — |
name | any | No | — |
type | any | No | — |
items | any | No | — |
required | any | No | — |
default_value | any | No | — |
multi_select | any | No | — |
grouped_items | any | No | — |
getGetDevice
trustLifecycleApi.getGetDevice
Get device
Risk: read
await corsair.digicert.api.trustLifecycleApi.getGetDevice({
path: {
id: {},
},
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: any
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | any | No | — |
accountId | any | No | — |
deviceName | any | No | — |
serialNumber | any | No | — |
udid | any | No | — |
status | ACTIVE | INACTIVE | string | No | — |
profileIds | any | No | — |
profiles | any | No | — |
createdAt | any | No | — |
updatedAt | any | No | — |
createdBy | any | No | — |
updatedBy | any | No | — |
rejectedProfiles | any | No | — |
message | any | No | — |
getGetEnrollmentCodeReport
trustLifecycleApi.getGetEnrollmentCodeReport
Get enrollment code report
Risk: read
await corsair.digicert.api.trustLifecycleApi.getGetEnrollmentCodeReport({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
offset?: any,
limit?: any,
sort?: any,
account_id?: any,
admin_id?: any,
business_unit_id?: any,
profile_id?: any,
seat_id?: any,
create_date?: any,
expiry_date?: any,
redeem_date?: any,
reject_date?: any,
reset_date?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
object
Output full type
Output full type
{
total: any,
offset: any,
limit: any
}& {
items?: any
}
getGetEnrollmentDetailsByEnrollmentCode
trustLifecycleApi.getGetEnrollmentDetailsByEnrollmentCode
Get enrollment details by enrollment code
Risk: read
await corsair.digicert.api.trustLifecycleApi.getGetEnrollmentDetailsByEnrollmentCode({
path: {
enrollment_code: {},
},
query: {
seat_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
enrollment_code: any
}
query full type
query full type
{
seat_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | any | No | — |
seat_id | any | No | — |
profile_id | any | No | — |
profile_name | any | No | — |
enrollment_code | any | No | — |
creation_date_time | any | No | — |
expiry_date_time | any | No | — |
status | any | No | — |
number_of_bad_attempts | any | No | — |
getGetEnrollmentDetailsById
trustLifecycleApi.getGetEnrollmentDetailsById
Get enrollment details by ID
Risk: read
await corsair.digicert.api.trustLifecycleApi.getGetEnrollmentDetailsById({
path: {
enrollment_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
enrollment_id: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | any | No | — |
status | created | pending | pending_second_approval | in_progress | expired | approved | rejected | locked | redeemed | No | — |
email | any | No | — |
created_at | any | No | — |
expires_at | any | No | — |
profile | object | No | — |
seat | object | No | — |
business_unit | object | No | — |
message_to_user | any | No | — |
seat_id_mapping_value | any | No | — |
approved_by_current_user | any | No | — |
comments | any | No | — |
profile full type
profile full type
{
id: any,
name?: any
}
seat full type
seat full type
{
id?: any,
name?: any,
seat_type?: USER_SEAT | DISCOVERY_SEAT | SERVER_SEAT | DEVICE_SEAT | IMPORTED_SEAT | ORGANIZATION_SEAT | CERTIFICATE_MANAGEMENT_SEAT
}
business_unit full type
business_unit full type
{
id: any,
name?: any
}
getGetGlobalAgentSettings
trustLifecycleApi.getGetGlobalAgentSettings
Get global agent settings
Risk: read
await corsair.digicert.api.trustLifecycleApi.getGetGlobalAgentSettings({
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
account_id: any,
default?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
getGetListOfDnsIntegrations
trustLifecycleApi.getGetListOfDnsIntegrations
Get list of DNS integrations
Risk: read
await corsair.digicert.api.trustLifecycleApi.getGetListOfDnsIntegrations({
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
account_id: any,
offset?: any,
limit?: any,
sort?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
getGetListOfSeats
trustLifecycleApi.getGetListOfSeats
Get list of seats
Risk: read
await corsair.digicert.api.trustLifecycleApi.getGetListOfSeats({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
offset?: any,
limit?: any,
account_id?: any,
business_unit_id?: any,
seat_type?: USER_SEAT | DEVICE_SEAT | SERVER_SEAT | CERTIFICATE_MANAGEMENT_SEAT | IMPORTED_SEAT | DISCOVERY_SEAT | ORGANIZATION_SEAT,
active?: false | true | all
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
object
Output full type
Output full type
{
total: any,
offset: any,
limit: any
}& {
items?: any
}
getGetProfileById
trustLifecycleApi.getGetProfileById
Get profile by ID
Risk: read
await corsair.digicert.api.trustLifecycleApi.getGetProfileById({
path: {
profile_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
profile_id: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | any | No | — |
name | any | No | — |
description | any | No | — |
status | Active | Deleted | Suspended | Action needed | No | — |
signature_algorithm | SHA1_WITH_RSA | SHA256_WITH_RSA | SHA384_WITH_RSA | SHA512_WITH_RSA | sha256WithRSAPSS | sha384WithRSAPSS | sha512WithRSAPSS | sha3_256WithRSA | sha3_384WithRSA | sha3_512WithRSA | SHA256_WITH_ECDSA | SHA384_WITH_ECDSA | SHA512_WITH_ECDSA | MATCH_ISSUER | No | — |
publish_to_public_directory | any | No | — |
renewal_period_days | any | No | — |
duplicate_cert_policy | any | No | — |
override_cert_validity_via_api | any | No | — |
certificate_delivery_format | x509 | pkcs7 | pkcs12 | string | No | — |
account_id | any | No | — |
business_unit_id | any | No | — |
business_unit_name | any | No | — |
enrollment_method | digicert_desktop_client | android | browser_pkcs12 | csr | est | ios | os_browser | pki_client | rest_api | scep | acme | acme_device_attestation | No | — |
authentication_method | third_party_app | active_directory | certificate_authentication | enrollment_code | global_passphrase | manual_approval | saml_idp | no_auth | No | — |
days_till_enrollment_expires | any | No | — |
automated_renewal | any | No | — |
global_enrollment_code_enabled | any | No | — |
renewal_window_days | any | No | — |
connector_id | any | No | — |
ica | object | No | — |
key_escrow_policy | object | No | — |
private_key_attributes | object | No | — |
api_token_binding_enabled | any | No | — |
api_token_ids | any | No | — |
enable_dual_admin_approval | any | No | — |
enable_ldap_search | any | No | — |
acme_credentials | object | No | — |
tags | any | No | — |
useCustomContact | any | No | — |
duplicate_certificate_allowed | any | No | — |
cert_delivery_format | x509 | pkcs7 | pkcs12 | string | No | — |
notifyRequestor | any | No | — |
custom_extended_key_usages | any | No | — |
certificate | object | No | — |
template | object | No | — |
allowed_list | any | No | — |
allowed_key_sizes | any | No | — |
fields | object | No | — |
custom_attributes_fields | any | No | — |
certificate_owners | any | No | — |
additional_recipients | any | No | — |
self_service_portal_active | any | No | — |
ssp_auth_operations | any | No | — |
ssp_open_operations | any | No | — |
allowed_user_group | any | No | — |
ica full type
ica full type
{
id: any,
name?: any
}
key_escrow_policy full type
key_escrow_policy full type
{
key_escrow_enabled: any,
key_escrow_deployment_mode?: CLOUD | LOCAL | string,
dual_admin_recovery: any
}
private_key_attributes full type
private_key_attributes full type
{
key_size?: any
}
acme_credentials full type
acme_credentials full type
{
eab_kid?: any,
eab_hmac?: any,
directory_url?: any
}
certificate full type
certificate full type
{
subject?: {
attributes?: any
},
validity?: {
unit?: years | months | days | hours | minutes,
duration?: any
},
extensions?: {
san?: {
critical?: any,
attributes?: any
},
issuer_alt_name?: {
critical?: any,
attributes?: any
}
},
issuer?: {
serial_number?: any,
subject_dn?: any,
certificate?: any,
root?: any,
chain?: any
}& {
chain?: any
}
}
template full type
template full type
{
id?: any,
name?: any,
trust_type?: private | public | string
}
fields full type
fields full type
{
optional?: any,
multiple?: any,
key?: any,
type?: any,
input?: any,
oid?: any,
dataType?: any,
allowed_groups?: any,
sources?: any,
labels?: any
}
getGetProfileById_2316fef
trustLifecycleApi.getGetProfileById_2316fef
Get profile by ID
Risk: read
await corsair.digicert.api.trustLifecycleApi.getGetProfileById_2316fef({
path: {
profile_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
profile_id: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
object
Output full type
Output full type
{
id?: any,
name?: any,
description?: any,
status?: Active | Deleted | Suspended | Action needed,
signature_algorithm?: SHA1_WITH_RSA | SHA256_WITH_RSA | SHA384_WITH_RSA | SHA512_WITH_RSA | sha256WithRSAPSS | sha384WithRSAPSS | sha512WithRSAPSS | sha3_256WithRSA | sha3_384WithRSA | sha3_512WithRSA | SHA256_WITH_ECDSA | SHA384_WITH_ECDSA | SHA512_WITH_ECDSA | MATCH_ISSUER,
publish_to_public_directory?: any,
renewal_period_days?: any,
duplicate_cert_policy?: any,
override_cert_validity_via_api?: any,
certificate_delivery_format?: x509 | pkcs7 | pkcs12,
account_id?: any,
business_unit_id?: any,
enrollment_method?: digicert_desktop_client | android | browser_pkcs12 | csr | est | ios | os_browser | pki_client | rest_api | scep | acme | acme_device_attestation,
authentication_method?: third_party_app | active_directory | certificate_authentication | enrollment_code | global_passphrase | manual_approval | saml_idp | no_auth,
days_till_enrollment_expires?: any,
automated_renewal?: any,
renewal_window_days?: any,
connector_id?: any,
ica?: {
id: any,
name?: any
},
key_escrow_policy?: {
key_escrow_enabled: any,
key_escrow_deployment_mode?: CLOUD | LOCAL | string,
dual_admin_recovery: any
},
private_key_attributes?: {
key_size?: any
},
api_token_binding_enabled?: any,
api_token_ids?: any,
enable_dual_admin_approval?: any,
enable_ldap_search?: any,
tags?: any,
useCustomContact?: any,
duplicate_certificate_allowed?: any,
cert_delivery_format?: x509 | pkcs7 | pkcs12 | string,
notifyRequestor?: any,
custom_extended_key_usages?: any,
certificate?: {
subject?: {
attributes?: any
},
validity?: {
unit?: years | months | days | hours | minutes,
duration?: any
},
extensions?: {
san?: {
critical?: any,
attributes?: any
},
issuer_alt_name?: {
critical?: any,
attributes?: any
}
},
issuer?: {
serial_number?: any,
subject_dn?: any,
certificate?: any,
root?: any,
chain?: any
}& {
chain?: any
}
},
template?: {
id?: any,
name?: any,
trust_type?: private | public | string
},
allowed_key_sizes?: any,
fields?: {
optional?: any,
multiple?: any,
key?: any,
type?: any,
input?: any,
oid?: any,
dataType?: any,
allowed_groups?: any,
sources?: any,
labels?: any
},
custom_attributes_fields?: any,
certificate_owners?: any
} | {
id?: any,
name?: any,
description?: any,
status?: Active | Deleted | Suspended | Action needed,
signature_algorithm?: SHA1_WITH_RSA | SHA256_WITH_RSA | SHA384_WITH_RSA | SHA512_WITH_RSA | sha256WithRSAPSS | sha384WithRSAPSS | sha512WithRSAPSS | sha3_256WithRSA | sha3_384WithRSA | sha3_512WithRSA | SHA256_WITH_ECDSA | SHA384_WITH_ECDSA | SHA512_WITH_ECDSA | MATCH_ISSUER,
publish_to_public_directory?: any,
renewal_period_days?: any,
duplicate_cert_policy?: any,
override_cert_validity_via_api?: any,
certificate_delivery_format?: x509 | pkcs7 | pkcs12,
account_id?: any,
business_unit_id?: any,
business_unit_name?: any,
enrollment_method?: digicert_desktop_client | android | browser_pkcs12 | csr | est | ios | os_browser | pki_client | rest_api | scep | acme | acme_device_attestation,
authentication_method?: third_party_app | active_directory | certificate_authentication | enrollment_code | global_passphrase | manual_approval | saml_idp | no_auth,
days_till_enrollment_expires?: any,
automated_renewal?: any,
global_enrollment_code_enabled?: any,
renewal_window_days?: any,
connector_id?: any,
ica?: {
id: any,
name?: any
},
key_escrow_policy?: {
key_escrow_enabled: any,
key_escrow_deployment_mode?: CLOUD | LOCAL | string,
dual_admin_recovery: any
},
private_key_attributes?: {
key_size?: any
},
api_token_binding_enabled?: any,
api_token_ids?: any,
enable_dual_admin_approval?: any,
enable_ldap_search?: any,
acme_credentials?: {
eab_kid?: any,
eab_hmac?: any,
directory_url?: any
},
tags?: any,
useCustomContact?: any,
duplicate_certificate_allowed?: any,
cert_delivery_format?: x509 | pkcs7 | pkcs12 | string,
notifyRequestor?: any,
custom_extended_key_usages?: any,
certificate?: {
subject?: {
attributes?: any
},
validity?: {
unit?: years | months | days | hours | minutes,
duration?: any
},
extensions?: {
san?: {
critical?: any,
attributes?: any
},
issuer_alt_name?: {
critical?: any,
attributes?: any
}
},
issuer?: {
serial_number?: any,
subject_dn?: any,
certificate?: any,
root?: any,
chain?: any
}& {
chain?: any
}
},
template?: {
id?: any,
name?: any,
trust_type?: private | public | string
},
allowed_list?: any,
allowed_key_sizes?: any,
fields?: {
optional?: any,
multiple?: any,
key?: any,
type?: any,
input?: any,
oid?: any,
dataType?: any,
allowed_groups?: any,
sources?: any,
labels?: any
},
custom_attributes_fields?: any,
certificate_owners?: any,
additional_recipients?: any,
self_service_portal_active?: any,
ssp_auth_operations?: any,
ssp_open_operations?: any,
allowed_user_group?: any
}
getGetRuleById
trustLifecycleApi.getGetRuleById
Get rule by ID
Risk: read
await corsair.digicert.api.trustLifecycleApi.getGetRuleById({
path: {
id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
name | any | Yes | — |
account_id | any | Yes | — |
rule_id | any | No | — |
type | certificate | asset | string | No | — |
description | any | No | — |
status | any | No | — |
created_at | any | No | — |
updated_at | any | No | — |
conditions | any | No | — |
assignments | any | No | — |
targets | any | No | — |
getGetSeatByIdentifier
trustLifecycleApi.getGetSeatByIdentifier
Get seat by identifier
Risk: read
await corsair.digicert.api.trustLifecycleApi.getGetSeatByIdentifier({
path: {
seat_id: {},
},
query: { seat_type_id: 'USER_SEAT' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
seat_id: any
}
query full type
query full type
{
seat_type_id: USER_SEAT | DEVICE_SEAT | SERVER_SEAT | CERTIFICATE_MANAGEMENT_SEAT | IMPORTED_SEAT | DISCOVERY_SEAT | ORGANIZATION_SEAT,
business_unit_id?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
seat_id | any | No | — |
seat_name | any | No | — |
email | any | No | — |
phone | any | No | — |
seat_creation_date | any | No | — |
getGetSensorById
trustLifecycleApi.getGetSensorById
Get sensor by ID
Risk: read
await corsair.digicert.api.trustLifecycleApi.getGetSensorById({
path: {
sensor_id: {},
},
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
sensor_id: any
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
getInstancesList
trustLifecycleApi.getInstancesList
Get combined inventory instances
Risk: read
await corsair.digicert.api.trustLifecycleApi.getInstancesList({
query: {
account: {
id: {},
name: {},
},
certificateThumbprint: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
offset?: any,
limit?: any,
sort?: any,
account: {
id: any,
name: any
},
certificateThumbprint: any,
businessUnit?: {
id?: any,
name?: any
},
ip?: any,
port?: any,
application?: any,
automationStatus?: ACME_ACCOUNT_CREATED | ACME_CLIENT_APP_UPGRADE_IN_PROGRESS | ACTION_REQUIRED | AGENT_ERROR | AUTOMATED_BY_AGENT | AUTOMATED_BY_AGENTLESS | AUTOMATION_AT_RISK | AUTOMATION_FAILED | AUTOMATION_PROFILE_BLOCKED | AUTOMATION_REQUESTED | AUTOMATION_SCHEDULED | AUTOMATION_SUCCESSFUL | AUTO_RENEW_SCHEDULED | CERT_PENDING_APPROVAL | CERT_READY_TO_INSTALL | CERT_REQ_DENIED_BY_CIS | CONFIGURATION_ERROR | CONFIGURATION_IN_PROGRESS | CONFIGURED | CONFLICTED | CSR_GENERATION_FAILED | CSR_GENERATION_IN_PROGRESS | CSR_GENERATION_SUCCEEDED | DELETED | DISABLED_FOR_AUTOMATION | DNS_INTEGRATION_FAILED | IGNORED | INSTALL_FAILED | INSTALL_IN_PROGRESS | INSTALL_SUCCEEDED | INSTALL_VALIDATED | INSTALL_VALIDATION_FAILED | INSTALL_VALIDATION_IN_PROGRESS | IS_UPGRADE | NOT_CONFIGURED | NOT_SCANNED | POST_CSR_FAILED | REMOVED | SCAN_IN_PROGRESS
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
getInventoryDetails
trustLifecycleApi.getInventoryDetails
Get inventory endpoint details
Risk: read
await corsair.digicert.api.trustLifecycleApi.getInventoryDetails({
path: {
id: {},
},
query: {
instance_type: {},
account_id: {},
inventory_type: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: any
}
query full type
query full type
{
instance_type: any,
account_id: any,
inventory_type: any,
certificate_id?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
getInventoryDetailsUsingGet
trustLifecycleApi.getInventoryDetailsUsingGet
Get certificate automation inventory details by ID
Risk: read
await corsair.digicert.api.trustLifecycleApi.getInventoryDetailsUsingGet({
path: {
automation_id: {},
},
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
automation_id: any
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | any | No | — |
automation | object | No | — |
certificate | object | No | — |
automation full type
automation full type
(any & {
id?: any,
ip?: any,
port?: any,
system_name?: any,
application?: any,
device?: any,
profile?: {
id?: any,
name?: any
},
is_auto_renew?: any,
automation_status?: ACME_ACCOUNT_CREATED | ACME_CLIENT_APP_UPGRADE_IN_PROGRESS | ACTION_REQUIRED | AGENT_ERROR | AUTOMATED_BY_AGENT | AUTOMATED_BY_AGENTLESS | AUTOMATION_AT_RISK | AUTOMATION_FAILED | AUTOMATION_PROFILE_BLOCKED | AUTOMATION_REQUESTED | AUTOMATION_SCHEDULED | AUTOMATION_SUCCESSFUL | AUTO_RENEW_SCHEDULED | CERT_PENDING_APPROVAL | CERT_READY_TO_INSTALL | CERT_REQ_DENIED_BY_CIS | CONFIGURATION_ERROR | CONFIGURATION_IN_PROGRESS | CONFIGURED | CONFLICTED | CSR_GENERATION_FAILED | CSR_GENERATION_IN_PROGRESS | CSR_GENERATION_SUCCEEDED | DELETED | DISABLED_FOR_AUTOMATION | DNS_INTEGRATION_FAILED | IGNORED | INSTALL_FAILED | INSTALL_IN_PROGRESS | INSTALL_SUCCEEDED | INSTALL_VALIDATED | INSTALL_VALIDATION_FAILED | INSTALL_VALIDATION_IN_PROGRESS | IS_UPGRADE | NOT_CONFIGURED | NOT_SCANNED | POST_CSR_FAILED | REMOVED | SCAN_IN_PROGRESS,
automation_action?: {
primaryAction?: ENROLL | GET_NEXT_CERT | REISSUE | RENEW | TRANSFER,
renewalStartDate?: any,
secondaryActions?: any
}
})& {
os_name?: any,
os_version?: any,
app_info?: {
name?: any,
version?: any,
arch?: any,
flavor?: any,
automation_order?: any
},
category?: CLOUD_SERVICE | APPLIANCE | DNS_INTEGRATION,
first_discovered?: any,
last_discovered?: any,
last_initiated_time?: any,
last_run?: any,
next_run?: any,
common_name?: any,
domain_name?: any,
source?: any,
custom_fields?: any,
tags?: any
}
certificate full type
certificate full type
any & {
id?: any,
inventory_id?: any,
ip?: any,
port?: any,
application?: any,
system_name?: any,
attributes?: any,
auto_renew_status?: any,
automation_action?: {
primaryAction?: ENROLL | GET_NEXT_CERT | REISSUE | RENEW | TRANSFER,
renewalStartDate?: any,
secondaryActions?: any
},
automation_status?: (ACME_ACCOUNT_CREATED | ACME_CLIENT_APP_UPGRADE_IN_PROGRESS | ACTION_REQUIRED | AGENT_ERROR | AUTOMATED_BY_AGENT | AUTOMATED_BY_AGENTLESS | AUTOMATION_AT_RISK | AUTOMATION_FAILED | AUTOMATION_PROFILE_BLOCKED | AUTOMATION_REQUESTED | AUTOMATION_SCHEDULED | AUTOMATION_SUCCESSFUL | AUTO_RENEW_SCHEDULED | CERT_PENDING_APPROVAL | CERT_READY_TO_INSTALL | CERT_REQ_DENIED_BY_CIS | CONFIGURATION_ERROR | CONFIGURATION_IN_PROGRESS | CONFIGURED | CONFLICTED | CSR_GENERATION_FAILED | CSR_GENERATION_IN_PROGRESS | CSR_GENERATION_SUCCEEDED | DELETED | DISABLED_FOR_AUTOMATION | DNS_INTEGRATION_FAILED | IGNORED | INSTALL_FAILED | INSTALL_IN_PROGRESS | INSTALL_SUCCEEDED | INSTALL_VALIDATED | INSTALL_VALIDATION_FAILED | INSTALL_VALIDATION_IN_PROGRESS | IS_UPGRADE | NOT_CONFIGURED | NOT_SCANNED | POST_CSR_FAILED | REMOVED | SCAN_IN_PROGRESS | string)& any,
business_unit?: {
id: any,
name?: any
},
ca_cert_id?: any,
cc_settings?: {
auto_renew_settings?: {
auto_renew_certificate_and_order: any,
auto_renew_time?: {
days?: any,
hours?: any,
minutes?: any,
time_format: any,
zone: any
},
before_expiration: any
},
contacts?: any,
http_signed_exchange?: any,
key_sizes?: any,
account_id?: any,
is_custom_validity?: any,
duplicate_minimum_validity_days?: any | null,
key_type?: any,
order_coverage_length?: any,
override_validity?: any,
organization?: {
id?: any,
name?: any,
value?: any
},
organization_contact?: {
id: any,
name: any,
contact_type: organization_contact | technical_contact | verified_contact | string
},
product_type: cloud_dv_geotrust | code_signing | code_signing_ev | private_ssl_flex | private_ssl_multi_domain | private_ssl_plus | private_ssl_wildcard | ssl_basic | ssl_cloud_wildcard | ssl_dv_geotrust | ssl_dv_geotrust_flex | ssl_dv_rapidssl | ssl_dv_thawte | ssl_ev_basic | ssl_ev_geotrust_truebizid | ssl_ev_multi_domain | ssl_ev_plus | ssl_ev_securesite | ssl_ev_securesite_flex | ssl_ev_securesite_multi_domain | ssl_ev_securesite_pro | ssl_ev_thawte_webserver | ssl_geotrust_truebizid | ssl_multi_domain | ssl_plus | ssl_securesite | ssl_securesite_flex | ssl_securesite_multi_domain | ssl_securesite_pro | ssl_securesite_wildcard | ssl_thawte_webserver | ssl_wildcard | wildcard_dv_geotrust | wildcard_dv_rapidssl | string,
signature_algorithm?: {
id?: any,
name?: any
},
container?: {
id?: any,
name?: any,
value?: any
},
region?: any
},
common_name?: any,
dual_approval_status?: {
admins_approved?: any,
dual_approve_enabled?: any
},
enrollment?: any,
escrow?: any,
external_ca_name?: any,
ica?: {
id?: any,
name?: any
},
key_length?: any,
key_type?: any,
managing_integration?: any,
notes?: any,
order_id?: any,
organization_name?: any,
organization_unit?: any,
organization_identifier?: any,
profile?: {
id?: any,
name?: any
},
revocation_reason?: aa_compromise | affiliation_changed | ca_compromise | certificate_hold | cessation_of_operation | key_compromise | privilege_withdrawn | remove_from_crl | superseded | unspecified,
seat?: {
id?: any,
active?: any,
business_unit?: {
id: any,
name?: any
},
created_at?: any,
email?: any,
number_of_pending?: any,
phone?: any,
seat_allowed_for_enrollment?: any,
seat_id?: any,
seat_name?: any,
seat_type?: {
id?: any,
name?: ((USER_SEAT | DISCOVERY_SEAT | SERVER_SEAT | DEVICE_SEAT | IMPORTED_SEAT | ORGANIZATION_SEAT | CERTIFICATE_MANAGEMENT_SEAT | string)& any)& any
}
},
serial_number?: any,
status?: deleted | expired | issued | revoked | suspended,
subject_email?: any,
valid_from?: any,
valid_to?: any
}
getListAgents
trustLifecycleApi.getListAgents
List agents
Risk: read
await corsair.digicert.api.trustLifecycleApi.getListAgents({
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
limit?: any,
offset?: any,
sort?: any,
account_id: any,
search_query?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
getListAgentScripts
trustLifecycleApi.getListAgentScripts
List agent scripts
Risk: read
await corsair.digicert.api.trustLifecycleApi.getListAgentScripts({
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
account_id: any,
operation_system?: any,
type?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
getListAuditLogs
trustLifecycleApi.getListAuditLogs
List audit logs
Risk: read
await corsair.digicert.api.trustLifecycleApi.getListAuditLogs({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
offset?: any,
limit?: any,
sort?: any,
account_id?: any,
business_unit_id?: any,
resource_id?: any,
admin_id?: any,
admin_name?: any,
resource_name?: any,
seat_identifier?: any,
seat_id?: any,
resource_type?: enrollment | end_entity_certificate | ca_certificate | account | business_unit | seat | user | profile | sensor | agent | cc_api_token | integration | automation | acme_credentials | acme_order | report | email | connector | truststore | notification | self_service_portal,
action?: create | get | update | delete | reject | approve | login | logout | expire | suspend | ssp_suspend | resume | ssp_resume | import | recover | ssp_recover | revoke | ssp_revoke | revoke_failed | revoke_initiated | refresh_config | create_acme_account | create_acme_order | place_order | acme_challenge | acme_authz | finalize_acme_order | get_acme_order_details | revoke_cert | parse_acme_order | place_duplicate_cert_order | update_account_details | validate_license_seat | validate_hmac | run | download | stop | not_after_validity,
status?: success | warning | failure,
from?: any,
to?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
object
Output full type
Output full type
{
total: any,
offset: any,
limit: any
}& {
items?: any
}
getListBusinessUnit
trustLifecycleApi.getListBusinessUnit
List business unit
Risk: read
await corsair.digicert.api.trustLifecycleApi.getListBusinessUnit({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
account_id?: any,
name?: any,
created_at_from?: any,
created_at_to?: any,
active?: any,
offset?: any,
limit?: any,
sort?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
object
Output full type
Output full type
{
total: any,
offset: any,
limit: any
}& {
items?: any
}
getListCertificateOwners
trustLifecycleApi.getListCertificateOwners
List certificate owners
Risk: read
await corsair.digicert.api.trustLifecycleApi.getListCertificateOwners({
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
offset?: any,
limit?: any,
sort?: any,
account_id: any,
first_name?: any,
last_name?: any,
email?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
total | any | No | — |
items | any | No | — |
getListCustomAttributes
trustLifecycleApi.getListCustomAttributes
List custom attributes
Risk: read
await corsair.digicert.api.trustLifecycleApi.getListCustomAttributes({
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
account_id: any,
name?: any,
type?: TEXT_FIELD | DROP_DOWN_LIST | GROUPED_DROP_DOWN | FIXED_VALUE
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
total | any | No | — |
items | any | No | — |
getListCustomAttributesForCertificate
trustLifecycleApi.getListCustomAttributesForCertificate
List custom attributes for certificate
Risk: read
await corsair.digicert.api.trustLifecycleApi.getListCustomAttributesForCertificate({
path: {
id: {},
},
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: any
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
any
getListDevices
trustLifecycleApi.getListDevices
List devices
Risk: read
await corsair.digicert.api.trustLifecycleApi.getListDevices({
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
account_id: any,
search?: any,
profile_id?: any,
unassigned?: any,
status?: ACTIVE | INACTIVE,
offset?: any,
limit?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
object
Output full type
Output full type
{
total: any,
offset: any,
limit: any
}& {
items?: any
}
getListEnrollments
trustLifecycleApi.getListEnrollments
List enrollments
Risk: read
await corsair.digicert.api.trustLifecycleApi.getListEnrollments({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
offset?: any,
limit?: any,
sort?: any,
account_id?: any,
business_unit_id?: any,
created_at_from?: any,
created_at_to?: any,
expires_at_from?: any,
expires_at_to?: any,
email?: any,
profile_id?: any,
seat_id?: any,
seat_identifier?: any,
seat_name?: any,
status?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
object
Output full type
Output full type
{
total: any,
offset: any,
limit: any
}& {
items?: any
}
getListProfiles
trustLifecycleApi.getListProfiles
List profiles
Risk: read
await corsair.digicert.api.trustLifecycleApi.getListProfiles({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
offset?: any,
limit?: any,
sort?: any,
api_token_id?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
any
getListProfiles_a46d97c
trustLifecycleApi.getListProfiles_a46d97c
List profiles
Risk: read
await corsair.digicert.api.trustLifecycleApi.getListProfiles_a46d97c({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
offset?: any,
limit?: any,
sort?: any,
api_token_id?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
any
getListRules
trustLifecycleApi.getListRules
List rules
Risk: read
await corsair.digicert.api.trustLifecycleApi.getListRules({
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
account_id: any,
offset?: any,
limit?: any,
sort?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
object
Output full type
Output full type
{
total: any,
offset: any,
limit: any
}& {
items?: any
}
getPortletCount
trustLifecycleApi.getPortletCount
Get portlet count
Risk: read
await corsair.digicert.api.trustLifecycleApi.getPortletCount({
query: {
account_id: {},
portlet_ids: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
account_id: any,
portlet_ids: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
getQueryServiceHealth
trustLifecycleApi.getQueryServiceHealth
Query service health
Risk: read
await corsair.digicert.api.trustLifecycleApi.getQueryServiceHealth({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
status | any | No | — |
details | object | No | — |
scheduled_jobs | object | No | — |
details full type
details full type
{
db_service?: {
status?: UP | DOWN | NOT_AVAILABLE | string,
details?: {
error?: any
}
},
am_service?: {
status?: UP | DOWN | NOT_AVAILABLE | string,
details?: {
error?: any
}
},
ca_service?: {
status?: UP | DOWN | NOT_AVAILABLE | string,
details?: {
error?: any
}
},
smtp_service?: {
status?: UP | DOWN | NOT_AVAILABLE | string,
details?: {
error?: any
}
},
ldap_service?: {
status?: UP | DOWN | NOT_AVAILABLE | string,
details?: {
error?: any
}
},
dta_web_service?: {
status?: UP | DOWN | NOT_AVAILABLE | string,
details?: {
error?: any
}
},
scheduled_jobs?: {
status?: UP | DOWN | NOT_AVAILABLE | string,
details?: {
error?: any
}
},
ticket_service?: {
status?: UP | DOWN | NOT_AVAILABLE | string,
details?: {
error?: any
}
},
ticket_service_heart_beat?: {
status?: UP | DOWN | NOT_AVAILABLE | string,
details?: {
error?: any
}
},
ts_upload_ticket_job?: {
status?: UP | DOWN | NOT_AVAILABLE | string,
details?: {
error?: any
}
},
critical_services_overall_status?: {
status?: UP | DOWN | NOT_AVAILABLE | string,
details?: {
error?: any
}
},
non_critical_service_overall_status?: {
status?: UP | DOWN | NOT_AVAILABLE | string,
details?: {
error?: any
}
}
}
scheduled_jobs full type
scheduled_jobs full type
{
DEFAULT?: any
}
getQueryServiceStatus
trustLifecycleApi.getQueryServiceStatus
Query service status
Risk: read
await corsair.digicert.api.trustLifecycleApi.getQueryServiceStatus({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
string
getSearchCertificates
trustLifecycleApi.getSearchCertificates
Search certificates
Risk: read
await corsair.digicert.api.trustLifecycleApi.getSearchCertificates({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
offset?: any,
limit?: any,
sort?: any,
account_id?: any,
business_unit_id?: any,
business_unit_name?: any,
profile_id?: any,
seat_id?: any,
seat_type_id?: any,
serial_number?: any,
valid_from?: any,
valid_to?: any,
common_name?: any,
aki?: any,
issuing_ca_id?: any,
issuing_ca_name?: any,
issuing_ca_serial_number?: any,
status?: any,
thumbprint?: any,
enrollment_id?: any,
custom_attributes?: any,
cert_owners?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
object
Output full type
Output full type
{
total: any,
offset: any,
limit: any
}& {
has_more?: any,
items?: any
}
getSensorIntegrationAppParameters
trustLifecycleApi.getSensorIntegrationAppParameters
List available configuration parameters for a sensor application
Risk: read
await corsair.digicert.api.trustLifecycleApi.getSensorIntegrationAppParameters({
path: { application_name: 'AWS' },
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
application_name: AWS | AWS-CLOUDFRONT | BIGIP | NETSCALER | A10
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
any
getSensorIntegrationById
trustLifecycleApi.getSensorIntegrationById
Get sensor integration by ID
Risk: read
await corsair.digicert.api.trustLifecycleApi.getSensorIntegrationById({
path: {
integration_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
integration_id: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
id | any | No | — |
name | any | No | — |
status | INITIAL | NOT_CONFIGURED | REFRESHING_CONFIG | CONFIGURED | COMMUNICATION_ERROR | SUSPENDED | VOIDED | NETWORK_ERROR | AUTHENTICATION_ERROR | TESTING_CONNECTION | LICENSE_REQUESTED | UPGRADING | ACTION_NEEDED | No | — |
status_details | any | No | — |
type | AWS | AWS-CLOUDFRONT | BIGIP | NETSCALER | A10 | No | — |
application_name | AWS | AWS-CLOUDFRONT | BIGIP | NETSCALER | No | — |
parameter_id | any | No | — |
account_id | any | No | — |
business_unit_id | any | No | — |
app_info | object | No | — |
management_key | any | No | — |
is_fips_present | any | No | — |
created_at | any | No | — |
updated | any | No | — |
category | CLOUD_SERVICE | APPLIANCE | DNS_INTEGRATION | No | — |
ha_peers | any | No | — |
parameters | any | No | — |
sensor_ids | any | No | — |
app_info full type
app_info full type
{
name?: any,
version?: any,
arch?: any,
flavor?: any,
automation_order?: any
}
getSensorTemplateFileUsingGet
trustLifecycleApi.getSensorTemplateFileUsingGet
Download sensor software environment details
Risk: read
await corsair.digicert.api.trustLifecycleApi.getSensorTemplateFileUsingGet({
path: {
license_key: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
license_key: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
string
getUnsecured
trustLifecycleApi.getUnsecured
Get unsecured endpoints
Risk: read
await corsair.digicert.api.trustLifecycleApi.getUnsecured({
query: {
account: {
id: {},
name: {},
},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
offset?: any,
limit?: any,
sort?: any,
account: {
id: any,
name: any
},
ip?: any,
port?: any,
connector?: any,
application?: any,
tags?: any,
automationStatus?: ACME_ACCOUNT_CREATED | ACME_CLIENT_APP_UPGRADE_IN_PROGRESS | ACTION_REQUIRED | AGENT_ERROR | AUTOMATED_BY_AGENT | AUTOMATED_BY_AGENTLESS | AUTOMATION_AT_RISK | AUTOMATION_FAILED | AUTOMATION_PROFILE_BLOCKED | AUTOMATION_REQUESTED | AUTOMATION_SCHEDULED | AUTOMATION_SUCCESSFUL | AUTO_RENEW_SCHEDULED | CERT_PENDING_APPROVAL | CERT_READY_TO_INSTALL | CERT_REQ_DENIED_BY_CIS | CONFIGURATION_ERROR | CONFIGURATION_IN_PROGRESS | CONFIGURED | CONFLICTED | CSR_GENERATION_FAILED | CSR_GENERATION_IN_PROGRESS | CSR_GENERATION_SUCCEEDED | DELETED | DISABLED_FOR_AUTOMATION | DNS_INTEGRATION_FAILED | IGNORED | INSTALL_FAILED | INSTALL_IN_PROGRESS | INSTALL_SUCCEEDED | INSTALL_VALIDATED | INSTALL_VALIDATION_FAILED | INSTALL_VALIDATION_IN_PROGRESS | IS_UPGRADE | NOT_CONFIGURED | NOT_SCANNED | POST_CSR_FAILED | REMOVED | SCAN_IN_PROGRESS,
virtualServerName?: any,
isAutoRenew?: any,
hasBeenAutomated?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
getUnsecuredCount
trustLifecycleApi.getUnsecuredCount
Get unsecured endpoints count
Risk: read
await corsair.digicert.api.trustLifecycleApi.getUnsecuredCount({
query: {
account: {
id: {},
name: {},
},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
account: {
id: any,
name: any
},
ip?: any,
port?: any,
connector?: any,
application?: any,
tags?: any,
automationStatus?: ACME_ACCOUNT_CREATED | ACME_CLIENT_APP_UPGRADE_IN_PROGRESS | ACTION_REQUIRED | AGENT_ERROR | AUTOMATED_BY_AGENT | AUTOMATED_BY_AGENTLESS | AUTOMATION_AT_RISK | AUTOMATION_FAILED | AUTOMATION_PROFILE_BLOCKED | AUTOMATION_REQUESTED | AUTOMATION_SCHEDULED | AUTOMATION_SUCCESSFUL | AUTO_RENEW_SCHEDULED | CERT_PENDING_APPROVAL | CERT_READY_TO_INSTALL | CERT_REQ_DENIED_BY_CIS | CONFIGURATION_ERROR | CONFIGURATION_IN_PROGRESS | CONFIGURED | CONFLICTED | CSR_GENERATION_FAILED | CSR_GENERATION_IN_PROGRESS | CSR_GENERATION_SUCCEEDED | DELETED | DISABLED_FOR_AUTOMATION | DNS_INTEGRATION_FAILED | IGNORED | INSTALL_FAILED | INSTALL_IN_PROGRESS | INSTALL_SUCCEEDED | INSTALL_VALIDATED | INSTALL_VALIDATION_FAILED | INSTALL_VALIDATION_IN_PROGRESS | IS_UPGRADE | NOT_CONFIGURED | NOT_SCANNED | POST_CSR_FAILED | REMOVED | SCAN_IN_PROGRESS,
virtualServerName?: any,
isAutoRenew?: any,
hasBeenAutomated?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
handleGetCaCertsOperationUsingGet
trustLifecycleApi.handleGetCaCertsOperationUsingGet
handleGetCaCertsOperation
Risk: read
await corsair.digicert.api.trustLifecycleApi.handleGetCaCertsOperationUsingGet({
path: {
profileId: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
profileId: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
number[]
handleSimpleEnrollOperationUsingPost
trustLifecycleApi.handleSimpleEnrollOperationUsingPost
handleSimpleEnrollOperation
Risk: write
await corsair.digicert.api.trustLifecycleApi.handleSimpleEnrollOperationUsingPost({
path: {
profileId: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | any | No | — |
path full type
path full type
{
profileId: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
number[]
handleSimpleReEnrollOperationUsingPost
trustLifecycleApi.handleSimpleReEnrollOperationUsingPost
handleSimpleReEnrollOperation
Risk: write
await corsair.digicert.api.trustLifecycleApi.handleSimpleReEnrollOperationUsingPost({
path: {
profileId: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | any | No | — |
path full type
path full type
{
profileId: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
number[]
listAutomationInventory
trustLifecycleApi.listAutomationInventory
List potential targets for certificate lifecycle automation
Risk: read
await corsair.digicert.api.trustLifecycleApi.listAutomationInventory({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
offset?: any,
limit?: any,
sort?: any,
account_id?: any,
application?: AWS | AWS-CLOUDFRONT | BIGIP | NETSCALER | A10,
automation_status?: ACME_ACCOUNT_CREATED | ACME_CLIENT_APP_UPGRADE_IN_PROGRESS | ACTION_REQUIRED | AGENT_ERROR | AUTOMATED_BY_AGENT | AUTOMATED_BY_AGENTLESS | AUTOMATION_AT_RISK | AUTOMATION_FAILED | AUTOMATION_PROFILE_BLOCKED | AUTOMATION_REQUESTED | AUTOMATION_SCHEDULED | AUTOMATION_SUCCESSFUL | AUTO_RENEW_SCHEDULED | CERT_PENDING_APPROVAL | CERT_READY_TO_INSTALL | CERT_REQ_DENIED_BY_CIS | CONFIGURATION_ERROR | CONFIGURATION_IN_PROGRESS | CONFIGURED | CONFLICTED | CSR_GENERATION_FAILED | CSR_GENERATION_IN_PROGRESS | CSR_GENERATION_SUCCEEDED | DELETED | DISABLED_FOR_AUTOMATION | DNS_INTEGRATION_FAILED | IGNORED | INSTALL_FAILED | INSTALL_IN_PROGRESS | INSTALL_SUCCEEDED | INSTALL_VALIDATED | INSTALL_VALIDATION_FAILED | INSTALL_VALIDATION_IN_PROGRESS | IS_UPGRADE | NOT_CONFIGURED | NOT_SCANNED | POST_CSR_FAILED | REMOVED | SCAN_IN_PROGRESS,
device?: any,
ip?: any,
port?: any,
source?: any,
system_name?: any,
tags?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
object
Output full type
Output full type
{
total: any,
offset: any,
limit: any
}& {
items?: any
}
listByAccountUsingPost
trustLifecycleApi.listByAccountUsingPost
Search connectors
Risk: write
await corsair.digicert.api.trustLifecycleApi.listByAccountUsingPost({
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
account_id: any,
limit?: any,
offset?: any,
sort?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
name?: any,
provider?: CERTCENTRAL | MICROSOFT_CA | QUALYS | AMAZON_CA | DIGICERT_PKI_PLATFORM_8 | TENABLE | AZURE_KEY_VAULT | LETS_ENCRYPT | BIGIP | SNOW | STEP_CA | MICROSOFT_INTUNE | AMAZON_ACM | GOOGLE_CLOUD,
type?: CA | IT_SERVICE_MANAGEMENT | SCAN_SOLUTIONS | APPLIANCE | CLOUD_SERVICE | DNS_INTEGRATION | KEY_VAULT | IT_AUTOMATION | UNIFIED_ENDPOINT_MANAGEMENT,
status?: INITIAL | ACTIVE | RUNNING | REFRESHING_CONFIG | SUSPENDED | ACTION_NEEDED | SUSPENDED_BY_FEATURE_FLAG | DELETED,
last_completed_at?: any,
next_update?: any,
business_unit_name?: any
}
undefined
listOfScansUsingGet
trustLifecycleApi.listOfScansUsingGet
List scans
Risk: read
await corsair.digicert.api.trustLifecycleApi.listOfScansUsingGet({
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
account_id: any,
businessUnit?: any,
businessUnitName?: any,
currentScanStatus?: any,
frequency?: any,
lastScanStatus?: any,
limit?: any,
name?: any,
offset?: any,
scanType?: any,
sort?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
listPastSystemScansUsingGetpublic
trustLifecycleApi.listPastSystemScansUsingGetpublic
List past system scans
Risk: read
await corsair.digicert.api.trustLifecycleApi.listPastSystemScansUsingGetpublic({
path: {
id: {},
},
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: any
}
query full type
query full type
{
category?: CURRENT | PAST,
limit?: any,
offset?: any,
sort?: any,
status?: COMPLETED | DELETED | FAILED | PARTIAL | SKIPPED,
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
listSensorIntegrations
trustLifecycleApi.listSensorIntegrations
List sensor integrations
Risk: read
await corsair.digicert.api.trustLifecycleApi.listSensorIntegrations({
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
account_id: any,
search_query?: any,
offset?: any,
limit?: any,
sort?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
object
Output full type
Output full type
{
total: any,
offset: any,
limit: any
}& {
items?: any
}
listSensors
trustLifecycleApi.listSensors
List sensors
Risk: read
await corsair.digicert.api.trustLifecycleApi.listSensors({
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
account_id: any,
offset?: any,
limit?: any,
sort?: any,
search_query?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
object
Output full type
Output full type
{
total: any,
offset: any,
limit: any
}& {
items?: any
}
listUpcomingSystemScansUsingGetpublic
trustLifecycleApi.listUpcomingSystemScansUsingGetpublic
List upcoming system scans
Risk: read
await corsair.digicert.api.trustLifecycleApi.listUpcomingSystemScansUsingGetpublic({
path: {
id: {},
},
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: any
}
query full type
query full type
{
limit?: any,
offset?: any,
sort?: any,
searchParams?: {
skipped?: any
},
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
postAddAgentScriptsInBulk
trustLifecycleApi.postAddAgentScriptsInBulk
Add agent scripts in bulk
Risk: write
await corsair.digicert.api.trustLifecycleApi.postAddAgentScriptsInBulk({
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | any | No | — |
path full type
path full type
{
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
postAddDevices
trustLifecycleApi.postAddDevices
Add devices
Risk: write
await corsair.digicert.api.trustLifecycleApi.postAddDevices({
query: {
account_id: {},
},
body: {
devices: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
devices: any
}
any
postApproveEscrowedCertificateRecovery
trustLifecycleApi.postApproveEscrowedCertificateRecovery
Approve escrowed certificate recovery
Risk: write
await corsair.digicert.api.trustLifecycleApi.postApproveEscrowedCertificateRecovery({
path: {
serial_number: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
serial_number: any
}
query full type
query full type
{
thumbprint_sha256?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
postBulkReplaceTags
trustLifecycleApi.postBulkReplaceTags
Bulk replace tags
Risk: destructive
await corsair.digicert.api.trustLifecycleApi.postBulkReplaceTags({
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate_ids?: any,
tags?: any
}
undefined
postBulkUpdateTags
trustLifecycleApi.postBulkUpdateTags
Bulk update tags
Risk: write
await corsair.digicert.api.trustLifecycleApi.postBulkUpdateTags({
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
certificate_ids?: any,
tags?: any
}
undefined
postBulkVoid
trustLifecycleApi.postBulkVoid
Bulk void
Risk: write
await corsair.digicert.api.trustLifecycleApi.postBulkVoid({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
integrations?: any
}
undefined
postCreateANewProfile
trustLifecycleApi.postCreateANewProfile
Create a new profile
Risk: write
await corsair.digicert.api.trustLifecycleApi.postCreateANewProfile({
body: {
name: {},
business_unit_id: {},
ica: {
id: {},
},
account_id: {},
template_id: {},
enrollment_method: 'digicert_desktop_client',
authentication_method: 'third_party_app',
seat_id_mapping: 'email',
renewal_window_days: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
name: any,
description?: any,
business_unit_id: any,
ica: {
id: any,
name?: any
},
account_id: any,
template_id: any,
enrollment_method: digicert_desktop_client | android | browser_pkcs12 | csr | est | ios | os_browser | pki_client | rest_api | scep | acme | acme_device_attestation,
authentication_method: third_party_app | active_directory | certificate_authentication | enrollment_code | global_passphrase | manual_approval | saml_idp | no_auth,
seat_id_mapping: email | san_emails | common_name | upn | unique_identifier | serial_number | dns_names | other_name_guid | registered_ids | subject_email | dn_qualifier | pseudonym | seat_identifier,
cert_delivery_format?: x509 | pkcs7 | pkcs12 | pkcs12_pem | pkcs12_der,
custom_extended_key_usages?: any,
renewal_window_days: any,
days_till_enrollment_expires?: any,
duplicate_certificate_allowed?: any,
notify_requestor?: any,
embed_enrollment_code_in_url?: any,
grace_period_enabled?: any,
enable_ldap_search?: any,
self_service_portal_active?: any,
global_enrollment_code?: any,
fields?: any,
connector_id?: any,
use_custom_contact?: any,
ca_settings?: {
contacts?: any,
certificate_fields?: {
validity_period?: any,
renewal_period?: any,
key_type?: any,
key_size?: any,
signature_algorithm?: any,
crypto_providers?: any,
arn?: any
}
},
cc_settings?: {
auto_renew_settings?: {
auto_renew_certificate_and_order: any,
auto_renew_time?: {
days?: any,
hours?: any,
minutes?: any,
time_format: any,
zone: any
},
before_expiration: any
},
contacts?: any,
http_signed_exchange?: any,
key_sizes?: any,
account_id?: any,
is_custom_validity?: any,
duplicate_minimum_validity_days?: any | null,
key_type?: any,
order_coverage_length?: any,
override_validity?: any,
organization?: {
id?: any,
name?: any,
value?: any
},
organization_contact?: {
id: any,
name: any,
contact_type: organization_contact | technical_contact | verified_contact
},
product_type: cloud_dv_geotrust | code_signing | code_signing_ev | private_ssl_flex | private_ssl_multi_domain | private_ssl_plus | private_ssl_wildcard | ssl_basic | ssl_cloud_wildcard | ssl_dv_geotrust | ssl_dv_geotrust_flex | ssl_dv_rapidssl | ssl_dv_thawte | ssl_ev_basic | ssl_ev_geotrust_truebizid | ssl_ev_multi_domain | ssl_ev_plus | ssl_ev_securesite | ssl_ev_securesite_flex | ssl_ev_securesite_multi_domain | ssl_ev_securesite_pro | ssl_ev_thawte_webserver | ssl_geotrust_truebizid | ssl_multi_domain | ssl_plus | ssl_securesite | ssl_securesite_flex | ssl_securesite_multi_domain | ssl_securesite_pro | ssl_securesite_wildcard | ssl_thawte_webserver | ssl_wildcard | wildcard_dv_geotrust | wildcard_dv_rapidssl,
signature_algorithm?: {
id?: any,
name?: any
},
container?: {
id?: any,
name?: any,
value?: any
},
region?: any
},
key_escrow_policy?: {
key_escrow_enabled: any,
key_escrow_deployment_mode?: CLOUD | LOCAL,
dual_admin_recovery: any
},
tags?: any,
api_token_binding_enabled?: any | null,
api_token_ids?: any,
ssp_auth_operations?: any,
ssp_open_operations?: any,
allowed_user_group?: any,
allowed_fqdn_regex?: any,
additional_recipients?: any,
certificate_owner_ids?: any
}
| Name | Type | Required | Description |
|---|---|---|---|
id | any | No | — |
name | any | No | — |
description | any | No | — |
status | Active | Deleted | Suspended | Action needed | No | — |
signature_algorithm | SHA1_WITH_RSA | SHA256_WITH_RSA | SHA384_WITH_RSA | SHA512_WITH_RSA | sha256WithRSAPSS | sha384WithRSAPSS | sha512WithRSAPSS | sha3_256WithRSA | sha3_384WithRSA | sha3_512WithRSA | SHA256_WITH_ECDSA | SHA384_WITH_ECDSA | SHA512_WITH_ECDSA | MATCH_ISSUER | No | — |
publish_to_public_directory | any | No | — |
renewal_period_days | any | No | — |
duplicate_cert_policy | any | No | — |
override_cert_validity_via_api | any | No | — |
certificate_delivery_format | x509 | pkcs7 | pkcs12 | string | No | — |
account_id | any | No | — |
business_unit_id | any | No | — |
business_unit_name | any | No | — |
enrollment_method | digicert_desktop_client | android | browser_pkcs12 | csr | est | ios | os_browser | pki_client | rest_api | scep | acme | acme_device_attestation | No | — |
authentication_method | third_party_app | active_directory | certificate_authentication | enrollment_code | global_passphrase | manual_approval | saml_idp | no_auth | No | — |
days_till_enrollment_expires | any | No | — |
automated_renewal | any | No | — |
global_enrollment_code_enabled | any | No | — |
renewal_window_days | any | No | — |
connector_id | any | No | — |
ica | object | No | — |
key_escrow_policy | object | No | — |
private_key_attributes | object | No | — |
api_token_binding_enabled | any | No | — |
api_token_ids | any | No | — |
enable_dual_admin_approval | any | No | — |
enable_ldap_search | any | No | — |
acme_credentials | object | No | — |
tags | any | No | — |
useCustomContact | any | No | — |
duplicate_certificate_allowed | any | No | — |
cert_delivery_format | x509 | pkcs7 | pkcs12 | string | No | — |
notifyRequestor | any | No | — |
custom_extended_key_usages | any | No | — |
certificate | object | No | — |
template | object | No | — |
allowed_list | any | No | — |
allowed_key_sizes | any | No | — |
fields | object | No | — |
custom_attributes_fields | any | No | — |
certificate_owners | any | No | — |
additional_recipients | any | No | — |
self_service_portal_active | any | No | — |
ssp_auth_operations | any | No | — |
ssp_open_operations | any | No | — |
allowed_user_group | any | No | — |
ica full type
ica full type
{
id: any,
name?: any
}
key_escrow_policy full type
key_escrow_policy full type
{
key_escrow_enabled: any,
key_escrow_deployment_mode?: CLOUD | LOCAL | string,
dual_admin_recovery: any
}
private_key_attributes full type
private_key_attributes full type
{
key_size?: any
}
acme_credentials full type
acme_credentials full type
{
eab_kid?: any,
eab_hmac?: any,
directory_url?: any
}
certificate full type
certificate full type
{
subject?: {
attributes?: any
},
validity?: {
unit?: years | months | days | hours | minutes,
duration?: any
},
extensions?: {
san?: {
critical?: any,
attributes?: any
},
issuer_alt_name?: {
critical?: any,
attributes?: any
}
},
issuer?: {
serial_number?: any,
subject_dn?: any,
certificate?: any,
root?: any,
chain?: any
}& {
chain?: any
}
}
template full type
template full type
{
id?: any,
name?: any,
trust_type?: private | public | string
}
fields full type
fields full type
{
optional?: any,
multiple?: any,
key?: any,
type?: any,
input?: any,
oid?: any,
dataType?: any,
allowed_groups?: any,
sources?: any,
labels?: any
}
postCreateBusinessUnit
trustLifecycleApi.postCreateBusinessUnit
Create business unit
Risk: write
await corsair.digicert.api.trustLifecycleApi.postCreateBusinessUnit({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
name: any,
account: {
id: any
}
}
| Name | Type | Required | Description |
|---|---|---|---|
id | any | No | — |
name | any | No | — |
active | any | No | — |
created_at | any | No | — |
account | object | No | — |
account full type
account full type
{
id: any
}
postCreateCertificateOwners
trustLifecycleApi.postCreateCertificateOwners
Create certificate owners
Risk: write
await corsair.digicert.api.trustLifecycleApi.postCreateCertificateOwners({
body: {
account_id: {},
certificate_owner: {
email: {},
},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account_id: any,
certificate_owner: {
first_name?: any,
last_name?: any,
email: any,
custom_identifier?: any
}
}
| Name | Type | Required | Description |
|---|---|---|---|
id | any | No | — |
first_name | any | No | — |
last_name | any | No | — |
email | any | No | — |
account_id | any | No | — |
custom_identifier | any | No | — |
postCreateCustomAttribute
trustLifecycleApi.postCreateCustomAttribute
Create custom attribute
Risk: write
await corsair.digicert.api.trustLifecycleApi.postCreateCustomAttribute({
body: {
account_id: {},
custom_attribute: {
name: {},
type: 'TEXT_FIELD',
},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account_id: any,
custom_attribute: {
name: any,
type: TEXT_FIELD | DROP_DOWN_LIST | GROUPED_DROP_DOWN | FIXED_VALUE,
items?: any,
required?: any,
default_value?: any,
multi_select?: any,
grouped_items?: any
}
}
| Name | Type | Required | Description |
|---|---|---|---|
id | any | No | — |
name | any | No | — |
type | any | No | — |
items | any | No | — |
required | any | No | — |
default_value | any | No | — |
multi_select | any | No | — |
grouped_items | any | No | — |
postCreateEnrollment
trustLifecycleApi.postCreateEnrollment
Create enrollment
Risk: write
await corsair.digicert.api.trustLifecycleApi.postCreateEnrollment({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
profile: any,
seat: {
seat_id: any,
email: any
},
attributes: {
csr?: any,
subject?: {
common_name?: any,
organization_name?: any,
organization_units?: any,
description?: any,
serial_number?: any,
pseudonym?: any,
unique_identifier?: any,
user_identifier?: any,
domain_component?: any,
dn_qualifier?: any,
unstructured_name?: any,
unstructured_address?: any,
street_address?: any,
locality?: any,
state?: any,
postal_code?: any,
country?: any,
email?: any,
title?: any,
given_name?: any,
surname?: any,
organization_identifier?: any
},
custom_values?: any
},
enrollment_code?: any,
expiry_date?: any
}
| Name | Type | Required | Description |
|---|---|---|---|
id | any | No | — |
seat_id | any | No | — |
profile_id | any | No | — |
profile_name | any | No | — |
enrollment_code | any | No | — |
creation_date_time | any | No | — |
expiry_date_time | any | No | — |
status | any | No | — |
number_of_bad_attempts | any | No | — |
enrollment_url | any | No | — |
postCreateEnrollmentForManualApproval
trustLifecycleApi.postCreateEnrollmentForManualApproval
Create enrollment for manual approval
Risk: write
await corsair.digicert.api.trustLifecycleApi.postCreateEnrollmentForManualApproval({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
profile?: {
id: any
},
email?: any,
csr?: any,
comments?: any,
saml_response_id?: any,
attributes?: {
subject?: {
common_name?: any,
organization_name?: any,
organization_units?: any,
description?: any,
serial_number?: any,
pseudonym?: any,
unique_identifier?: any,
user_identifier?: any,
domain_component?: any,
dn_qualifier?: any,
unstructured_name?: any,
unstructured_address?: any,
street_address?: any,
locality?: any,
state?: any,
postal_code?: any,
country?: any,
email?: any,
title?: any,
given_name?: any,
surname?: any,
organization_identifier?: any
},
custom_values?: any
},
authentication_attributes?: any
}
| Name | Type | Required | Description |
|---|---|---|---|
id | any | Yes | — |
postCreateGlobalAgentSettings
trustLifecycleApi.postCreateGlobalAgentSettings
Create global agent settings
Risk: write
await corsair.digicert.api.trustLifecycleApi.postCreateGlobalAgentSettings({
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
linux_restricted_ports?: any,
manual_approval?: any,
scan_block_list?: any,
windows_restricted_ports?: any
}
undefined
postCreateRule
trustLifecycleApi.postCreateRule
Create rule
Risk: write
await corsair.digicert.api.trustLifecycleApi.postCreateRule({
body: {
account_id: {},
name: {},
type: 'certificate',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account_id: any,
name: any,
description?: any,
type: certificate | asset,
rule_id?: any,
status?: any,
assignments?: any,
conditions?: any,
targets?: any
}
undefined
postCreateSeat
trustLifecycleApi.postCreateSeat
Create seat
Risk: write
await corsair.digicert.api.trustLifecycleApi.postCreateSeat({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
business_unit_id?: any,
seat_type?: {
id?: USER_SEAT | DEVICE_SEAT | CERTIFICATE_MANAGEMENT_SEAT | SERVER_SEAT | ORGANIZATION_SEAT
},
seat_id?: any
}& {
seat_name?: any,
email?: any,
phone?: any
}
undefined
postImportCertificate
trustLifecycleApi.postImportCertificate
Import certificate
Risk: write
await corsair.digicert.api.trustLifecycleApi.postImportCertificate({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | any | No | — |
path full type
path full type
{
}
query full type
query full type
{
trap_seat_duplicate_error?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
any
postImportDevicesFromCsv
trustLifecycleApi.postImportDevicesFromCsv
Import devices from CSV
Risk: write
await corsair.digicert.api.trustLifecycleApi.postImportDevicesFromCsv({
query: {
account_id: {},
},
body: {
file: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
file: any
}
| Name | Type | Required | Description |
|---|---|---|---|
totalRows | any | No | — |
imported | any | No | — |
skipped | any | No | — |
failed | any | No | — |
errors | any | No | — |
postIssueCertificate
trustLifecycleApi.postIssueCertificate
Issue certificate
Risk: write
await corsair.digicert.api.trustLifecycleApi.postIssueCertificate({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
profile?: {
id?: any
},
seat?: {
seat_id?: any,
email?: any
},
csr?: any,
validity?: {
unit?: years | months | days | hours | minutes,
duration?: any
},
delivery_format?: x509 | pkcs7 | pkcs12 | pkcs12_pem,
include_ca_chain?: any,
attributes?: {
subject?: {
common_name?: any,
organization_name?: any,
organization_units?: any,
description?: any,
serial_number?: any,
pseudonym?: any,
unique_identifier?: any,
user_identifier?: any,
domain_component?: any,
dn_qualifier?: any,
unstructured_name?: any,
unstructured_address?: any,
street_address?: any,
locality?: any,
state?: any,
postal_code?: any,
country?: any,
email?: any,
title?: any,
given_name?: any,
surname?: any,
organization_identifier?: any
},
extensions?: {
san?: {
dns_names?: any,
emails?: any,
ip_addresses?: any,
other_names?: {
guid?: any,
raw_other_names?: any
},
registered_ids?: any,
directory_name?: any,
uris?: any,
user_principal_names?: any
},
issuer_alt_name?: {
directory_name?: {
value?: any,
critical?: any
}
},
security_identifier?: {
additional_values?: any
},
lei?: {
value?: any,
critical?: any
},
lei_role?: {
value?: any,
critical?: any
}
},
custom_values?: any,
tnc_accepted?: any
},
tags?: any,
cert_owner_ids?: any,
ca_attributes?: {
schema?: {
ct_log_option?: any,
dcv_method?: dns-cname-token | dns-txt-token | http-token,
renewal_of_order_id?: any,
skip_domain_validation?: any
}
},
custom_attributes?: any
} | {
profile?: {
id?: any
},
seat?: {
seat_id?: any,
email?: any
},
csr?: any,
validity?: {
unit?: years | months | days | hours | minutes,
duration?: any
},
delivery_format?: x509 | pkcs7 | pkcs12 | pkcs12_pem,
include_ca_chain?: any,
attributes?: {
subject?: {
pseudonym?: any,
title?: any,
given_name?: any,
surname?: any,
UserPrincipalName?: any,
email?: any
},
extensions?: {
san?: {
emails?: any
}
},
custom_values?: any
},
tags?: any
}
| Name | Type | Required | Description |
|---|---|---|---|
serial_number | any | No | — |
delivery_format | x509 | pkcs7 | pkcs12 | pkcs12_pem | No | — |
certificate | any | No | — |
pkcs12_password | any | No | — |
request_id | any | No | — |
dv_details | object | No | — |
dv_details full type
dv_details full type
{
schema?: {
dcv_method?: dns-cname-token | dns-txt-token | http-token,
dcv_random_value?: any
}
}
postPickUpCertificate
trustLifecycleApi.postPickUpCertificate
Pick up certificate
Risk: write
await corsair.digicert.api.trustLifecycleApi.postPickUpCertificate({
path: {
request_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
request_id: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
profile?: {
id?: any
}
}
| Name | Type | Required | Description |
|---|---|---|---|
serial_number | any | No | — |
delivery_format | x509 | pkcs7 | pkcs12 | pkcs12_pem | No | — |
certificate | any | No | — |
status | ISSUED | PENDING | REJECTED | string | No | — |
postPostAgentScript
trustLifecycleApi.postPostAgentScript
Post agent script
Risk: write
await corsair.digicert.api.trustLifecycleApi.postPostAgentScript({
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
id?: any,
name?: any,
os?: any,
type?: any,
path?: any,
executionCommand?: any,
description?: any,
automationId?: any
}
undefined
postPostAgentSuggestions
trustLifecycleApi.postPostAgentSuggestions
Post agent suggestions
Risk: write
await corsair.digicert.api.trustLifecycleApi.postPostAgentSuggestions({
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
field?: any,
searchQuery?: any
}
undefined
postRecoverEscrowedCertificateBySerialNumber
trustLifecycleApi.postRecoverEscrowedCertificateBySerialNumber
Recover escrowed certificate by serial number
Risk: write
await corsair.digicert.api.trustLifecycleApi.postRecoverEscrowedCertificateBySerialNumber({
path: {
serial_number: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
serial_number: any
}
query full type
query full type
{
thumbprint_sha256?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
delivery_format | pkcs12 | string | No | — |
certificate | any | No | — |
pkcs12_password | any | No | — |
postRedeemEnrollment
trustLifecycleApi.postRedeemEnrollment
Redeem enrollment
Risk: write
await corsair.digicert.api.trustLifecycleApi.postRedeemEnrollment({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
seat?: {
id: any
},
profile?: {
id: any
},
enrollment_code?: any,
csr?: any,
attributes?: {
subject?: {
common_name?: any,
organization_name?: any,
organization_units?: any,
description?: any,
serial_number?: any,
pseudonym?: any,
unique_identifier?: any,
user_identifier?: any,
domain_component?: any,
dn_qualifier?: any,
unstructured_name?: any,
unstructured_address?: any,
street_address?: any,
locality?: any,
state?: any,
postal_code?: any,
country?: any,
email?: any,
title?: any,
given_name?: any,
surname?: any,
organization_identifier?: any
},
custom_values?: any
},
validity?: {
unit?: years | months | days | hours | minutes,
duration?: any
},
custom_attributes?: any
}
| Name | Type | Required | Description |
|---|---|---|---|
serial_number | any | No | — |
delivery_format | x509 | pkcs7 | pkcs12 | pkcs12_pem | No | — |
certificate | any | No | — |
pkcs12_password | any | No | — |
request_id | any | No | — |
dv_details | object | No | — |
dv_details full type
dv_details full type
{
schema?: {
dcv_method?: dns-cname-token | dns-txt-token | http-token,
dcv_random_value?: any
}
}
postReinstateSensors
trustLifecycleApi.postReinstateSensors
Reinstate sensors
Risk: write
await corsair.digicert.api.trustLifecycleApi.postReinstateSensors({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account_id?: any,
license_keys?: any
}
undefined
postRenewCertificate
trustLifecycleApi.postRenewCertificate
Renew certificate
Risk: destructive
await corsair.digicert.api.trustLifecycleApi.postRenewCertificate({
path: {
serial_number: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
serial_number: any
}
query full type
query full type
{
thumbprint_sha256?: any,
account_id?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
csr?: any,
validity?: {
unit?: years | months | days | hours | minutes,
duration?: any
},
delivery_format?: x509 | pkcs7 | pkcs12 | pkcs12_pem,
include_ca_chain?: any,
renewal_comment?: any
}
| Name | Type | Required | Description |
|---|---|---|---|
agent_id | any | No | — |
application | any | No | — |
attributes | any | No | — |
auth_fields | any | No | — |
auto_renew_status | any | No | — |
automation_action | object | No | — |
automation_status | any | No | — |
business_unit | object | No | — |
ca_cert_id | any | No | — |
cc_settings | object | No | — |
common_name | any | No | — |
days_till_renewal | any | No | — |
dual_approval_status | object | No | — |
enrollment | object | No | — |
escrow | any | No | — |
external_ca_name | any | No | — |
ica | object | No | — |
id | any | Yes | — |
inventory_id | any | No | — |
ip | any | No | — |
key_length | any | No | — |
key_type | any | No | — |
key_usage | any | No | — |
managing_integration | any | No | — |
notes | any | No | — |
order_id | any | No | — |
organization_name | any | No | — |
organization_unit | any | No | — |
port | any | No | — |
private_key_algorithm | any | No | — |
product_type | any | No | — |
profile | object | No | — |
revocation_reason | aa_compromise | affiliation_changed | ca_compromise | certificate_hold | cessation_of_operation | key_compromise | privilege_withdrawn | remove_from_crl | superseded | unspecified | No | — |
root_ca_name | any | No | — |
seat | object | No | — |
serial_number | any | No | — |
signing_algorithm | any | No | — |
source | any | No | — |
status | deleted | expired | issued | replaced | replaced_external | revoked | suspended | No | — |
subject | object | No | — |
subject_email | any | No | — |
system_name | any | No | — |
tags | any | No | — |
thumbprint | any | No | — |
valid_from | any | No | — |
valid_to | any | No | — |
automation_instance_count | any | No | — |
discovery_instance_count | any | No | — |
delivery_format | x509 | pkcs7 | pkcs12 | pkcs12_pem | No | — |
certificate | any | No | — |
pkcs12_password | any | No | — |
account_id | any | No | — |
revocation_date | any | No | — |
san_email | any | No | — |
thumbprint_sha1 | any | No | — |
cert_arn | any | No | — |
azure_cert_id | any | No | — |
gcp_metadata | any | No | — |
recovery_comment | any | No | — |
cert_issues | any | No | — |
cert_security_rating | any | No | — |
security_rating_info | object | No | — |
server_id | any | No | — |
server_id_type | any | No | — |
first_discovered_date | any | No | — |
last_discovered_date | any | No | — |
application_version | any | No | — |
os_name | any | No | — |
os_version | any | No | — |
ca_vendor | any | No | — |
renewed_cert_id | any | No | — |
expires_in_days | any | No | — |
connector_tags | any | No | — |
parent_id | any | No | — |
has_warning | any | No | — |
quantum_safe | any | No | — |
related_connector | object | No | — |
vault_connector | object | No | — |
vault_uri | object | No | — |
managing_ca | any | No | — |
escrow_client_key_id | any | No | — |
cc_account_id | any | No | — |
cc_container_id | any | No | — |
security_identifier | any | No | — |
ian_string | any | No | — |
aws_acm | any | No | — |
connector_provider | any | No | — |
extended_key_usage | any | No | — |
file_path | any | No | — |
file_name | any | No | — |
file_type | any | No | — |
system_scan_cert_id | any | No | — |
intune_deployment_details | any | No | — |
found_in_archive | any | No | — |
msca_template_name | any | No | — |
cert_delivery_details | any | No | — |
dcone_user_id | any | No | — |
dcone_user_email | any | No | — |
bulk_job_name | any | No | — |
bulk_operation_job_id | any | No | — |
bulk_operation_job_name | any | No | — |
vs_partition | any | No | — |
vs_alias | any | No | — |
domain_name | any | No | — |
host_name | any | No | — |
renewal_window | any | No | — |
custom_attributes | any | No | — |
cert_owners | any | No | — |
protocols | any | No | — |
smime_cert_profile_type | any | No | — |
automation_action full type
automation_action full type
{
primaryAction?: ENROLL | GET_NEXT_CERT | REISSUE | RENEW | TRANSFER,
renewalStartDate?: any,
secondaryActions?: any
}
business_unit full type
business_unit full type
{
id: any,
name?: any
}
cc_settings full type
cc_settings full type
{
auto_renew_settings?: {
auto_renew_certificate_and_order: any,
auto_renew_time?: {
days?: any,
hours?: any,
minutes?: any,
time_format: any,
zone: any
},
before_expiration: any
},
contacts?: any,
ct_log_option?: any,
ct_log_value?: any,
http_signed_exchange?: any,
key_size?: any,
key_type?: any,
order_coverage_length?: {
chronology?: {
calendarType?: any,
id?: any
},
days?: any,
months?: any,
negative?: any,
units?: any,
years?: any,
zero?: any
},
override_validity?: any,
organization?: {
id: any,
name?: any
},
product_type: cloud_dv_geotrust | code_signing | code_signing_ev | private_ssl_flex | private_ssl_multi_domain | private_ssl_plus | private_ssl_wildcard | ssl_basic | ssl_cloud_wildcard | ssl_dv_geotrust | ssl_dv_geotrust_flex | ssl_dv_rapidssl | ssl_dv_thawte | ssl_ev_basic | ssl_ev_geotrust_truebizid | ssl_ev_multi_domain | ssl_ev_plus | ssl_ev_securesite | ssl_ev_securesite_flex | ssl_ev_securesite_multi_domain | ssl_ev_securesite_pro | ssl_ev_thawte_webserver | ssl_geotrust_truebizid | ssl_multi_domain | ssl_plus | ssl_securesite | ssl_securesite_flex | ssl_securesite_multi_domain | ssl_securesite_pro | ssl_securesite_wildcard | ssl_thawte_webserver | ssl_wildcard | wildcard_dv_geotrust | wildcard_dv_rapidssl | string,
signature_algorithm?: {
id: any,
name?: any
}
}
dual_approval_status full type
dual_approval_status full type
{
admins_approved?: any,
dual_approve_enabled?: any
}
enrollment full type
enrollment full type
{
id: any
}
ica full type
ica full type
{
id: any,
name?: any
}
profile full type
profile full type
{
authentication_method?: any,
enrollment_method?: any,
id: any,
name?: any,
status?: action_needed | active | suspended | string,
trust_type?: private | public | string
}
seat full type
seat full type
{
active?: any,
business_unit?: {
id: any,
name?: any
},
created_at?: any,
email?: any,
id?: any,
number_of_pending?: any,
phone?: any,
seat_allowed_for_enrollment?: any,
seat_id?: any,
seat_name?: any,
seat_type?: {
id: any,
name?: any
},
seat_creation_date?: any
}
subject full type
subject full type
{
common_name?: any,
country?: any,
locality?: any,
organization_name?: any,
organization_units?: any,
postal_code?: any,
state?: any,
street_address?: any
}
security_rating_info full type
security_rating_info full type
{
security_rating?: any,
handshake_protocols?: {
cipher_algorithm?: any,
key_size?: any,
protocol?: any
},
security_headers?: any,
http_response_headers?: any,
certificate_chain?: {
cert_chain_details?: any,
no_of_cert_chain_found?: any
},
security_rating_score?: any,
certificate_chain_score?: any,
handshake_protocols_score?: any,
security_headers_score?: any,
http_response_headers_score?: any,
protocol_ciphers?: any,
protocol_ciphers_score?: {
protocols?: any,
score?: any
}
}
related_connector full type
related_connector full type
{
id: any,
name?: any
}
vault_connector full type
vault_connector full type
{
id: any,
name?: any
}
vault_uri full type
vault_uri full type
{
id: any,
name?: any
}
postRenewCertificateEnrollmentUsingCertificateId
trustLifecycleApi.postRenewCertificateEnrollmentUsingCertificateId
Renew Certificate enrollment using certificate Id.
Risk: destructive
await corsair.digicert.api.trustLifecycleApi.postRenewCertificateEnrollmentUsingCertificateId({
path: {
certificate_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
certificate_id: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
profile?: {
id: any
},
csr?: any,
saml_response_id?: any
}
| Name | Type | Required | Description |
|---|---|---|---|
id | any | Yes | — |
postRunRuleNow
trustLifecycleApi.postRunRuleNow
Run rule now
Risk: write
await corsair.digicert.api.trustLifecycleApi.postRunRuleNow({
path: {
ruleId: {},
},
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
ruleId: any
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
postSuspendSensors
trustLifecycleApi.postSuspendSensors
Suspend sensors
Risk: write
await corsair.digicert.api.trustLifecycleApi.postSuspendSensors({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account_id?: any,
license_keys?: any
}
undefined
postVoidById
trustLifecycleApi.postVoidById
Void by ID
Risk: write
await corsair.digicert.api.trustLifecycleApi.postVoidById({
path: {
integration_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
integration_id: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
postVoidSensors
trustLifecycleApi.postVoidSensors
Void sensors
Risk: write
await corsair.digicert.api.trustLifecycleApi.postVoidSensors({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account_id?: any,
license_keys?: any
}
undefined
publicCertificateSearchSummary
trustLifecycleApi.publicCertificateSearchSummary
Search certificate summaries
Risk: read
await corsair.digicert.api.trustLifecycleApi.publicCertificateSearchSummary({
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
account_id: any,
status?: issued | revoked | expired | suspended,
issuer_type?: private_ca,
offset?: any,
limit?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
object
Output full type
Output full type
{
total: any,
offset: any,
limit: any
}& {
has_more?: any,
items?: any
}
publicCountCertificateMigrationCandidates
trustLifecycleApi.publicCountCertificateMigrationCandidates
Count certificate migration candidates
Risk: read
await corsair.digicert.api.trustLifecycleApi.publicCountCertificateMigrationCandidates({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
account_id?: any,
exclude_certificate_status?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
total_count | any | No | — |
publicGetCertificateMigrationCandidates
trustLifecycleApi.publicGetCertificateMigrationCandidates
List certificate migration candidates
Risk: read
await corsair.digicert.api.trustLifecycleApi.publicGetCertificateMigrationCandidates({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
}
query full type
query full type
{
account_id?: any,
exclude_certificate_status?: any,
cursor?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
batch_size | any | No | — |
cursor | any | null | No | — |
items | any | No | — |
publicGetCertUsingId
trustLifecycleApi.publicGetCertUsingId
Get certificate by ID
Risk: read
await corsair.digicert.api.trustLifecycleApi.publicGetCertUsingId({
path: {
certificate_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
certificate_id: any
}
query full type
query full type
{
ip?: any,
survey_id?: any,
port?: any,
server_id?: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
publicListPastScansUsingGet
trustLifecycleApi.publicListPastScansUsingGet
List past scans
Risk: read
await corsair.digicert.api.trustLifecycleApi.publicListPastScansUsingGet({
path: {
id: {},
},
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
id: any
}
query full type
query full type
{
category?: CURRENT | PAST,
limit?: any,
offset?: any,
sort?: any,
status?: ADDED | CANCELLED | COMPLETED | DELETED | ERROR | FAILED | PARTIAL | SKIPPED,
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
putAddCertificateOwnersMappingForCertificate
trustLifecycleApi.putAddCertificateOwnersMappingForCertificate
Add certificate owners mapping for certificate
Risk: write
await corsair.digicert.api.trustLifecycleApi.putAddCertificateOwnersMappingForCertificate({
path: {
id: {},
},
body: {
account_id: {},
certificate_owner_ids: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account_id: any,
certificate_owner_ids: any
}
undefined
putAddCustomAttributesMappingForCertificate
trustLifecycleApi.putAddCustomAttributesMappingForCertificate
Add custom attributes mapping for certificate
Risk: write
await corsair.digicert.api.trustLifecycleApi.putAddCustomAttributesMappingForCertificate({
path: {
id: {},
},
body: {
account_id: {},
custom_attributes_request: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account_id: any,
custom_attributes_request: any
}
undefined
putApproveAgents
trustLifecycleApi.putApproveAgents
Approve agents
Risk: write
await corsair.digicert.api.trustLifecycleApi.putApproveAgents({
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
ids?: any
}
undefined
putAssignAnAdminToABusinessUnit
trustLifecycleApi.putAssignAnAdminToABusinessUnit
Assign an admin to a Business Unit
Risk: write
await corsair.digicert.api.trustLifecycleApi.putAssignAnAdminToABusinessUnit({
path: {
id: {},
},
body: {
id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
id: any
}
any
putAssignSeatToAnotherBusinessUnit
trustLifecycleApi.putAssignSeatToAnotherBusinessUnit
Assign seat to another business unit
Risk: write
await corsair.digicert.api.trustLifecycleApi.putAssignSeatToAnotherBusinessUnit({
path: {
seat_id: {},
new_business_unit_id: {},
},
query: {
business_unit_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
seat_id: any,
new_business_unit_id: any
}
query full type
query full type
{
business_unit_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
seat_id | any | No | — |
seat_name | any | No | — |
email | any | No | — |
phone | any | No | — |
seat_creation_date | any | No | — |
putBulkMapDevicesToProfiles
trustLifecycleApi.putBulkMapDevicesToProfiles
Bulk map devices to profiles
Risk: write
await corsair.digicert.api.trustLifecycleApi.putBulkMapDevicesToProfiles({
query: {
account_id: {},
},
body: {
deviceInventoryIds: {},
profileIds: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
deviceInventoryIds: any,
profileIds: any
}
| Name | Type | Required | Description |
|---|---|---|---|
count | any | No | — |
message | any | No | — |
rejectedProfiles | any | No | — |
putLinkDevicesToAProfile
trustLifecycleApi.putLinkDevicesToAProfile
Link devices to a profile
Risk: write
await corsair.digicert.api.trustLifecycleApi.putLinkDevicesToAProfile({
path: {
profileId: {},
},
query: {
account_id: {},
},
body: {
deviceInventoryIds: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
profileId: any
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
deviceInventoryIds: any
}
| Name | Type | Required | Description |
|---|---|---|---|
count | any | No | — |
message | any | No | — |
rejectedProfiles | any | No | — |
putReinstateAgents
trustLifecycleApi.putReinstateAgents
Reinstate agents
Risk: write
await corsair.digicert.api.trustLifecycleApi.putReinstateAgents({
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
ids?: any
}
undefined
putRejectAgents
trustLifecycleApi.putRejectAgents
Reject agents
Risk: write
await corsair.digicert.api.trustLifecycleApi.putRejectAgents({
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
comment?: any,
ids?: any
}
undefined
putRetryAgentConfig
trustLifecycleApi.putRetryAgentConfig
Retry agent config
Risk: write
await corsair.digicert.api.trustLifecycleApi.putRetryAgentConfig({
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
id?: any,
inventory?: {
acme_client_id?: any,
app_name?: any,
app_version?: any,
automation_status?: ACME_ACCOUNT_CREATED | ACME_ACCOUNT_CREATION_FAILED | ACME_ACCOUNT_CREATION_IN_PROGRESS | ACME_CERT_ISSUANCE_FAILED | ACME_CERT_ISSUANCE_IN_PROGRESS | ACME_CERT_ISSUED | ACME_CHALLENGE_VALIDATED | ACME_CHALLENGE_VALIDATION_FAILED | ACME_CHALLENGE_VALIDATION_IN_PROGRESS | ACME_CLIENT_APP_UPGRADE_IN_PROGRESS | ACTION_REQUIRED | AGENT_ERROR | AUTOMATED_BY_AGENT | AUTOMATED_BY_AGENTLESS | AUTOMATION_AT_RISK | AUTOMATION_FAILED | AUTOMATION_PROFILE_BLOCKED | AUTOMATION_REQUESTED | AUTOMATION_SCHEDULED | AUTOMATION_SUCCESSFUL | AUTO_RENEW_SCHEDULED | CERT_PENDING_APPROVAL | CERT_READY_TO_INSTALL | CERT_REQ_DENIED_BY_CIS | CONFIGURATION_ERROR | CONFIGURATION_IN_PROGRESS | CONFIGURED | CONFLICTED | CSR_GENERATION_FAILED | CSR_GENERATION_IN_PROGRESS | CSR_GENERATION_SUCCEEDED | DELETED | DISABLED_FOR_AUTOMATION | DNS_INTEGRATION_FAILED | IGNORED | INSTALL_FAILED | INSTALL_IN_PROGRESS | INSTALL_SUCCEEDED | INSTALL_VALIDATED | INSTALL_VALIDATION_FAILED | INSTALL_VALIDATION_IN_PROGRESS | INTEGRATION_ERROR | IS_UPGRADE | NOT_CONFIGURED | NOT_SCANNED | POST_CSR_FAILED | REMOVED | SCAN_IN_PROGRESS,
id?: any,
ip?: any,
port?: {
port?: any
},
script_args?: any,
script_path?: any
}
}
undefined
putSuspendAgents
trustLifecycleApi.putSuspendAgents
Suspend agents
Risk: write
await corsair.digicert.api.trustLifecycleApi.putSuspendAgents({
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
ids?: any
}
undefined
putUnlinkDevicesFromAProfile
trustLifecycleApi.putUnlinkDevicesFromAProfile
Unlink devices from a profile
Risk: write
await corsair.digicert.api.trustLifecycleApi.putUnlinkDevicesFromAProfile({
path: {
profileId: {},
},
query: {
account_id: {},
},
body: {
deviceInventoryIds: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
profileId: any
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
deviceInventoryIds: any
}
| Name | Type | Required | Description |
|---|---|---|---|
count | any | No | — |
message | any | No | — |
rejectedProfiles | any | No | — |
putUpdateAgent
trustLifecycleApi.putUpdateAgent
Update agent
Risk: write
await corsair.digicert.api.trustLifecycleApi.putUpdateAgent({
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
agent_group?: any,
business_unit_id?: any,
hb_interval?: any,
id?: any,
inventories?: any,
name?: any,
recipients?: any,
sni?: {
is_enabled?: any,
items?: any
},
version?: any,
script_settings?: any,
post_install_service_restart?: any
}
undefined
putUpdateAgentScript
trustLifecycleApi.putUpdateAgentScript
Update agent script
Risk: write
await corsair.digicert.api.trustLifecycleApi.putUpdateAgentScript({
path: {
id: {},
},
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
id: any
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
id?: any,
name?: any,
os?: any,
type?: any,
path?: any,
executionCommand?: any,
description?: any,
automationId?: any
}
undefined
putUpdateBusinessUnitLicense
trustLifecycleApi.putUpdateBusinessUnitLicense
Update business unit license
Risk: write
await corsair.digicert.api.trustLifecycleApi.putUpdateBusinessUnitLicense({
path: {
bu_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | any | No | — |
path full type
path full type
{
bu_id: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
any
putUpdateCertificateOwnerDetailsForAGivenCertificateOwnerId
trustLifecycleApi.putUpdateCertificateOwnerDetailsForAGivenCertificateOwnerId
Update certificate owner details for a given certificate owner ID
Risk: write
await corsair.digicert.api.trustLifecycleApi.putUpdateCertificateOwnerDetailsForAGivenCertificateOwnerId({
path: {
id: {},
},
body: {
account_id: {},
certificate_owner: {
email: {},
},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account_id: any,
certificate_owner: {
first_name?: any,
last_name?: any,
email: any,
custom_identifier?: any
}
}
| Name | Type | Required | Description |
|---|---|---|---|
id | any | No | — |
first_name | any | No | — |
last_name | any | No | — |
email | any | No | — |
account_id | any | No | — |
custom_identifier | any | No | — |
putUpdateCustomAttribute
trustLifecycleApi.putUpdateCustomAttribute
Update custom attribute
Risk: write
await corsair.digicert.api.trustLifecycleApi.putUpdateCustomAttribute({
path: {
id: {},
},
query: {
account_id: {},
},
body: {
custom_attribute: {
name: {},
type: 'TEXT_FIELD',
},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: any
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
custom_attribute: {
name: any,
type: TEXT_FIELD | DROP_DOWN_LIST | GROUPED_DROP_DOWN | FIXED_VALUE,
items?: any,
required?: any,
default_value?: any,
multi_select?: any,
grouped_items?: any
}
}
| Name | Type | Required | Description |
|---|---|---|---|
id | any | No | — |
name | any | No | — |
type | any | No | — |
items | any | No | — |
required | any | No | — |
default_value | any | No | — |
multi_select | any | No | — |
grouped_items | any | No | — |
putUpdateDevice
trustLifecycleApi.putUpdateDevice
Update device
Risk: write
await corsair.digicert.api.trustLifecycleApi.putUpdateDevice({
path: {
id: {},
},
query: {
account_id: {},
},
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: any
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
id?: any,
accountId?: any,
deviceName?: any,
serialNumber?: any,
udid?: any,
status?: ACTIVE | INACTIVE,
profileIds?: any,
profiles?: any,
createdAt?: any,
updatedAt?: any,
createdBy?: any,
updatedBy?: any,
rejectedProfiles?: any,
message?: any
}
| Name | Type | Required | Description |
|---|---|---|---|
id | any | No | — |
accountId | any | No | — |
deviceName | any | No | — |
serialNumber | any | No | — |
udid | any | No | — |
status | ACTIVE | INACTIVE | string | No | — |
profileIds | any | No | — |
profiles | any | No | — |
createdAt | any | No | — |
updatedAt | any | No | — |
createdBy | any | No | — |
updatedBy | any | No | — |
rejectedProfiles | any | No | — |
message | any | No | — |
putUpdateGlobalAgentSettings
trustLifecycleApi.putUpdateGlobalAgentSettings
Update global agent settings
Risk: write
await corsair.digicert.api.trustLifecycleApi.putUpdateGlobalAgentSettings({
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
linux_restricted_ports?: any,
manual_approval?: any,
scan_block_list?: any,
windows_restricted_ports?: any
}
undefined
putUpdateProfile
trustLifecycleApi.putUpdateProfile
Update profile
Risk: write
await corsair.digicert.api.trustLifecycleApi.putUpdateProfile({
path: {
profile_id: {},
},
body: {
name: {},
business_unit_id: {},
ica: {
id: {},
},
account_id: {},
template_id: {},
enrollment_method: 'digicert_desktop_client',
authentication_method: 'third_party_app',
seat_id_mapping: 'email',
renewal_window_days: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
profile_id: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
name: any,
description?: any,
business_unit_id: any,
ica: {
id: any,
name?: any
},
account_id: any,
template_id: any,
enrollment_method: digicert_desktop_client | android | browser_pkcs12 | csr | est | ios | os_browser | pki_client | rest_api | scep | acme | acme_device_attestation,
authentication_method: third_party_app | active_directory | certificate_authentication | enrollment_code | global_passphrase | manual_approval | saml_idp | no_auth,
seat_id_mapping: email | san_emails | common_name | upn | unique_identifier | serial_number | dns_names | other_name_guid | registered_ids | subject_email | dn_qualifier | pseudonym | seat_identifier,
cert_delivery_format?: x509 | pkcs7 | pkcs12 | pkcs12_pem | pkcs12_der,
custom_extended_key_usages?: any,
renewal_window_days: any,
days_till_enrollment_expires?: any,
duplicate_certificate_allowed?: any,
notify_requestor?: any,
embed_enrollment_code_in_url?: any,
grace_period_enabled?: any,
enable_ldap_search?: any,
self_service_portal_active?: any,
global_enrollment_code?: any,
fields?: any,
connector_id?: any,
use_custom_contact?: any,
ca_settings?: {
contacts?: any,
certificate_fields?: {
validity_period?: any,
renewal_period?: any,
key_type?: any,
key_size?: any,
signature_algorithm?: any,
crypto_providers?: any,
arn?: any
}
},
cc_settings?: {
auto_renew_settings?: {
auto_renew_certificate_and_order: any,
auto_renew_time?: {
days?: any,
hours?: any,
minutes?: any,
time_format: any,
zone: any
},
before_expiration: any
},
contacts?: any,
http_signed_exchange?: any,
key_sizes?: any,
account_id?: any,
is_custom_validity?: any,
duplicate_minimum_validity_days?: any | null,
key_type?: any,
order_coverage_length?: any,
override_validity?: any,
organization?: {
id?: any,
name?: any,
value?: any
},
organization_contact?: {
id: any,
name: any,
contact_type: organization_contact | technical_contact | verified_contact
},
product_type: cloud_dv_geotrust | code_signing | code_signing_ev | private_ssl_flex | private_ssl_multi_domain | private_ssl_plus | private_ssl_wildcard | ssl_basic | ssl_cloud_wildcard | ssl_dv_geotrust | ssl_dv_geotrust_flex | ssl_dv_rapidssl | ssl_dv_thawte | ssl_ev_basic | ssl_ev_geotrust_truebizid | ssl_ev_multi_domain | ssl_ev_plus | ssl_ev_securesite | ssl_ev_securesite_flex | ssl_ev_securesite_multi_domain | ssl_ev_securesite_pro | ssl_ev_thawte_webserver | ssl_geotrust_truebizid | ssl_multi_domain | ssl_plus | ssl_securesite | ssl_securesite_flex | ssl_securesite_multi_domain | ssl_securesite_pro | ssl_securesite_wildcard | ssl_thawte_webserver | ssl_wildcard | wildcard_dv_geotrust | wildcard_dv_rapidssl,
signature_algorithm?: {
id?: any,
name?: any
},
container?: {
id?: any,
name?: any,
value?: any
},
region?: any
},
key_escrow_policy?: {
key_escrow_enabled: any,
key_escrow_deployment_mode?: CLOUD | LOCAL,
dual_admin_recovery: any
},
tags?: any,
api_token_binding_enabled?: any | null,
api_token_ids?: any,
ssp_auth_operations?: any,
ssp_open_operations?: any,
allowed_user_group?: any,
allowed_fqdn_regex?: any,
additional_recipients?: any,
certificate_owner_ids?: any
}
| Name | Type | Required | Description |
|---|---|---|---|
id | any | No | — |
name | any | No | — |
status | Active | Deleted | Suspended | Action needed | No | — |
signature_algorithm | SHA1_WITH_RSA | SHA256_WITH_RSA | SHA384_WITH_RSA | SHA512_WITH_RSA | SHA256_WITH_ECDSA | SHA384_WITH_ECDSA | SHA512_WITH_ECDSA | MATCH_ISSUER | No | — |
publish_to_public_directory | any | No | — |
renewal_period_days | any | No | — |
duplicate_cert_policy | any | No | — |
override_cert_validity_via_api | any | No | — |
certificate_delivery_format | x509 | pkcs7 | pkcs12 | string | No | — |
business_unit_id | any | No | — |
account_id | any | No | — |
enrollment_method | digicert_desktop_client | android | browser_pkcs12 | csr | est | ios | os_browser | pki_client | rest_api | scep | acme | acme_device_attestation | No | — |
authentication_method | third_party_app | active_directory | certificate_authentication | enrollment_code | global_passphrase | manual_approval | saml_idp | no_auth | No | — |
key_escrow_policy | object | No | — |
private_key_attributes | object | No | — |
allowed_key_sizes | any | No | — |
api_token_binding_enabled | any | No | — |
api_token_id | any | No | — |
enable_dual_admin_approval | any | No | — |
certificate | object | No | — |
template | object | No | — |
allowed_list | any | No | — |
custom_extended_key_usages | any | No | — |
key_escrow_policy full type
key_escrow_policy full type
{
key_escrow_enabled: any,
key_escrow_deployment_mode?: CLOUD | LOCAL | string,
dual_admin_recovery: any
}
private_key_attributes full type
private_key_attributes full type
{
key_size?: any
}
certificate full type
certificate full type
{
subject?: {
attributes?: any
},
validity?: {
unit?: years | months | days | hours | minutes,
duration?: any
},
extensions?: {
san?: {
critical?: any,
attributes?: any
},
issuer_alt_name?: {
critical?: any,
attributes?: any
},
security_identifier?: {
attributes?: any
}
},
issuer?: {
serial_number?: any,
subject_dn?: any,
certificate?: any,
root?: any,
chain?: any
}& {
chain?: any
}
}
template full type
template full type
{
id?: any,
name?: any,
trust_type?: private | public | string
}
putUpdateRule
trustLifecycleApi.putUpdateRule
Update rule
Risk: write
await corsair.digicert.api.trustLifecycleApi.putUpdateRule({
path: {
id: {},
},
body: {
account_id: {},
name: {},
type: 'certificate',
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
id: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account_id: any,
name: any,
description?: any,
type: certificate | asset,
rule_id?: any,
status?: any,
assignments?: any,
conditions?: any,
targets?: any
}
undefined
putUpdateSeat
trustLifecycleApi.putUpdateSeat
Update seat
Risk: write
await corsair.digicert.api.trustLifecycleApi.putUpdateSeat({
path: {
seat_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
seat_id: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
business_unit_id?: any,
seat_type?: {
id?: USER_SEAT | DEVICE_SEAT | SERVER_SEAT | CERTIFICATE_MANAGEMENT_SEAT | IMPORTED_SEAT | DISCOVERY_SEAT | ORANIZATION_SEAT
},
seat_id?: any
}& {
seat_name?: any,
email?: any,
phone?: any
}
undefined
putUpdateSensorDetails
trustLifecycleApi.putUpdateSensorDetails
Update sensor details
Risk: write
await corsair.digicert.api.trustLifecycleApi.putUpdateSensorDetails({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account_id?: any,
advanced_settings?: {
debug_enabled?: any,
heartbeat_interval?: any,
heartbeat_port?: any
},
business_unit?: {
id: any,
name?: any
}& any,
id?: any,
name?: any
}
undefined
putUpdateStatusOfManualApprovalEnrollment
trustLifecycleApi.putUpdateStatusOfManualApprovalEnrollment
Update status of manual approval enrollment
Risk: write
await corsair.digicert.api.trustLifecycleApi.putUpdateStatusOfManualApprovalEnrollment({
path: {
enrollment_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
enrollment_id: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
new_status: approved | created | expired | in_progress | locked | pending | pending_second_approval | redeemed | rejected,
message_to_user?: any,
custom_validity_days?: any
}
undefined
putVoidAgents
trustLifecycleApi.putVoidAgents
Void agents
Risk: write
await corsair.digicert.api.trustLifecycleApi.putVoidAgents({
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
ids?: any
}
undefined
recreateAcmecredentialsPublic
trustLifecycleApi.recreateAcmecredentialsPublic
Recreate ACME credentials
Risk: write
await corsair.digicert.api.trustLifecycleApi.recreateAcmecredentialsPublic({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
profileId?: any,
expiry_at?: any | null
}
| Name | Type | Required | Description |
|---|---|---|---|
eab_kid | any | No | — |
eab_hmac | any | No | — |
directory_url | any | No | — |
expiry_date | any | null | No | — |
refreshSensorIntegration
trustLifecycleApi.refreshSensorIntegration
Refresh sensor integrations
Risk: write
await corsair.digicert.api.trustLifecycleApi.refreshSensorIntegration({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
integrations: any
}
any
renameSensorUsingPut
trustLifecycleApi.renameSensorUsingPut
Rename sensor
Risk: write
await corsair.digicert.api.trustLifecycleApi.renameSensorUsingPut({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account_id: any,
id: any,
name: any
}
undefined
requestBulkAutomationUsingPost
trustLifecycleApi.requestBulkAutomationUsingPost
Create bulk certificate automation event
Risk: write
await corsair.digicert.api.trustLifecycleApi.requestBulkAutomationUsingPost({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
automation_ids: any,
account_id: any,
custom_fields?: any,
dns_integration_id?: any,
profile_id?: any,
run_now?: any,
schedule_settings?: {
hours?: any,
minutes?: any,
start_date: any,
time_format: any,
zone?: any
},
awr_profile_id?: any,
sensor_profile_id?: any,
agent_profile_id?: any,
bulk_action_type?: ENROLL | GET_NEXT_CERT | REISSUE | RENEW | TRANSFER,
bulk_automation_batch_name?: any
}
undefined
restoreSystemScanScheduleUsingPostpublic
trustLifecycleApi.restoreSystemScanScheduleUsingPostpublic
Restore system scan schedule
Risk: write
await corsair.digicert.api.trustLifecycleApi.restoreSystemScanScheduleUsingPostpublic({
path: {
agentId: {},
time: {},
},
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
agentId: any,
time: any
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
resumeSystemScanUsingPostpublic
trustLifecycleApi.resumeSystemScanUsingPostpublic
Resume system scan
Risk: write
await corsair.digicert.api.trustLifecycleApi.resumeSystemScanUsingPostpublic({
query: {
account_id: {},
},
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
agents?: any
}
undefined
retryAutomationUsingPut
trustLifecycleApi.retryAutomationUsingPut
Retry certificate automation request
Risk: write
await corsair.digicert.api.trustLifecycleApi.retryAutomationUsingPut({
path: {
automation_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
automation_id: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
runNowUsingPost
trustLifecycleApi.runNowUsingPost
Connector run now
Risk: write
await corsair.digicert.api.trustLifecycleApi.runNowUsingPost({
path: {
connector_id: {},
},
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
connector_id: any
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
skipFutureSystemScanScheduleUsingPostpublic
trustLifecycleApi.skipFutureSystemScanScheduleUsingPostpublic
Skip future system scan schedule
Risk: write
await corsair.digicert.api.trustLifecycleApi.skipFutureSystemScanScheduleUsingPostpublic({
path: {
agentId: {},
time: {},
},
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
agentId: any,
time: any
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
stopUsingPost
trustLifecycleApi.stopUsingPost
Stop connector
Risk: write
await corsair.digicert.api.trustLifecycleApi.stopUsingPost({
path: {
connector_id: {},
},
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
connector_id: any
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
suggestionsUsingGet
trustLifecycleApi.suggestionsUsingGet
Fetch field suggestions
Risk: read
await corsair.digicert.api.trustLifecycleApi.suggestionsUsingGet({
path: { field: 'provider' },
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
field: provider | type
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
suspendSystemScanUsingPostpublic
trustLifecycleApi.suspendSystemScanUsingPostpublic
Suspend system scan
Risk: write
await corsair.digicert.api.trustLifecycleApi.suspendSystemScanUsingPostpublic({
query: {
account_id: {},
},
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
agents?: any
}
undefined
testConnectionUsingPost
trustLifecycleApi.testConnectionUsingPost
Test connector
Risk: write
await corsair.digicert.api.trustLifecycleApi.testConnectionUsingPost({
path: {
connector_id: {},
},
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
connector_id: any
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
unlinkUsingPost
trustLifecycleApi.unlinkUsingPost
Unlink a connector
Risk: write
await corsair.digicert.api.trustLifecycleApi.unlinkUsingPost({
path: {
connector_id: {},
},
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
path full type
path full type
{
connector_id: any
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
undefined
updateAutomationUsingPut
trustLifecycleApi.updateAutomationUsingPut
Update scheduled certificate automation
Risk: write
await corsair.digicert.api.trustLifecycleApi.updateAutomationUsingPut({
path: {
automation_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
automation_id: any
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account_id: any,
auto_renew_settings?: {
auto_renew_certificate_and_order: any,
auto_renew_time?: {
days?: any,
hours?: any,
minutes?: any,
time_format: any,
zone: any
},
before_expiration: any
},
profile_id: any,
run_now?: any,
schedule_settings?: {
hours?: any,
minutes?: any,
start_date: any,
time_format: any,
zone?: any
}
}
undefined
updateCertDeliveryLocationForAgentPostpublic
trustLifecycleApi.updateCertDeliveryLocationForAgentPostpublic
Update certificate delivery location
Risk: write
await corsair.digicert.api.trustLifecycleApi.updateCertDeliveryLocationForAgentPostpublic({
query: {
account_id: {},
},
body: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | Yes | — |
path full type
path full type
{
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
ids?: any,
location_preference?: any
}
undefined
updateUsingPut1
trustLifecycleApi.updateUsingPut1
Update connector
Risk: write
await corsair.digicert.api.trustLifecycleApi.updateUsingPut1({
path: {
connector_id: {},
},
query: {
account_id: {},
},
});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | Yes | — |
query | object | Yes | — |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
connector_id: any
}
query full type
query full type
{
account_id: any
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
name?: any,
preset_id?: 1c389430-7885-4eb3-82e9-96fec17de7a6,
sensor_id?: any,
tags?: any,
business_unit_id?: any,
aws_account_id?: any,
aws_region?: any,
authentication_method?: any,
aws_access_key_id?: any,
aws_secret_key?: any,
profile_name?: any,
import_attributes?: {
all_valid_certificates_from_last_4_years?: any,
all_expired_certificates_within?: any,
all_revoked_certificates_that_are_valid?: any,
business_unit_id?: any,
s3_bucket_name?: any,
is_new_s3_bucket_required?: any,
last_fetched_time?: any,
tags?: any,
schedule_frequency?: {
units?: HOURS | MINUTES | WEEKS,
value?: any
}
}
} | {
name?: any,
preset_id?: 36cbd4c2-f6e7-4a35-a4e6-e03ebf939cb4,
api_key?: any,
sensor_id?: any,
tags?: any,
business_unit_id?: any,
username?: any,
password?: any,
credentials?: any,
region?: US | EU,
import_attributes?: {
all_valid_certificates_from_last_4_years?: any,
all_expired_certificates_within?: any,
all_revoked_certificates_that_are_valid?: any,
business_unit_id?: any,
s3_bucket_name?: any,
is_new_s3_bucket_required?: any,
last_fetched_time?: any,
tags?: any,
schedule_frequency?: {
units?: HOURS | MINUTES | WEEKS,
value?: any
}
}
} | {
name?: any,
preset_id?: 36cbd4c2-f6e7-4a35-a4e6-e03ebf939cb4,
sensor_id?: any,
tags?: any,
business_unit_id?: any,
username?: any,
password?: any,
additional_properties?: any,
import_attributes?: {
all_valid_certificates_from_last_4_years?: any,
all_expired_certificates_within?: any,
all_revoked_certificates_that_are_valid?: any,
business_unit_id?: any,
s3_bucket_name?: any,
is_new_s3_bucket_required?: any,
last_fetched_time?: any,
tags?: any,
schedule_frequency?: {
units?: HOURS | MINUTES | WEEKS,
value?: any
}
}
} | {
name?: any,
preset_id?: 36cbd4c2-f6e7-4a35-a4e6-e03ebf939cb4,
sensor_id?: any,
tags?: any,
business_unit_id?: any,
username?: any,
password?: any,
import_attributes?: {
import?: {
certificates?: any,
unsecured_ips_ports?: any
},
include_data?: {
ciphers?: any,
security_ratings?: any,
vulnerabilities?: any
},
business_unit_id?: any,
tags?: any,
schedule_frequency?: {
units?: HOURS | MINUTES | WEEKS,
value?: any
}
}
} | {
name?: any,
preset_id?: 1c389430-7885-4eb3-82e9-96fec17de7a6,
sensor_id?: any,
tags?: any,
business_unit_id?: any,
username?: any,
password?: any,
url?: any
} | {
name?: any,
preset_id?: any,
api_key?: any,
sensor_id?: any,
tags?: any,
business_unit_id?: any,
core_attributes?: any,
config_attributes?: any,
additional_attributes?: any
}
undefined
validateIpFqdnsPost
trustLifecycleApi.validateIpFqdnsPost
Validate IP and FQDNs
Risk: write
await corsair.digicert.api.trustLifecycleApi.validateIpFqdnsPost({});
| Name | Type | Required | Description |
|---|---|---|---|
path | object | No | Defaults to {}. |
query | object | No | Defaults to {}. |
headers | object | No | Defaults to {}. |
cookies | object | No | Defaults to {}. |
body | object | No | — |
path full type
path full type
{
}
query full type
query full type
{
}
headers full type
headers full type
{
}
cookies full type
cookies full type
{
}
body full type
body full type
{
account_id?: any,
input?: {
data?: any,
type?: any
},
included_ip_fqdns?: any,
excluded_ip_fqdns?: any
}
undefined
Users
list
users.list
List CertCentral account users.
Risk: read
await corsair.digicert.api.users.list({});
| Name | Type | Required | Description |
|---|---|---|---|
container_id | number | No | — |
access_role_id | number | No | — |
without_container | boolean | No | — |
filters | object | No | — |
sort | string | No | — |
offset | number | No | — |
limit | number | No | — |
without_container controls whether the nested primary container is returned.
filters full type
filters full type
{
status?: active | incomplete | inactive,
search?: string
}
| Name | Type | Required | Description |
|---|---|---|---|
users | object[] | Yes | — |
page | object | Yes | — |
users full type
users full type
{
id: number,
username: string,
account_id: number,
first_name: string,
last_name: string,
email: string,
job_title?: string,
telephone?: string,
status: string,
container?: {
id: number,
public_id?: string,
name: string,
parent_id?: number,
template_id?: number,
ekey?: string,
has_logo?: boolean,
is_active?: boolean
},
access_roles: {
id: number,
name: string
}[],
type: string,
has_container_assignments: boolean,
container_assignments?: {
id: number,
parent_id: number,
name: string,
is_active: boolean
}[]
}[]
page full type
page full type
{
total: number,
limit: number,
offset: number
}