cas
Download Specaccess_group_id
string
Optional access group ID filter, if specified certificates for only the specified access group are returned.
filter
string
Optional certificate validity filter. 'include_invalid' returns valid and expired certs, but not revoked certs.
- Enum
-
- valid
- include_invalid
- all
Response
Successful response, returns the root certificate object
[
{
"size": 123,
"comment": "SSH PrivX CA default",
"public_key": "AAAAB3NzaC1yc2EAAAADAQABAAACAQCsA6quFQ1Um8Mk/khMCulYwHDV7EUyQGyp4PW9x4Oq0l8UBy/yEs0SKvu6rzHOkwRiF0dJdBtue+Cl2OVd5e4sYp8I519WURuWsZXQsPEerTqkzsR5eInmSeqLYwqMfO5d4cOQ89AF17WXgqwv4x7uh5iRnBUy+rbB2X1LmBc08QZrwrbMrSSrtMwCT6uzCexTGOtE0cxfSND2+zsRSR3aNGwv6OFg7wQF7ccAUiiFVIVg/QmrUnQH6yMNkLmWa0IkH4WpgtwTGjZ9FDv84dtWd9cBeeADqQ6vkHBbd8Jdri5lELZyHvjnlA+e5vIsmC98hJ6ZS1axEewq5wIA01JYfpySxi15L+SgSt7898QewQy5HCDwE6qWgBGHUdqyJEUCbtB0Lvjcps5E1GPNspLJkRJ4dBiCyVaSdZoFuKlbSBWC/nRmdTZJiJEGUCf/fp6lr2VnpHEai7NxgNLwO+uBH+DF3elh+w12SegBfu9JukFZGbXNtGb9bZkylYuP72fh4r9QnOgYsV2pdJY7rxyxWbPU1NozWkYW70gJcKCsH0+5g0vDAqQvGiIm3pKqhcsPeaTpXN8lWhfPmiQlZ6HNr98im5af+1lw7JvGeCqNd2CSE9t4PGxN//w44bMjauvozepVRUczkVamjfLRmvzGGQrQHPcLilHEB+T0vgP31w==",
"type": "ssh-rsa",
"public_key_string": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQCsA6quFQ1Um8Mk/khMCulYwHDV7EUyQGyp4PW9x4Oq0l8UBy/yEs0SKvu6rzHOkwRiF0dJdBtue+Cl2OVd5e4sYp8I519WURuWsZXQsPEerTqkzsR5eInmSeqLYwqMfO5d4cOQ89AF17WXgqwv4x7uh5iRnBUy+rbB2X1LmBc08QZrwrbMrSSrtMwCT6uzCexTGOtE0cxfSND2+zsRSR3aNGwv6OFg7wQF7ccAUiiFVIVg/QmrUnQH6yMNkLmWa0IkH4WpgtwTGjZ9FDv84dtWd9cBeeADqQ6vkHBbd8Jdri5lELZyHvjnlA+e5vIsmC98hJ6ZS1axEewq5wIA01JYfpySxi15L+SgSt7898QewQy5HCDwE6qWgBGHUdqyJEUCbtB0Lvjcps5E1GPNspLJkRJ4dBiCyVaSdZoFuKlbSBWC/nRmdTZJiJEGUCf/fp6lr2VnpHEai7NxgNLwO+uBH+DF3elh+w12SegBfu9JukFZGbXNtGb9bZkylYuP72fh4r9QnOgYsV2pdJY7rxyxWbPU1NozWkYW70gJcKCsH0+5g0vDAqQvGiIm3pKqhcsPeaTpXN8lWhfPmiQlZ6HNr98im5af+1lw7JvGeCqNd2CSE9t4PGxN//w44bMjauvozepVRUczkVamjfLRmvzGGQrQHPcLilHEB+T0vgP31w== SSH IAM CA default",
"x509_certificate": "MIIFfTCCA2WgAwIBAgIJAN0G1Mu8LyRYMA0GCSqGSIb3DQEBBQUAMGExEDAOBgNVBAMMB2RlZmF1bHQxCzAJBgNVBAMMAmNhMRYwFAYKCZImiZPyLGQBGRYGb3JkYWluMRMwEQYKCZImiZPyLGQBGRYDc3NoMRMwEQYKCZImiZPyLGQBGRYDY29tMB4XDTE2MTAxMzAzMzYwMFoXDTIxMTAxMjAzMzYwMFowYTEQMA4GA1UEAwwHZGVmYXVsdDELMAkGA1UEAwwCY2ExFjAUBgoJkiaJk/IsZAEZFgZvcmRhaW4xEzARBgoJkiaJk/IsZAEZFgNzc2gxEzARBgoJkiaJk/IsZAEZFgNjb20wggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCsA6quFQ1Um8Mk/khMCulYwHDV7EUyQGyp4PW9x4Oq0l8UBy/yEs0SKvu6rzHOkwRiF0dJdBtue+Cl2OVd5e4sYp8I519WURuWsZXQsPEerTqkzsR5eInmSeqLYwqMfO5d4cOQ89AF17WXgqwv4x7uh5iRnBUy+rbB2X1LmBc08QZrwrbMrSSrtMwCT6uzCexTGOtE0cxfSND2+zsRSR3aNGwv6OFg7wQF7ccAUiiFVIVg/QmrUnQH6yMNkLmWa0IkH4WpgtwTGjZ9FDv84dtWd9cBeeADqQ6vkHBbd8Jdri5lELZyHvjnlA+e5vIsmC98hJ6ZS1axEewq5wIA01JYfpySxi15L+SgSt7898QewQy5HCDwE6qWgBGHUdqyJEUCbtB0Lvjcps5E1GPNspLJkRJ4dBiCyVaSdZoFuKlbSBWC/nRmdTZJiJEGUCf/fp6lr2VnpHEai7NxgNLwO+uBH+DF3elh+w12SegBfu9JukFZGbXNtGb9bZkylYuP72fh4r9QnOgYsV2pdJY7rxyxWbPU1NozWkYW70gJcKCsH0+5g0vDAqQvGiIm3pKqhcsPeaTpXN8lWhfPmiQlZ6HNr98im5af+1lw7JvGeCqNd2CSE9t4PGxN//w44bMjauvozepVRUczkVamjfLRmvzGGQrQHPcLilHEB+T0vgP31wIDAQABozgwNjALBgNVHQ8EBAMCAYYwEwYDVR0lBAwwCgYIKwYBBQUHAwkwEgYDVR0TAQH/BAgwBgEB/wIBADANBgkqhkiG9w0BAQUFAAOCAgEAQkNdHQNSYrpFMGd7A4FUVHIiRL5stF5Znillozu2RCgSvUnZjX/3qJFcG6Go2jbOQukXc/Be1AbwcUYr+EEd6LjgWzEUuq+GcLnm6pj6eaoqinNVQ7RvivVCxRGsEBEBxib+YR6AeeCucP+FSl9Enri5zYBmmVBxB6R85S5CPaZ793OXXuJLS9qzX1ecwkEqiYt+8u6SxPXXeYQgh1libdsU9AHpaY86XDJQQLww/+iXk9H/iNo7leFKOQAJcfHiBwcLF5hZwQAzdnjUChThNGJI4S03dQFI4ii1pV5YRM/5O+S0M/ZQxr27OZKrKMiHMNQ5X3WEoJLtv1A60yYw1rrA0itMeiameqWNVtjTaJBNbO1A47lZTfi0DZC3s5HGi9Vs8QAur+tQtHICbPkxq5FThM95m05RhSJyyo1qzwRD7eU7/P+KZ2WmkMeROwmKhJw6Pvsmi2vQlUleDQnjxAMVzyTF5fIGllsaZAV9rY+jZxmu6VHS4yo4sBx00w9rIyIoMjR9wSVUpzZfCJkgeOsfu09KaN5vr1seW7xvaKOKTZqTY1kzZMZ9wah+SMCWokKS6qboXeOJ6ERmcDRBOq2I+slCkaaCP/apcNZFGP7YH9WcTZhb767IBZaPVdrjFVYoABbufyvs8HcHqfv7mcAtvUFnaf5Yi5S98KJhqc0=",
"not_before": "2023-06-05T12:31:36Z",
"not_after": "2028-06-03T12:31:36Z"
}
]
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Bad request
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Internal server error
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
error_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing an error
details
array[]
An array of errors describing error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing an error
details
array[]
An array of errors describing error in more detail
reference (error)
recursivearray[object]
- Content Type
- application/json
object
Root certificate representation
size
int
- Default
- 4096
comment
string
- Example
- "SSH PrivX CA default"
public_key
string
- Example
- "AAAAB3NzaC1yc2EAAAADAQABAAACAQCsA6quFQ1Um8Mk/khMCulYwHDV7EUyQGyp4PW9x4Oq0l8UBy/yEs0SKvu6rzHOkwRiF0dJdBtue+Cl2OVd5e4sYp8I519WURuWsZXQsPEerTqkzsR5eInmSeqLYwqMfO5d4cOQ89AF17WXgqwv4x7uh5iRnBUy+rbB2X1LmBc08QZrwrbMrSSrtMwCT6uzCexTGOtE0cxfSND2+zsRSR3aNGwv6OFg7wQF7ccAUiiFVIVg/QmrUnQH6yMNkLmWa0IkH4WpgtwTGjZ9FDv84dtWd9cBeeADqQ6vkHBbd8Jdri5lELZyHvjnlA+e5vIsmC98hJ6ZS1axEewq5wIA01JYfpySxi15L+SgSt7898QewQy5HCDwE6qWgBGHUdqyJEUCbtB0Lvjcps5E1GPNspLJkRJ4dBiCyVaSdZoFuKlbSBWC/nRmdTZJiJEGUCf/fp6lr2VnpHEai7NxgNLwO+uBH+DF3elh+w12SegBfu9JukFZGbXNtGb9bZkylYuP72fh4r9QnOgYsV2pdJY7rxyxWbPU1NozWkYW70gJcKCsH0+5g0vDAqQvGiIm3pKqhcsPeaTpXN8lWhfPmiQlZ6HNr98im5af+1lw7JvGeCqNd2CSE9t4PGxN//w44bMjauvozepVRUczkVamjfLRmvzGGQrQHPcLilHEB+T0vgP31w=="
type
string
- Example
- "ssh-rsa"
public_key_string
string
- Example
- "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQCsA6quFQ1Um8Mk/khMCulYwHDV7EUyQGyp4PW9x4Oq0l8UBy/yEs0SKvu6rzHOkwRiF0dJdBtue+Cl2OVd5e4sYp8I519WURuWsZXQsPEerTqkzsR5eInmSeqLYwqMfO5d4cOQ89AF17WXgqwv4x7uh5iRnBUy+rbB2X1LmBc08QZrwrbMrSSrtMwCT6uzCexTGOtE0cxfSND2+zsRSR3aNGwv6OFg7wQF7ccAUiiFVIVg/QmrUnQH6yMNkLmWa0IkH4WpgtwTGjZ9FDv84dtWd9cBeeADqQ6vkHBbd8Jdri5lELZyHvjnlA+e5vIsmC98hJ6ZS1axEewq5wIA01JYfpySxi15L+SgSt7898QewQy5HCDwE6qWgBGHUdqyJEUCbtB0Lvjcps5E1GPNspLJkRJ4dBiCyVaSdZoFuKlbSBWC/nRmdTZJiJEGUCf/fp6lr2VnpHEai7NxgNLwO+uBH+DF3elh+w12SegBfu9JukFZGbXNtGb9bZkylYuP72fh4r9QnOgYsV2pdJY7rxyxWbPU1NozWkYW70gJcKCsH0+5g0vDAqQvGiIm3pKqhcsPeaTpXN8lWhfPmiQlZ6HNr98im5af+1lw7JvGeCqNd2CSE9t4PGxN//w44bMjauvozepVRUczkVamjfLRmvzGGQrQHPcLilHEB+T0vgP31w== SSH IAM CA default"
x509_certificate
string
- Example
- "MIIFfTCCA2WgAwIBAgIJAN0G1Mu8LyRYMA0GCSqGSIb3DQEBBQUAMGExEDAOBgNVBAMMB2RlZmF1bHQxCzAJBgNVBAMMAmNhMRYwFAYKCZImiZPyLGQBGRYGb3JkYWluMRMwEQYKCZImiZPyLGQBGRYDc3NoMRMwEQYKCZImiZPyLGQBGRYDY29tMB4XDTE2MTAxMzAzMzYwMFoXDTIxMTAxMjAzMzYwMFowYTEQMA4GA1UEAwwHZGVmYXVsdDELMAkGA1UEAwwCY2ExFjAUBgoJkiaJk/IsZAEZFgZvcmRhaW4xEzARBgoJkiaJk/IsZAEZFgNzc2gxEzARBgoJkiaJk/IsZAEZFgNjb20wggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCsA6quFQ1Um8Mk/khMCulYwHDV7EUyQGyp4PW9x4Oq0l8UBy/yEs0SKvu6rzHOkwRiF0dJdBtue+Cl2OVd5e4sYp8I519WURuWsZXQsPEerTqkzsR5eInmSeqLYwqMfO5d4cOQ89AF17WXgqwv4x7uh5iRnBUy+rbB2X1LmBc08QZrwrbMrSSrtMwCT6uzCexTGOtE0cxfSND2+zsRSR3aNGwv6OFg7wQF7ccAUiiFVIVg/QmrUnQH6yMNkLmWa0IkH4WpgtwTGjZ9FDv84dtWd9cBeeADqQ6vkHBbd8Jdri5lELZyHvjnlA+e5vIsmC98hJ6ZS1axEewq5wIA01JYfpySxi15L+SgSt7898QewQy5HCDwE6qWgBGHUdqyJEUCbtB0Lvjcps5E1GPNspLJkRJ4dBiCyVaSdZoFuKlbSBWC/nRmdTZJiJEGUCf/fp6lr2VnpHEai7NxgNLwO+uBH+DF3elh+w12SegBfu9JukFZGbXNtGb9bZkylYuP72fh4r9QnOgYsV2pdJY7rxyxWbPU1NozWkYW70gJcKCsH0+5g0vDAqQvGiIm3pKqhcsPeaTpXN8lWhfPmiQlZ6HNr98im5af+1lw7JvGeCqNd2CSE9t4PGxN//w44bMjauvozepVRUczkVamjfLRmvzGGQrQHPcLilHEB+T0vgP31wIDAQABozgwNjALBgNVHQ8EBAMCAYYwEwYDVR0lBAwwCgYIKwYBBQUHAwkwEgYDVR0TAQH/BAgwBgEB/wIBADANBgkqhkiG9w0BAQUFAAOCAgEAQkNdHQNSYrpFMGd7A4FUVHIiRL5stF5Znillozu2RCgSvUnZjX/3qJFcG6Go2jbOQukXc/Be1AbwcUYr+EEd6LjgWzEUuq+GcLnm6pj6eaoqinNVQ7RvivVCxRGsEBEBxib+YR6AeeCucP+FSl9Enri5zYBmmVBxB6R85S5CPaZ793OXXuJLS9qzX1ecwkEqiYt+8u6SxPXXeYQgh1libdsU9AHpaY86XDJQQLww/+iXk9H/iNo7leFKOQAJcfHiBwcLF5hZwQAzdnjUChThNGJI4S03dQFI4ii1pV5YRM/5O+S0M/ZQxr27OZKrKMiHMNQ5X3WEoJLtv1A60yYw1rrA0itMeiameqWNVtjTaJBNbO1A47lZTfi0DZC3s5HGi9Vs8QAur+tQtHICbPkxq5FThM95m05RhSJyyo1qzwRD7eU7/P+KZ2WmkMeROwmKhJw6Pvsmi2vQlUleDQnjxAMVzyTF5fIGllsaZAV9rY+jZxmu6VHS4yo4sBx00w9rIyIoMjR9wSVUpzZfCJkgeOsfu09KaN5vr1seW7xvaKOKTZqTY1kzZMZ9wah+SMCWokKS6qboXeOJ6ERmcDRBOq2I+slCkaaCP/apcNZFGP7YH9WcTZhb767IBZaPVdrjFVYoABbufyvs8HcHqfv7mcAtvUFnaf5Yi5S98KJhqc0="
not_before
string
- Example
- "2023-06-05T12:31:36Z"
not_after
string
- Example
- "2028-06-03T12:31:36Z"
id
string
required
CA id
Response
Successful response, returns the root certificate as a download object
"string"
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
string
- Content Type
- application/json
Bad request
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Resource not found
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Invalid media type
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Internal server error
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
error_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing an error
details
array[]
An array of errors describing error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing an error
details
array[]
An array of errors describing error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing an error
details
array[]
An array of errors describing error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing an error
details
array[]
An array of errors describing error in more detail
reference (error)
recursiveid
string
required
CA id
Response
Successful response, returns the certificate revocation list as a download object
"string"
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
string
- Content Type
- application/json
Bad request
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Resource not found
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Internal server error
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
error_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing an error
details
array[]
An array of errors describing error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing an error
details
array[]
An array of errors describing error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing an error
details
array[]
An array of errors describing error in more detail
reference (error)
recursiveid
string
required
Access group ID
Authorization
string
required
OAuth2 token
- Default
- "Bearer a-proper-token-goes-here"
oauth
Required Scopes:
admin
access-groups-manage
Renew CA key
All Scopes
-
access-groups-manage
· User with "access-groups-manage" -
admin
· Admin scope - used for built-in SSH PrivX admin account -
api-clients-manage
· User with "api-clients-manage" permission -
certificates-view
· User with "certificates-view" -
hosts-manage
· User with "hosts-manage" permission -
service
· Microservice scope - used for communication between SSH PrivX microservices -
user
· Normal users
- Flow Type:
- authorization_code
- Auth URL:
- https://api.x.com/v1/auth/auth
- Token URL:
- https://api.x.com/v1/auth/auth
Response
Successful request, respond with the new CA key ID
"5bf77342-221c-11ee-be56-0242ac120002"
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Bad request
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Unauthorized request, OAuth2 authorization missing or invalid
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Unauthorized request, OAuth2 authorization OK but scope insufficient
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Resource not found
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Internal server error
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
string
uuid
CA key ID
- Content Type
- application/json
error_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing an error
details
array[]
An array of errors describing error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing an error
details
array[]
An array of errors describing error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing an error
details
array[]
An array of errors describing error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing an error
details
array[]
An array of errors describing error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing an error
details
array[]
An array of errors describing error in more detail
reference (error)
recursiveid
string
required
Access group ID
ca_id
string
required
CA key ID
Authorization
string
required
OAuth2 token
- Default
- "Bearer a-proper-token-goes-here"
oauth
Required Scopes:
admin
access-groups-manage
Revoke CA key
All Scopes
-
access-groups-manage
· User with "access-groups-manage" -
admin
· Admin scope - used for built-in SSH PrivX admin account -
api-clients-manage
· User with "api-clients-manage" permission -
certificates-view
· User with "certificates-view" -
hosts-manage
· User with "hosts-manage" permission -
service
· Microservice scope - used for communication between SSH PrivX microservices -
user
· Normal users
- Flow Type:
- authorization_code
- Auth URL:
- https://api.x.com/v1/auth/auth
- Token URL:
- https://api.x.com/v1/auth/auth
Response
Successful request
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Bad request
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Unauthorized request, OAuth2 authorization missing or invalid
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Unauthorized request, OAuth2 authorization OK but scope insufficient
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Resource not found
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
Internal server error
{
"error_code": "GENERAL_ERROR",
"error_message": "string",
"property": "string",
"details": [
null
]
}
error_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing an error
details
array[]
An array of errors describing error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing an error
details
array[]
An array of errors describing error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing an error
details
array[]
An array of errors describing error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing an error
details
array[]
An array of errors describing error in more detail
reference (error)
recursiveerror_code
string
required
Standard error code denoting the error type
- Enum
-
- GENERAL_ERROR
- BAD_REQUEST
- PERMISSION_DENIED
- INVALID_REQUEST_DATA
- REQUIRED_VALUE_MISSING
- VALUE_OUT_OF_BOUNDS
- VALUE_INCORRECT_TYPE
- VALUE_INCORRECT_FORMAT
- VALUE_DUPLICATE
- CONFIGURATION_ERROR
- OUT_OF_RESOURCES
- MAX_LOAD
- TOO_MANY_CONNECTIONS
- DATABASE_ERROR
- CACHE_ERROR
- INTRA_SERVICE_COMMUNICATION_ERROR
error_message
string
Textual, human readable error message
property
string
The property name causing an error
details
array[]
An array of errors describing error in more detail
reference (error)
recursiveWas this page helpful?