Skip to navigation

Create software access app

View as Markdown

Creates a software access app and returns it with its server-assigned id and version.

Send the fields at the top level of the body. Don’t send id or version.num; version.change_description is required.

Authentication

AuthorizationBearer

JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.

Request

This endpoint expects an object.
namestringRequiredformat: "^[^/]+$"1-128 characters
Name of the app as users ask for it. Must be unique in the org and cannot be changed after creation.
versionobjectRequired
Document version. On update, send back the num from your last read.
in_assistant_enabledbooleanOptional

If true, users can request this app through the AI Assistant. Takes precedence over access_rule_dsl; use the access rule for more granular control.

access_rule_dslstringOptional
DSL rule deciding which users can request this app. Use 'true' to allow all users, 'false' to allow none, or a DSL expression.
admins_email_addrslist of stringsOptional

Email addresses of the app admins who can approve access. Required when the approval model includes app admin approval (APP_ADMIN, APP_ADMIN_THEN_MANAGER, or AUTO_APPROVE_FULL_TIME_ELSE_APP_ADMIN).

role_based_provisioningobjectOptional

Role-based provisioning: the user picks one of two or more roles (licenses, environments, versions) provisioned through your identity system. Set exactly one provisioning strategy.

group_based_provisioningobjectOptional

Group-based provisioning: membership in a single group grants access. Set exactly one provisioning strategy.

self_service_provisioningobjectOptional

Self-service provisioning: no automated provisioning; the user is shown instructions to get the app themselves. Set exactly one provisioning strategy.

Response

The created software access app
idstringOptionalRead-only
Unique identifier of the app, assigned by the server.
namestringOptionalformat: "^[^/]+$"1-128 characters
Name of the app as users ask for it. Must be unique in the org and cannot be changed after creation.
in_assistant_enabledbooleanOptional

If true, users can request this app through the AI Assistant. Takes precedence over access_rule_dsl; use the access rule for more granular control.

access_rule_dslstringOptional
DSL rule deciding which users can request this app. Use 'true' to allow all users, 'false' to allow none, or a DSL expression.
admins_email_addrslist of stringsOptional

Email addresses of the app admins who can approve access. Required when the approval model includes app admin approval (APP_ADMIN, APP_ADMIN_THEN_MANAGER, or AUTO_APPROVE_FULL_TIME_ELSE_APP_ADMIN).

role_based_provisioningobjectOptional

Role-based provisioning: the user picks one of two or more roles (licenses, environments, versions) provisioned through your identity system. Set exactly one provisioning strategy.

group_based_provisioningobjectOptional

Group-based provisioning: membership in a single group grants access. Set exactly one provisioning strategy.

self_service_provisioningobjectOptional

Self-service provisioning: no automated provisioning; the user is shown instructions to get the app themselves. Set exactly one provisioning strategy.

updated_timedatetimeOptionalRead-only
When the configuration was last updated.
updated_bystringOptionalRead-only
Who last updated the configuration.
versionobjectOptional
Document version. On update, send back the num from your last read.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error