Note

These endpoints are currently only available to institutions that are participating in the guest management beta program. If you are interested in joining the program, please contact us.

# Creating guest profiles

Warning

This endpoint is only available in a guest account context. Calling this endpoint with any other type of account will result in an error.

To create a guest profile under a specific guest account, use the following endpoint:

POST /api/guest-profile

The request body must include a JSON object with the following fields:

{
    "format": "string",
    "deviceType": "string"
}

The format field represents the format you'd like the API to return upon successful profile creation. Valid values are (case insensitive):

pkcs12
pfx
pem
crt

The allowAuth field says whether the profile should be allowed to authenticate with the API.
The deviceType field is the type of device the profile is for. Valid values are (case sensitive):

MacOS
iOS
iPadOS
Android
Windows
Linux
ChromeOS
Other

Depending on the format field, the reponse will vary slightly. On success the response will be the default API response with the data being a profile entity in the following format:

{
    "serial": "string",
    "deviceType": "string",
    "creationDate": "2023-12-15T15:30:52.768Z",
    "revokeDate": "2023-12-15T15:30:52.768Z" | null,
    "revokeReason": 0 | null,
    "lastOcsp": "2023-12-15T15:30:52.768Z" | null,
    "accountId": "string",
    "data": "string",
    "identity": "string",
    "radiusCN": "string"
}

The data field is the base64 encoded PKCS12 file with an empty password.

{
    "serial": "string",
    "deviceType": "string",
    "creationDate": "2023-12-15T15:30:52.768Z",
    "revokeDate": "2023-12-15T15:30:52.768Z" | null,
    "revokeReason": 0 | null,
    "lastOcsp": "2023-12-15T15:30:52.768Z" | null,
    "accountId": "string",
    "certificate": "string",
    "privateKey": "string",
    "identity": "string",
    "radiusCN": "string"
}