Documentation Index

Fetch the complete documentation index at: https://docs.britive.com/llms.txt

Use this file to discover all available pages before exploring further.

Britive platform release 2026.07.01 is now live in production.

Checkout profile for a device

Prev Next
Post
/api/access/{profileId}/devices/{deviceId}

Checkout a profile for a specific device. Use accessType=DEVICE to elevate privileges on the device.

Security
HTTP
Type bearer
Path parameters
profileId
stringRequired

Profile (PAP) ID to checkout

deviceId
stringRequired

Device ID within the application

Query parameters
accessType
string

Type of access to checkout. DEVICE elevates privileges of the device. This is the only supported type.

Valid values[ "DEVICE" ]
Default"DEVICE"
Body parameters

Optional ITSM ticket details for approval-gated profiles

{
  "justification": "Access required for incident response",
  "ticketId": "INC0001234",
  "ticketType": "INCIDENT",
  "userOnCall": false
}
Expand All
object
justification
string
ticketId
string
ticketType
string
userOnCall
boolean
Defaultfalse
checkoutVariableValues
object

Per-checkout map of variableName -> value for every variable on the resolved profile-permission flagged with promptAtCheckout=true. UI populates from ResourceProfileSettings.checkoutVariablePrompts returned by GET /api/resource-manager/my-resources//resources//settings. Server validates each supplied value against the variable's regexPattern when one is configured (any type); values for variables without a pattern are taken literally. Missing/blank for a required variable produces 400 RM-0024; regex validation failure produces 400 RM-0025; entries for variables not flagged promptAtCheckout are silently ignored.

property*
string additionalProperties
Responses
200

Checkout initiated successfully. Poll status until checkedOut.

object

Status of a profile checkout or check-in operation

transactionId
string

Unique transaction identifier; required for getTokens, getConsoleUrl, and check-in calls

Exampletxn_abc123
papId
string

Profile (PAP) string identifier

Examplepap_xyz456
appContainerId
string

Application container identifier

Exampleapp_123
environmentId
string

Environment identifier

Exampleenv_789
userId
string

User identifier (string form)

Exampleuser_001
status
string

Current lifecycle status of the checkout operation

Valid values[ "checkedOut", "checkedIn", "checkedInExpired", "checkOutSubmitted", "checkOutInProgress", "checkOutFailed", "checkInSubmitted", "checkInInProgress", "checkInFailed", "checkOutTimeOut", "checkInTimeOut" ]
ExamplecheckedOut
statusText
string

Human-readable label for status

ExampleChecked Out
accessType
string
Valid values[ "CLI", "CONSOLE", "PROGRAMMATIC" ]
ExampleCONSOLE
checkedOut
string (date-time)

Timestamp when the profile was checked out

checkedIn
string (date-time) | null

Timestamp when the profile was checked in; null if still active

expiration
string (date-time)

Timestamp when the session expires automatically

currentExtensionIndex
integer

Number of times the session has been extended

Example0
policyConditionEndTime
string (date-time) | null

End time derived from policy time conditions, if applicable

errorMessage
string | null

Error details if the checkout or check-in operation failed

403

Access denied or profile policy conditions not met

404

Profile or environment not found