cloudRequired on Create Profile

[sean_cochran17 (Sean Cochran)]

Hello everyone,

I am working on validating a source create profile JSON and the response has left me with a few questions. Here is the relevant part of the JSON:

        {
            "name": "division",
            "transform": {
                "attributes": {
                    "name": "location"
                },
                "type": "identityAttribute"
            },
            "attributes": {
                "cloudRequired": "true"
            },
            "isRequired": false,
            "type": "string",
            "isMultiValued": false
        }

I am trying to understand the role and configuration of the cloudRequired attribute within this JSON schema. Specifically, I would like to know:

1. Where is cloudRequired set, if anywhere? Is it defined within IdentityNow, or is this a default setting? My thought is no, since I am not seeing it for some mappings.
2. What is the difference between cloudRequired and isRequired? It seems like both could pertain to attribute requirements, but there must be distinct uses or contexts for each.

Any insights or documentation references regarding these attributes would be greatly appreciated!

Thank you!

[bcariaga (Braden Cariaga)]

The isRequired is whether or not this field can be NULL during the provisioning event.

I can’t seem to find much documentation on cloudRequired, but it only seems necessary on rule/generator transforms (I haven’t noticed any issues on others). The only thing I could find was the requirement of it being true on Username Generator | SailPoint Developer Community. I’ve noticed this is automatically set when you check the generator or static option on the Create Profile.

[christina_gagnon]

I researched this and found that isRequired is internal and not updatable via API. It is the external source itself that controls whether or not an attribute is required to create an account.

As for cloudRequired, that is updatable via API. But setting it to true on an attribute that has no value in the provisioning plan will not cause the provisioning to fail.