Skip to main content
objectApp

Fields

_id
String

Unique app identifier.

isEnabled
Boolean

Whether the app can authenticate API requests. Must be false before appsRemove succeeds.

createdAt
Date

When this credential was created.

lastUsedAt
Date

Timestamp of the last successful authentication with this token. null if the token has never been used — useful when rotating idle credentials.

name
String

Display name in the Developer dashboard and apps search.

userGroupId
String

User group that defines this app's permissions. Empty when allowAllPermission is true. Locked after creation — mint a new app with appsAdd to change scope.

workspaceId
String

Workspace this app belongs to (multi-workspace tenants). Usually inherited from the authenticated context.

expireDate
Date

JWT expiry when noExpire is false. Ignored when noExpire is true.

allowAllPermission
Boolean

When true, the app inherits full workspace permissions (owner-like). Prefer a least-privilege user group via userGroupId for production. Locked after creation.

noExpire
Boolean

When true, the JWT does not expire (still revoke with appsRemove). When false, set expireDate.

accessToken
String

Masked hint for identification: **** + last 4 characters (e.g. ****a1b2). Not a usable JWT — capture the full token only from appsAdd → AppTokenResult.accessToken.

userGroupName
String

Resolved display name for userGroupId. Falls back to a full-access label when allow-all.

آخر تعديل في ١١ أغسطس ٢٠٢٦