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.

Check in profile for a device

Prev Next
Put
/api/access/devices/{transactionId}

Check in a previously checked-out profile session. The transactionId is returned by the checkout call. Terminates the active session and revokes any issued credentials.

Security
HTTP
Type bearer
Path parameters
transactionId
stringRequired

Transaction ID returned by the checkout call

Responses
200

Check-in completed successfully

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

404

Transaction not found