Share via

Access Platform User Role service

  • Article

Note

This service is currently available to a limited set of clients and Microsoft employees only.

The access-platform-user-role service can be used to manage roles for users who are not associated with members.

REST API

HTTP Method Endpoint Description
GET https://api.appnexus.com/access-platform-user-role View all platform users and their roles.
POST https://api.appnexus.com/access-platform-user-role?user_id=UID&role_id=ROLE_ID Create a platform user/role association.
DELETE https://api.appnexus.com/access-platform-user-role Delete a platform user/role association.

JSON fields

General

Field Type (Length) Description
description string The description of the role.
id int The unique ID of the user/role association.
Required On: DELETE
Default: Auto-generated on POST.
platform_role Boolean Returns true if the role is a platform role; false if the role is a custom role.
role_id string The type of group. Value will be either role or team.
Required On: POST
role_name object The ID and name of each resource in the group.
user_id int The ID of the group.
Required On: POST

Examples

View all platform user/role associations

$ curl -b cookies 'https://api.appnexus.com/access-platform-user-role'
"access-platform-user-role": [
    {
        "user_id": 123456,
        "role_id": 111,
        "role_name": "Test Role",
        "description": "Temporary Role for Testing",
        "platform_role": false,
        "id": 123
    }
]

Create a new platform user/role association

$ cat platform-user-role.json
{
        "access-platform-user-role": 
                [
                        {
                                "user_id": 123456,
                                "role_id": 123
                        }
                ]
}
$ curl -b cookies 'https://api.appnexus.com/access-platform-user-role'

Delete a platform user/role association

curl -b cookies 'https://api.appnexus.com/access-platform-user-role?id=123'