Groups Members Set Access Type

POST

https://api.dropboxapi.com/2/team/groups/members/set_access_type

POST

/2/team/groups/members/set_access_type

import requests
url = "https://api.dropboxapi.com/2/team/groups/members/set_access_type"
payload = {
    "access_type": {
        ".tag": "member",
        "member": None
    },
    "group": {
        ".tag": "group_id",
        "group_id": "g:e2db7665347abcd600000000001a2b3c"
    },
    "user": {
        ".tag": "team_member_id",
        "team_member_id": "dbmid:efgh5678"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

Response headers

HTTP/1.1 200 OK
X-Dropbox-Request-Id: string

[
  {
    ".tag": "group_info",
    "created": 1447255518000,
    "group_id": "g:e2db7665347abcd600000000001a2b3c",
    "group_management_type": {
      ".tag": "user_managed"
    },
    "group_name": "project launch",
    "member_count": 5,
    "members": [
      {
        "access_type": {
          ".tag": "member",
          "member": null
        },
        "profile": {
          "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
          "email": "mary@lamb.com",
          "email_verified": true,
          "joined_on": "2015-05-12T15:50:38Z",
          "membership_type": {
            ".tag": "full"
          },
          "name": {
            "abbreviated_name": "FF",
            "display_name": "Franz Ferdinand (Personal)",
            "familiar_name": "Franz",
            "given_name": "Franz",
            "surname": "Ferdinand"
          },
          "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128",
          "secondary_emails": [
            {
              "email": "apple@orange.com",
              "is_verified": true
            },
            {
              "email": "banana@honeydew.com",
              "is_verified": true
            },
            {
              "email": "grape@strawberry.com",
              "is_verified": false
            }
          ],
          "status": {
            ".tag": "active"
          },
          "team_member_id": "dbmid:1234567"
        }
      }
    ]
  }
]

Sets a member’s access type in a group.

Permission : Team member management.

Required scope: groups.write

Endpoint format: RPC

Authentication: Team

Authentication

AuthorizationBearer

Team-level OAuth 2.0 token issued to a Dropbox Business admin. Use Authorization: Bearer <token>.

Obtain via the authorization code flow with team-scoped permissions.

Grants access to team-wide administrative operations.

You can generate a short-lived access token from the App Console; see Testing with a generated token.

Request

This endpoint expects an object.

access_typeobjectRequired

New group access type the user will have.

Variant:

team_apiv2.GroupAccessType.memberobjectRequired

User is a member of the group, but has no special permissions.

groupobjectRequired

Specify a group.

Variant:

team_apiv2.GroupSelector.group_idobjectRequired

Group ID.

userobjectRequired

Identity of a user that is a member of group.

Variant:

team.UserSelectorArg.team_member_idobjectRequired

return_membersbooleanOptionalDefaults to true

Whether to return the list of members in the group. Note that the default value will cause all the group members to be returned in the response. This may take a long time for large groups.

Response headers

X-Dropbox-Request-IdstringOptional

A unique identifier for the request, useful for debugging and support.

Response

Successful response

Variant:

team_apiv2.GroupsGetInfoItem.id_not_foundobject

An ID that was provided as a parameter to groups/get_info, and did not match a corresponding group. The ID can be a group ID, or an external ID, depending on how the method was called.

Errors

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error