Access

Principals, groups, roles, and role bindings.

Operations

Each operation lists its specific responses. See Common error responses for errors shared by every operation on this page.

Approve or deny CLI device authorization

POST /api/v1/access/device-authorizations/approval

Operation ID: decideDeviceAuthorization
Effect: write
Confirmation: conditional
Focused reference: JSON · Markdown

Parameters

Request body

Content types: application/json.

Responses

List groups

GET /api/v1/groups

Operation ID: listGroups
Effect: read
Confirmation: never
Focused reference: JSON · Markdown

Parameters

Responses

Create a group

POST /api/v1/groups

Operation ID: createGroup
Effect: write
Confirmation: conditional
Focused reference: JSON · Markdown

Parameters

Request body

Content types: application/json.

Responses

Delete a group

DELETE /api/v1/groups/{group}

Operation ID: deleteGroup
Effect: destructive
Confirmation: required
Focused reference: JSON · Markdown

Parameters

Responses

Get a group

GET /api/v1/groups/{group}

Operation ID: getGroup
Effect: read
Confirmation: never
Focused reference: JSON · Markdown

Parameters

Responses

Update a group

PATCH /api/v1/groups/{group}

Operation ID: updateGroup
Effect: write
Confirmation: conditional
Focused reference: JSON · Markdown

Parameters

Request body

Content types: application/json.

Responses

List group members

GET /api/v1/groups/{group}/members

Operation ID: listGroupMembers
Effect: read
Confirmation: never
Focused reference: JSON · Markdown

Parameters

Responses

Remove a group member

DELETE /api/v1/groups/{group}/members/{principal}

Operation ID: removeGroupMember
Effect: destructive
Confirmation: required
Focused reference: JSON · Markdown

Parameters

Responses

Add a group member

PUT /api/v1/groups/{group}/members/{principal}

Operation ID: addGroupMember
Effect: idempotent-write
Confirmation: conditional
Focused reference: JSON · Markdown

Parameters

Responses

GET /api/v1/groups/{group}/semantic-attributes

GET /api/v1/groups/{group}/semantic-attributes

Operation ID: listGroupSemanticAttributeAssignments
Effect: read
Confirmation: never
Focused reference: JSON · Markdown

Parameters

Responses

DELETE /api/v1/groups/{group}/semantic-attributes/{attribute}

DELETE /api/v1/groups/{group}/semantic-attributes/{attribute}

Operation ID: removeGroupSemanticAttributeAssignment
Effect: destructive
Confirmation: required
Focused reference: JSON · Markdown

Parameters

Responses

PUT /api/v1/groups/{group}/semantic-attributes/{attribute}

PUT /api/v1/groups/{group}/semantic-attributes/{attribute}

Operation ID: upsertGroupSemanticAttributeAssignment
Effect: idempotent-write
Confirmation: conditional
Focused reference: JSON · Markdown

Parameters

Request body

Content types: application/json.

Responses

List principals

GET /api/v1/principals

Operation ID: listPrincipals
Effect: read
Confirmation: never
Focused reference: JSON · Markdown

Parameters

Responses

Create a local principal

POST /api/v1/principals

Operation ID: createPrincipal
Effect: write
Confirmation: conditional
Focused reference: JSON · Markdown

Parameters

Request body

Content types: application/json.

Responses

Delete a principal

DELETE /api/v1/principals/{principal}

Operation ID: deletePrincipal
Effect: destructive
Confirmation: required
Focused reference: JSON · Markdown

Parameters

Responses

Get a principal

GET /api/v1/principals/{principal}

Operation ID: getPrincipal
Effect: read
Confirmation: never
Focused reference: JSON · Markdown

Parameters

Responses

Update a principal

PATCH /api/v1/principals/{principal}

Operation ID: updatePrincipal
Effect: write
Confirmation: conditional
Focused reference: JSON · Markdown

Parameters

Request body

Content types: application/json.

Responses

Block a principal in LeapView and reject its credentials

POST /api/v1/principals/{principal}/disable

Sets an independent LeapView administrator block. External provisioning cannot clear this block.

Operation ID: disablePrincipal
Effect: write
Confirmation: conditional
Focused reference: JSON · Markdown

Parameters

Responses

Remove a principal's LeapView administrator block

POST /api/v1/principals/{principal}/enable

Clears only the LeapView administrator block. An externally disabled principal remains disabled.

