Platform

Hello

Each week I manually extract a list of users and their roles in Frontdoor.  Is there an API call available in which I can use to extract this information automatically?

Thanks

Yes, @Wendy Cho. Check this help page (link).

I have done this in Postman, however our organization disabled our access to it, so I lost the script.

We wrote another version in Python and I managed to update the Persona field for many users several months ago.

The script does the following:

1. Authenticate against the Frontdoor API with our API Key (see here how to create it)
2. Retrieve the token
3. Call the Frontdoor API to retrieve the user list. You'll have to provide the token from step #2
4. Extract the user list from the returned output

This is not the first time this topic comes up and, like before, I can write a post with more details if required. I think I'll do it just in case it proves useful: I need to refresh my mind on how this whole story works 😎😎😎

Hello

Each week I manually extract a list of users and their roles in Frontdoor.  Is there an API call available in which I can use to extract this information automatically?

Thanks

Thank you for the reply.  Any details would be appreciated.  (newbie with API calls).  We are exploring this option because the  legacy administration menu is going to be decommission, and our current script to perform the automatic clicks will no longer be functional. 

Original Message:
Sent: 05-06-2024 03:16
From: Guillermo Cuadrado
Subject: API call in Frontdoor to extract userlist

Yes, @Wendy Cho. Check this help page (link).

I have done this in Postman, however our organization disabled our access to it, so I lost the script.

We wrote another version in Python and I managed to update the Persona field for many users several months ago.

The script does the following:

1. Authenticate against the Frontdoor API with our API Key (see here how to create it)
2. Retrieve the token
3. Call the Frontdoor API to retrieve the user list. You'll have to provide the token from step #2
4. Extract the user list from the returned output

This is not the first time this topic comes up and, like before, I can write a post with more details if required. I think I'll do it just in case it proves useful: I need to refresh my mind on how this whole story works 😎😎😎

------------------------------
Regards, Guillermo

Original Message:
Sent: 05-03-2024 15:43
From: Wendy Cho
Subject: API call in Frontdoor to extract userlist

Hello

Each week I manually extract a list of users and their roles in Frontdoor.  Is there an API call available in which I can use to extract this information automatically?

Thanks

I have more details in this blog post (link). I wrote my findings when I was trying the API a couple of years ago.
It might help you getting started with API calls.

On second thought, I am not sure it will return the roles. I need to dig a bit deeper, @Wendy Cho.

(later)

Looking at the help pages about getting user information (link), I see the following:

Response:

{
   "id": "<string>",
   "login": "<string>",
   "active": <true/false>,
   "full": "<string>",
   "email": "<string>",
   "persona": {
	"enumValue": "APPLICATION_PLATFORM_OWNER"
   },				
   "forcePwdChange": <true/false>, 
   "domain": "<string>", 
   "failedLoginCount": <int>, 
   "createdBy": "<string>",
   "updatedBy": "<string>",
   "accountType": "STANDARD",
   "external": <true/false>,
   "accountStatus": "<string>"
}

Unfortunately, it doesn't mention the customRoles or defaultRoles lists (see this other help page (link)).

P.S.

I created a Python script that takes those two simple steps:

1. Access Frontdoor to get an authorization token with a POST method
2. Do a GET call to the endpoint, in my case: 
   https://frontdoor-eu.apptio.com/api/v2/users/search?domainName=<YOUR_COMPANY>&hideInactive=false&start=0&pageSize=1000&sortBy=login

Both are described in the help pages above

I did NOT get the roles, as I feared.

Maybe @Ken Haniu can help further...

------------------------------
Regards, Guillermo

Original Message:
Sent: 05-06-2024 09:53
From: Wendy Cho
Subject: API call in Frontdoor to extract userlist

Thank you for the reply.  Any details would be appreciated.  (newbie with API calls).  We are exploring this option because the  legacy administration menu is going to be decommission, and our current script to perform the automatic clicks will no longer be functional. 

Original Message:
Sent: 05-06-2024 03:16
From: Guillermo Cuadrado
Subject: API call in Frontdoor to extract userlist

Yes, @Wendy Cho. Check this help page (link).

I have done this in Postman, however our organization disabled our access to it, so I lost the script.

We wrote another version in Python and I managed to update the Persona field for many users several months ago.

The script does the following:

1. Authenticate against the Frontdoor API with our API Key (see here how to create it)
2. Retrieve the token
3. Call the Frontdoor API to retrieve the user list. You'll have to provide the token from step #2
4. Extract the user list from the returned output

This is not the first time this topic comes up and, like before, I can write a post with more details if required. I think I'll do it just in case it proves useful: I need to refresh my mind on how this whole story works 😎😎😎

------------------------------
Regards, Guillermo

Original Message:
Sent: 05-03-2024 15:43
From: Wendy Cho
Subject: API call in Frontdoor to extract userlist

Hello

Each week I manually extract a list of users and their roles in Frontdoor.  Is there an API call available in which I can use to extract this information automatically?

Thanks

Hello

Each week I manually extract a list of users and their roles in Frontdoor.  Is there an API call available in which I can use to extract this information automatically?

Thanks