Skip to main content

Create Provisioning Policy

POST 

/sources/:sourceId/provisioning-policies

This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to Transforms in Provisioning Policies for more information.

Request

Path Parameters

    sourceId stringrequired

    The Source id

    Example: 2c9180835d191a86015d28455b4a2329

Body

required

    name stringrequired

    the provisioning policy name

    description string

    the description of the provisioning policy

    usageType UsageType (string)

    Possible values: [CREATE, UPDATE, ENABLE, DISABLE, DELETE, ASSIGN, UNASSIGN, CREATE_GROUP, UPDATE_GROUP, DELETE_GROUP, REGISTER, CREATE_IDENTITY, UPDATE_IDENTITY, EDIT_GROUP, UNLOCK, CHANGE_PASSWORD]

    The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source.
    UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.

    fields

    object[]

  • Array [

  • name string

    The name of the attribute.

    transform object

    Default value: [object Object]

    The transform to apply to the field

    attributes object

    Attributes required for the transform

    type string

    The type of the attribute.

    isMultiValued boolean

    Flag indicating whether or not the attribute is multi-valued.

  • ]

Responses

Created ProvisioningPolicyDto object

Schema

    name stringrequired

    the provisioning policy name

    description string

    the description of the provisioning policy

    usageType UsageType (string)

    Possible values: [CREATE, UPDATE, ENABLE, DISABLE, DELETE, ASSIGN, UNASSIGN, CREATE_GROUP, UPDATE_GROUP, DELETE_GROUP, REGISTER, CREATE_IDENTITY, UPDATE_IDENTITY, EDIT_GROUP, UNLOCK, CHANGE_PASSWORD]

    The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source.
    UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.

    fields

    object[]

  • Array [

  • name string

    The name of the attribute.

    transform object

    Default value: [object Object]

    The transform to apply to the field

    attributes object

    Attributes required for the transform

    isRequired boolean

    Flag indicating whether or not the attribute is required.

    type string

    The type of the attribute.

    isMultiValued boolean

    Flag indicating whether or not the attribute is multi-valued.

  • ]

Loading...