Operation ID: enablePrincipal
Effect: write
Confirmation: conditional
Focused reference: JSON · Markdown

Parameters

Responses

Reset a local principal password

POST /api/v1/principals/{principal}/password-reset

Operation ID: resetPrincipalPassword
Effect: write
Confirmation: conditional
Focused reference: JSON · Markdown

Parameters

Responses

GET /api/v1/principals/{principal}/semantic-attributes

GET /api/v1/principals/{principal}/semantic-attributes

Operation ID: listPrincipalSemanticAttributeAssignments
Effect: read
Confirmation: never
Focused reference: JSON · Markdown

Parameters

Responses

DELETE /api/v1/principals/{principal}/semantic-attributes/{attribute}

DELETE /api/v1/principals/{principal}/semantic-attributes/{attribute}

Operation ID: removePrincipalSemanticAttributeAssignment
Effect: destructive
Confirmation: required
Focused reference: JSON · Markdown

Parameters

Responses

PUT /api/v1/principals/{principal}/semantic-attributes/{attribute}

PUT /api/v1/principals/{principal}/semantic-attributes/{attribute}

Operation ID: upsertPrincipalSemanticAttributeAssignment
Effect: idempotent-write
Confirmation: conditional
Focused reference: JSON · Markdown

Parameters

Request body

Content types: application/json.

Responses

List a principal's sessions

GET /api/v1/principals/{principal}/sessions

Operation ID: listPrincipalSessions
Effect: read
Confirmation: never
Focused reference: JSON · Markdown

Parameters

Responses

Revoke a principal's session

DELETE /api/v1/principals/{principal}/sessions/{session}

Operation ID: revokePrincipalSession
Effect: destructive
Confirmation: required
Focused reference: JSON · Markdown

Parameters

Responses

Check multiple authorization decisions

POST /api/v1/projects/{project}/authorization-checks

Operation ID: checkAuthorizationBatch
Effect: write
Confirmation: conditional
Focused reference: JSON · Markdown

Parameters

Request body

Content types: application/json.

Responses

List effective capabilities

GET /api/v1/projects/{project}/effective-capabilities

Operation ID: listEffectiveCapabilities
Effect: read
Confirmation: never
Required privilege: PROJECT_ADMIN
Focused reference: JSON · Markdown

Parameters

Responses

List grants

GET /api/v1/projects/{project}/grants

Operation ID: listGrants
Effect: read
Confirmation: never
Required privilege: PROJECT_ADMIN
Focused reference: JSON · Markdown

Parameters

Responses

Create a grant

POST /api/v1/projects/{project}/grants

Operation ID: createGrant
Effect: write
Confirmation: conditional
Required privilege: PROJECT_ADMIN
Focused reference: JSON · Markdown

Parameters

Request body

Content types: application/json.

Responses

Delete a grant

DELETE /api/v1/projects/{project}/grants/{grant}

Operation ID: deleteGrant
Effect: destructive
Confirmation: required
Required privilege: PROJECT_ADMIN
Focused reference: JSON · Markdown

Parameters

Responses

Get a resource capability grant

GET /api/v1/projects/{project}/grants/{grant}

Operation ID: getGrant
Effect: read
Confirmation: never
Required privilege: PROJECT_ADMIN
Focused reference: JSON · Markdown

Parameters

Responses

Update a resource capability grant

PATCH /api/v1/projects/{project}/grants/{grant}

Operation ID: updateGrant
Effect: write
Confirmation: conditional
Required privilege: PROJECT_ADMIN
Focused reference: JSON · Markdown

Parameters

Request body

Content types: application/json.

Responses

List project roles

GET /api/v1/projects/{project}/roles

Operation ID: listProjectRoles
Effect: read
Confirmation: never
Required privilege: PROJECT_ADMIN
Focused reference: JSON · Markdown

Parameters

Responses

GET /api/v1/semantic-attributes

GET /api/v1/semantic-attributes

Operation ID: listSemanticAttributeDefinitions
Effect: read
Confirmation: never
Focused reference: JSON · Markdown

Parameters

Responses

POST /api/v1/semantic-attributes

POST /api/v1/semantic-attributes

Operation ID: registerSemanticAttribute
Effect: write
Confirmation: conditional
Focused reference: JSON · Markdown

Parameters

Request body

Content types: application/json.

Responses

GET /api/v1/semantic-attributes/{attribute}

GET /api/v1/semantic-attributes/{attribute}

