Favicon

You are here: Home > API Reference > Platform > Certificateprovider > Get certificateProvider by Id or Slug

Get certificateProvider by Id or Slug

Required Permission: base.organization.certificateProvider.get

Get certificateProvider by Id or Slug

GET
https://api.applivery.io/v1/organizations/{organizationId}/certificate-providers/{certificateProviderId} 
curl -X GET "https://api.applivery.io/v1/organizations/{organizationId}/certificate-providers/{certificateProviderId}" \
  -H "Authorization: Bearer <YOUR_API_KEY>"
const response = await fetch("https://api.applivery.io/v1/organizations/{organizationId}/certificate-providers/{certificateProviderId}", {
  method: "GET",
  headers: {
    Authorization: "Bearer <YOUR_API_KEY>",
  },
});

const data = await response.json();
import requests

response = requests.get(
    "https://api.applivery.io/v1/organizations/{organizationId}/certificate-providers/{certificateProviderId}",
    headers={"Authorization": "Bearer <YOUR_API_KEY>"},
)

data = response.json()

Request

Send your API key in the request header authorization
Example: Authorization: Bearer <token>

organizationId string
required
Match pattern: ^[a-fA-F0-9]{24}$
certificateProviderId string
required
Match pattern: ^[a-fA-F0-9]{24}$

Responses

200 Response application/json
status boolean required
data object required
id string required
Match pattern: ^[a-fA-F0-9]{24}$
name string required
≤ 128 characters
description string optional
≤ 256 characters
connectorToken string required
≤ 256 characters
config object required
type string required
scep
name string optional
serverUrl string required
subject string optional
keySize string optional
1024 2048 4096
keyType string optional
keyUsage string optional
encryption signing both
CAFingerprint string optional
retries number optional
≥ 0 · ≤ 10
retryDelay number optional
≥ 0 · ≤ 864000
keyIsExtractable boolean optional
allowAllAppsAccess boolean optional
subjectAltName object optional
challenge object required
reports array [object] required
type string required
value string required
createdAt string required
counts object required
challenges number optional
version integer required
≥ 0 · ≤ 9007199254740991
updatedAt string required
createdAt string required
segmentId integer optional
≥ 0 · ≤ 9007199254740991
{
    "status": true,
    "data": {
        "id": "string",
        "name": "string",
        "description": "string",
        "connectorToken": "string",
        "config": {
            "type": "scep",
            "name": "string",
            "serverUrl": "string",
            "subject": "string",
            "keySize": "1024",
            "keyType": "string",
            "keyUsage": "encryption",
            "CAFingerprint": "string",
            "retries": 0,
            "retryDelay": 0,
            "keyIsExtractable": true,
            "allowAllAppsAccess": true,
            "subjectAltName": {
                "rfc822Name": [
                    "string"
                ],
                "dNSName": [
                    "string"
                ],
                "uniformResourceIdentifier": [
                    "string"
                ],
                "ntPrincipalName": "string"
            },
            "challenge": {
                "type": "ndes",
                "url": "string",
                "username": "string",
                "password": "string",
                "numChallenges": 0,
                "expirationPercentage": 0,
                "auth": "basic"
            }
        },
        "reports": [
            {
                "type": "string",
                "value": "string",
                "createdAt": "string"
            }
        ],
        "counts": {
            "challenges": 0
        },
        "version": 0,
        "updatedAt": "string",
        "createdAt": "string",
        "segmentId": 0
    }
}
401 Response application/json
status boolean optional
false
error object optional
code number optional
4001
message string optional
Unauthorized
{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
404 Response application/json
status boolean optional
false
error object optional
code number optional
3001
message string optional
Entity not found
{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}