For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Update an application’s details, roles, or direct permissions and synchronize its authorization with the identity provider.
Required permissions: permission:update.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
application_idstringRequired
The ID of the application.
Headers
X-Penny-As-Businessstring or nullOptional
Act on behalf of another business that has granted you access. Requires the business:act_as permission.
Request
This endpoint expects an object.
namestring or nullOptional1-100 characters
A replacement application name.
descriptionstring or nullOptional1-500 characters
A replacement explanation of the application's purpose.
role_idslist of strings or nullOptional
The complete replacement set of custom or preset role IDs. Send an empty set to remove all roles.
permissionslist of objects or nullOptional
The complete replacement set of direct permissions. Send an empty set to remove all directly assigned permissions. Every permission is scoped to your business; scope, sub-type, and resource-ID restrictions are not client-configurable.
Response
The updated machine application.
application_idstring
Penny's unique identifier for this application.
versioninteger
A number that increases each time this application's details change. Use it to confirm you are looking at the latest information.
version_timedatetime
The date and time this application's details were last changed.
namestring
A human-readable name for this application.
descriptionstring
A human-readable description of what this application does.
statusenum
This application’s current lifecycle status: ‘active’, ‘deactivated’ (cannot authenticate), ‘suspended’ (restricted, typically pending review), or ‘deleted’.
Allowed values:
activeboolean
Whether this application is currently active.
deletedboolean
Whether this application has been removed.
business_idstring
The business this application belongs to.
roleslist of objects or nullOptional
The roles assigned to this application, if any.
typeenumOptionalDefaults to machine
The type of an application.
Allowed values:
permissionslist of objects or nullOptional
Permissions granted directly to this application, in addition to any granted through its roles.
client_idstring or nullOptional
The OAuth2 client ID this application uses to authenticate with Penny. Absent while the application is being provisioned or after it has been deprovisioned.
