kb
Grant a permission on an item.
Grant a permission on an item.
OpenAPI specificationPOST
/api/v1/kb/shareAuthentication
bearerAuth
Request
curl --globoff --request POST \
--url 'https://honen.com/api/v1/kb/share' \
--header 'Authorization: Bearer <BEARER_TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
"itemId": "<itemId>",
"principalType": "WORKSPACE",
"role": "VIEWER"
}'Replace credential and <field> placeholders with your own values. URL placeholders appear as %3Cfield%3E. Review the example values before sending your request.
Use the sample JSON body as your starting point, and enter values that match the endpoint's schema.
Parameters
Idempotency-Keyheader · stringUnique retry key. Reusing it with the same body replays the original successful response; different input returns 409.
Request body schema or example
{
"type": "object",
"properties": {
"itemId": {
"type": "string"
},
"principalType": {
"type": "string",
"enum": [
"WORKSPACE",
"GROUP",
"USER",
"API_KEY"
]
},
"role": {
"type": "string",
"enum": [
"VIEWER",
"EDITOR",
"MAINTAINER",
"ADMIN"
]
},
"userId": {
"type": "string"
},
"groupId": {
"type": "string"
},
"integrationKeyId": {
"type": "string"
}
},
"required": [
"itemId",
"principalType",
"role"
]
}Responses
200Command result.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
true
]
},
"data": {
"type": "object",
"properties": {
"grant": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"userId": {
"type": "string",
"nullable": true
},
"workspaceId": {
"type": "string"
},
"groupId": {
"type": "string",
"nullable": true
},
"itemId": {
"type": "string"
},
"principalType": {
"type": "string",
"enum": [
"WORKSPACE",
"GROUP",
"USER",
"API_KEY"
]
},
"role": {
"type": "string",
"enum": [
"ADMIN",
"VIEWER",
"EDITOR",
"MAINTAINER"
]
},
"integrationKeyId": {
"type": "string",
"nullable": true
},
"grantedById": {
"type": "string",
"nullable": true
}
},
"required": [
"id",
"createdAt",
"updatedAt",
"userId",
"workspaceId",
"groupId",
"itemId",
"principalType",
"role",
"integrationKeyId",
"grantedById"
]
},
"url": {
"type": "string"
},
"href": {
"type": "string"
},
"dashboardUrl": {
"type": "string"
},
"itemId": {
"type": "string"
}
},
"required": [
"grant",
"url",
"href",
"dashboardUrl",
"itemId"
]
}
},
"required": [
"success",
"data"
]
}400Malformed JSON request body.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
false
]
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"resolution": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"details": {
"nullable": true
}
},
"required": [
"code",
"message",
"resolution"
]
}
},
"required": [
"success",
"error"
]
}401Missing or invalid Connector credentials.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
false
]
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"resolution": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"details": {
"nullable": true
}
},
"required": [
"code",
"message",
"resolution"
]
}
},
"required": [
"success",
"error"
]
}403Connector policy does not permit this command.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
false
]
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"resolution": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"details": {
"nullable": true
}
},
"required": [
"code",
"message",
"resolution"
]
}
},
"required": [
"success",
"error"
]
}404Unknown command.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
false
]
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"resolution": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"details": {
"nullable": true
}
},
"required": [
"code",
"message",
"resolution"
]
}
},
"required": [
"success",
"error"
]
}409Idempotency key is reused, in progress, or belongs to a failed request.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
false
]
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"resolution": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"details": {
"nullable": true
}
},
"required": [
"code",
"message",
"resolution"
]
}
},
"required": [
"success",
"error"
]
}422Input validation error.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
false
]
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"resolution": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"details": {
"nullable": true
}
},
"required": [
"code",
"message",
"resolution"
]
}
},
"required": [
"success",
"error"
]
}