Operation ID: getSemanticAttributeDefinition
Effect: read
Confirmation: never
Focused reference: JSON · Markdown

Parameters

Responses

PATCH /api/v1/semantic-attributes/{attribute}

PATCH /api/v1/semantic-attributes/{attribute}

Operation ID: updateSemanticAttributeMetadata
Effect: write
Confirmation: conditional
Focused reference: JSON · Markdown

Parameters

Request body

Content types: application/json.

Responses

GET /api/v1/semantic-attributes/{attribute}/claim-mappings

GET /api/v1/semantic-attributes/{attribute}/claim-mappings

Operation ID: listSemanticAttributeClaimMappings
Effect: read
Confirmation: never
Focused reference: JSON · Markdown

Parameters

Responses

POST /api/v1/semantic-attributes/{attribute}/claim-mappings

POST /api/v1/semantic-attributes/{attribute}/claim-mappings

Operation ID: upsertSemanticAttributeClaimMapping
Effect: write
Confirmation: conditional
Focused reference: JSON · Markdown

Parameters

Request body

Content types: application/json.

Responses

DELETE /api/v1/semantic-attributes/{attribute}/claim-mappings/{mapping}

DELETE /api/v1/semantic-attributes/{attribute}/claim-mappings/{mapping}

Operation ID: removeSemanticAttributeClaimMapping
Effect: destructive
Confirmation: required
Focused reference: JSON · Markdown

Parameters

Responses

POST /api/v1/semantic-attributes/{attribute}/disable

POST /api/v1/semantic-attributes/{attribute}/disable

Operation ID: disableSemanticAttribute
Effect: write
Confirmation: conditional
Focused reference: JSON · Markdown

Parameters

Responses

Preview semantic attribute assignment impact

POST /api/v1/semantic-attributes/{attribute}/impact-preview

Operation ID: previewSemanticAttributeImpact
Effect: write
Confirmation: conditional
Focused reference: JSON · Markdown

Parameters

Request body

Content types: application/json.

Responses

POST /api/v1/semantic-attributes/{attribute}/restore

POST /api/v1/semantic-attributes/{attribute}/restore

Operation ID: restoreSemanticAttribute
Effect: write
Confirmation: conditional
Focused reference: JSON · Markdown

Parameters

Responses

List service principals

GET /api/v1/service-principals

Operation ID: listServicePrincipals
Effect: read
Confirmation: never
Focused reference: JSON · Markdown

Parameters

Responses

Create a service principal

POST /api/v1/service-principals

Operation ID: createServicePrincipal
Effect: write
Confirmation: conditional
Focused reference: JSON · Markdown

Parameters

Request body

Content types: application/json.

Responses

Delete a service principal

DELETE /api/v1/service-principals/{servicePrincipal}

Operation ID: deleteServicePrincipal
Effect: destructive
Confirmation: required
Focused reference: JSON · Markdown

Parameters

Responses

Get a service principal

GET /api/v1/service-principals/{servicePrincipal}

Operation ID: getServicePrincipal
Effect: read
Confirmation: never
Focused reference: JSON · Markdown

Parameters

Responses

Update a service principal

PATCH /api/v1/service-principals/{servicePrincipal}

Operation ID: updateServicePrincipal
Effect: write
Confirmation: conditional
Focused reference: JSON · Markdown

Parameters

Request body

Content types: application/json.

Responses

List service-principal secrets

GET /api/v1/service-principals/{servicePrincipal}/secrets

Operation ID: listServicePrincipalSecrets
Effect: read
Confirmation: never
Focused reference: JSON · Markdown

Parameters

Responses

Create a service principal secret

POST /api/v1/service-principals/{servicePrincipal}/secrets

Operation ID: createServicePrincipalSecret
Effect: write
Confirmation: conditional
Focused reference: JSON · Markdown

Parameters

Request body

Content types: application/json.

Responses

Revoke a service principal secret

DELETE /api/v1/service-principals/{servicePrincipal}/secrets/{secret}

Operation ID: revokeServicePrincipalSecret
Effect: destructive
Confirmation: required
Focused reference: JSON · Markdown

Parameters

Responses

Get service-principal secret metadata

GET /api/v1/service-principals/{servicePrincipal}/secrets/{secret}

Operation ID: getServicePrincipalSecret
Effect: read
Confirmation: never
Focused reference: JSON · Markdown

Parameters

Responses

Common error responses

These error responses apply to every operation on this page.