Get Partner
Note: This is a draft API and is subject to change.
Partners can get a k9 partner configuration using the k9 API with:
GET /partner/{partnerId}
Request Headers
Set the Content-Type header to application/json
Request Path Parameters
The partner configuration API requires one path parameter:
partnerId: the k9 Partner ID that manages customer cloud deployments, e.g. P123456. k9 Security will provide the Partner ID to the partner.
Type: String
Pattern: P[\d]{6}
Request Body
Not Applicable
Response
Success
When you successfully get a partner configuration, the API will respond with the details of the partner:
Response Status Code: 200 (Success)
Response Body (Example):
{
"partnerId": "P123456",
"configs": {
"key": "value"
},
"deliveryDestinations": {
"DeliverToS3": {
"bucketName": "bucket-F123ES"
}
}
}
See Configure Partner for definitions of the keys and objects in the response.
Not Authorized
If the calling principal is not authorized to get the partner configuration, the API will respond with:
Response Status Code: 403 (Forbidden)
Response Body (Example):
{
"message": "Caller is not authorized to get the partner configuration."
}