topic Re: How to use the User management APIs - what is the bearer field value? in Open Q&A

How to use the User management APIs - what is the bearer field value?

DavidePiras — Wed, 19 May 2021 22:06:31 GMT

I am trying to use the user management APIs, as they are shown in this page:

https://api.dynatrace.com/spec/#/User%20Management/UsersController_getUsers

when i click authorize at the top right it ask for a bearer, http, what is that?

should i enter a PAT, an API token or what exactly?

i also went to th eaccount management APIs section and generated client ID and secret, but as per your documentation, i am having issues to generate the Token from there, you have this snippet in there, is this snippet correct? does not look correct to me, why there is this strange string at the end on the parameters list: %3Adtaccount% ?

POST /sso/oauth2/token HTTP/1.1
Host: sso.dynatrace.com
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials&client_id={your client id}&client_secret={your client secret}&scope=account-idm-read+account-idm-write&resource=urn%3Adtaccount%{your account UID}

Re: How to use the User management APIs - what is the bearer field value?

ryan_hess — Fri, 21 May 2021 21:08:51 GMT

Hi davide_piras,

The resource parameter is simply to let dynatrace SSO know that the token will be scoped to a particular account as users can be on multiple accounts. What you see is URL encoded. It will look something like this: urn:dtaccount:00000000000-0000-0000-000000-0000000000000 where the "0"'s would be replaced with our account UUID. Once you make the request you will get a JSON payload payload with a field called "access_token". You can copy this and paste it into the the swagger and run the request.

Thanks,

Ryan

Re: How to use the User management APIs - what is the bearer field value?

DavidePiras — Sat, 22 May 2021 09:47:26 GMT

Thanks Ryan, the documentation page doesn't only have that error, also the scope to be used is not:

scope=account-idm-read+account-idm-write

but the correct value is:

scope=account-idm-read account-idm-write

without a plus,

I got help from the consultant in the in-product chat, i understand url is encoded but as it is not clickable anyway and values should be replaced, that page would be more helpful if explaining clearly in details which value in each parameter for instance with a screenshot from Postman, SoapUI or whatever other http client...

anyway all worked now for me and i could successfully retrieve that token.

Thanks,

Davide

Re: How to use the User management APIs - what is the bearer field value?

ryan_hess — Tue, 25 May 2021 15:01:55 GMT

Hi Davide,

I really appreciate the feedback. I'll take this back to the team and see if we can come up with some simpler explanation.

Cheers!

Ryan

Re: How to use the User management APIs - what is the bearer field value?

Duran_Narbona — Wed, 27 Sep 2023 14:30:25 GMT

Hi, I have the same problem, is not working for me

https://www.dynatrace.com/support/help/shortlink/account-api-authentication#request-a-token

Re: How to use the User management APIs - what is the bearer field value?

MarwanC — Wed, 04 Jun 2025 15:53:21 GMT

I guess you have already solved this, but this for the file:

Simple as Windows Batch file

curl -X POST "https://sso.dynatrace.com/sso/oauth2/token" ^
-H "Content-Type: application/x-www-form-urlencoded" ^
-d "grant_type=client_credentials" ^
-d "scope=THE_SCOPE_THAT_IS_NEEDED_FROM_THE_API_SWAGGER_PAGE" ^
-d "client_id=dt0s02.GU3CXFD6" ^
"client_secret=OBTAINED_AFTER_CREATION_OF_OAUTH" ^
-d "resource=OBTAINED_AFTER_CREATION_OF_OAUTH"

You should get a response like this

C:\Users\1026014>curl -X POST "https://sso.dynatrace.com/sso/oauth2/token" -H "Content-Type: application/x-www-form-urlencoded" -d "grant_type=client_credentials" -d "scope=environment-api:entities:read" -d "client_id=dt0s02.GU3CXFD6" -d "client_secret=CLINET_SECRET" -d "resource=urn:dtaccount:74a359b4-9323-4b88-9649-d1245f95cfe7"

{"scope":"environment-api:entities:read","token_type":"Bearer","expires_in":300,"access_token":"YOUR_BEARER_TOKEN","resource":"YOUR_URN"} "Creation Date: 04-06-2025"

Hope this helps!

Anybody having issues with OAUTH tokens that want to share, as some API do not work anymore with OAUTH Bearer tokens.

Re: How to use the User management APIs - what is the bearer field value?

MarwanC — Wed, 04 Jun 2025 15:55:01 GMT

Indeed the format of the scope space separated format.