You can retrieve your API user's profile details if:
-
You're using the authorization code method to authorize with Adform APIs.
-
Your application has a back-end and multiple users.
You might need the user's profile details to identify them and create or update their information in your database. You can also retrieve profile information to track user activity and control access to resources.
With Security & Authorization API, you can retrieve user profile information of an authenticated user.
To authenticate and use the Security & Authentication API, you must have an Adform user account. In addition, your OAuth client must have the following scopes assigned to it by Adform Support (technical@adform.com):
-
openid: Allows to identify the authenticated user by their UUID (subparameter).Important
The
openidscope required to use this API isn't compatible with client credentials method. -
profile: Grants access to user profile information.
Tip
If you don't have an OAuth client yet, follow the procedure in Get Authentication Credentials for Adform APIs to register one.
Tip
To learn how to use Adform APIs, read Guide to Using Adform APIs.
To retrieve a user's information with API, use this endpoint:
-
GET endpoint in UserInfo section of Security & Authentication API: To retrieve a user's information.