COconductorone
AppAccessRequestDefaults

Create App Access Requests Defaults

Changed on

Create or replace the access request default settings for an app.

post/api/v1/apps/{app_id}/access_request_defaults

Request

  • Base URL
    https://example.conductor.one
  • URL
    https://example.conductor.one/api/v1/apps/{app_id}/access_request_defaults
  • Auth
    HTTP bearer and OAuth 2
    Client credentials
    Token URL: /auth/v1/token

Path parameters

app_idstring required

The app id for the app access request rule

Request body

catalogIdsstring[] nullable

The request catalog ids for the app access request rule.

catalogMode'APP_ACCESS_REQUEST_DEFAULTS_CATALOG_MODE_UNSPECIFIED' | 'APP_ACCESS_REQUEST_DEFAULTS_CATALOG_MODE_MANAGED' | 'APP_ACCESS_REQUEST_DEFAULTS_CATALOG_MODE_UNMANAGED'

How the apply pass treats catalog (access profile) bindings on matched entitlements. UNSPECIFIED reads as legacy list management; UNMANAGED means the rule does not manage the list and only the app's default request catalog follows the self-service switch.

defaultsEnabledboolean

If true the app level request configuration will be applied to specified resource types.

durationGrantstring duration nullable
durationUnsetobject nullable
emergencyGrantEnabledboolean

If emergency grants are enabled for this app access request rule.

emergencyGrantPolicyIdstring

The policy id for the emergency grant policy.

requestPolicyIdstring

The ID of the request policy to apply to entitlements matching this rule.

requestSchemaIdstring

The ID of the request schema to apply to entitlements matching this rule.

resourceTypeIdsstring[] nullable

The app resource type ids for which the app access request defaults are applied.

state'APP_ACCESS_REQUEST_DEFAULTS_LAST_APPLY_STATE_UNSPECIFIED' | 'APP_ACCESS_REQUEST_DEFAULTS_LAST_APPLY_STATE_RUNNING' | 'APP_ACCESS_REQUEST_DEFAULTS_LAST_APPLY_STATE_SUCCESS' | 'APP_ACCESS_REQUEST_DEFAULTS_LAST_APPLY_STATE_FAILED' | 'APP_ACCESS_REQUEST_DEFAULTS_LAST_APPLY_STATE_CANCELING' | 'APP_ACCESS_REQUEST_DEFAULTS_LAST_APPLY_STATE_CANCEL_SUCCESS' | 'APP_ACCESS_REQUEST_DEFAULTS_LAST_APPLY_STATE_CANCEL_ERROR'

The last applied state of the app access request defaults.

Response

Successful response

appIdstring

The app id for the app access request rule

catalogIdsstring[] nullable

The request catalog ids for the app access request rule.

catalogMode'APP_ACCESS_REQUEST_DEFAULTS_CATALOG_MODE_UNSPECIFIED' | 'APP_ACCESS_REQUEST_DEFAULTS_CATALOG_MODE_MANAGED' | 'APP_ACCESS_REQUEST_DEFAULTS_CATALOG_MODE_UNMANAGED'

How the apply pass treats catalog (access profile) bindings on matched entitlements. UNSPECIFIED reads as legacy list management; UNMANAGED means the rule does not manage the list and only the app's default request catalog follows the self-service switch.

defaultsEnabledboolean

If true the app level request configuration will be applied to specified resource types.

durationGrantstring duration nullable
durationUnsetobject nullable
emergencyGrantEnabledboolean

If emergency grants are enabled for this app access request rule.

emergencyGrantPolicyIdstring

The policy id for the emergency grant policy.

requestPolicyIdstring

The ID of the request policy to apply to entitlements matching this rule.

requestSchemaIdstring

The ID of the request schema to apply to entitlements matching this rule.

resourceTypeIdsstring[] nullable

The app resource type ids for which the app access request defaults are applied.

state'APP_ACCESS_REQUEST_DEFAULTS_LAST_APPLY_STATE_UNSPECIFIED' | 'APP_ACCESS_REQUEST_DEFAULTS_LAST_APPLY_STATE_RUNNING' | 'APP_ACCESS_REQUEST_DEFAULTS_LAST_APPLY_STATE_SUCCESS' | 'APP_ACCESS_REQUEST_DEFAULTS_LAST_APPLY_STATE_FAILED' | 'APP_ACCESS_REQUEST_DEFAULTS_LAST_APPLY_STATE_CANCELING' | 'APP_ACCESS_REQUEST_DEFAULTS_LAST_APPLY_STATE_CANCEL_SUCCESS' | 'APP_ACCESS_REQUEST_DEFAULTS_LAST_APPLY_STATE_CANCEL_ERROR'

The last applied state of the app access request defaults.

Changes

  • fe943bedf41bRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

  • f2cf3228f366Revision changes
    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the response property became nullable for the status

    • info

      the request property became nullable