What is the purpose of inactive attribute

There is an attribute by name ‘inactive’ on the identity, the value for this is mostly false irrespective of the cloudLifecycleState.
This attribute is visible on API responses as well as on the search feature as a selectable attribute.

I’ve following questions:

  1. What is purpose of this attribute or in other words what does it convey really?
  2. Is it possible to update this field based on some attribute say cloudLifecycleState.

Thanks you,
Vineedh Viswanathan

First of all, welcome to the community!

Can you provide a link to the endpoint you are seeing this ‘inactive’ identity attribute so I can look into this?

Hi Philip-ellis,

Thanks for the quick response.
I’ve provided the details of the API call below.

Request using cURL:
curl --location --request POST ‘https://{{orgname}}.api.identitynow.com/v3/search?offset=0&limit=250&count=false’
–header ‘Content-Type: application/json’
–header ‘Authorization: Bearer XXXXXXXXX’
–data-raw ‘{
“indices”: [
“identities”
],
“query”: {
“query”: “firstName: Tim”,
“fields”: [
“name”,
“description”
]
}
}’

Response received:
[
{
“id”: “XXXXXXXXXX”,
“name”: “Tim.XXXXX”,
“displayName”: “Tim.XXXXXX”,
“firstName”: “Tim”,
“lastName”: “XXXXXX”,
“email”: “[email protected]”,
“created”: “2021-12-13T16:22:25.808Z”,
“modified”: “2021-12-15T18:27:41.604Z”,
“inactive”: false,
“attributes”: {

“cloudLifecycleState”: “active”,

}

}
]

I have looked into this and at this point, I am unsure as to what causes the “inactive” property to be changed to true. As far as I can tell, setting an identity status to disabled or changing the lifecycle status to inactive does not impact that field, which makes me think that it is an internal value that might be tied to the identity and if it will be shown on the page at all.

If I remove the identity then I can no longer search for that identity in the API to see if the inactive flag gets set to true, but I’m thinking that might be the case.

I have a message out to engineering to see if I can get an answer for you, but with the holidays, it might not be until after the break.

Do any of the identities in your system have that flag set to true?

After further analysis with our development team, it has been found that this field is an internal only field and should not be referenced or used for anything externally via the API.

1 Like