Search principals

开发环境

http://dev-cn.your-api-server.com

GET

/docs/{docId}/acl/principals/search

Permissions

Searches for user and group principals matching the query that this doc can be shared with.
At most 20 results will be returned for both users and groups. If no query is given then no results are returned.

请求示例

Python

Shell

JavaScript

Java

curl --location --request GET 'http://dev-cn.your-api-server.com/docs/AbCDeFGH/acl/principals/search'

响应示例

200 - 示例 1

{
    "users": [
        {
            "name": "John Doe",
            "loginId": "user@example.com",
            "pictureLink": "https://cdn.coda.io/avatars/default_avatar.png",
            "type": "user"
        }
    ],
    "groups": [
        {
            "groupId": "grp-6SM9xrKcqW",
            "groupName": "Marketing team",
            "type": "group"
        }
    ]
}

请求参数

Path 参数

docId

string

必需

ID of the doc.

示例值:

AbCDeFGH

Query 参数

query

string

可选

Search term used to filter down results.

示例值:

Supercalifragilisticexpialidocious

返回响应

🟢200Search results for the given query.

application/json

Body

Metadata about the principals that match the given query.

users

array[object (UserSummary) {4}]

必需

name

string

必需

Name of the user.

示例值:

John Doe

loginId

string

必需

Email address of the user.

示例值:

user@example.com

pictureLink

string <url>

可选

Browser-friendly link to the user's avatar image.

示例值:

https://cdn.coda.io/avatars/default_avatar.png

type

enum<string>

必需

The type of this resource.

枚举值:

user

groups

array[object (GroupPrincipal) {3}]

必需

groupId

string

必需

Group ID for the principal.

示例值:

grp-6SM9xrKcqW

groupName

string

必需

Name of the group.

示例值:

Marketing team

type

enum<string>

必需

The type of this principal.

枚举值:

group

🟠400400

🟠401401

🟠403403

🟠404404

🟠429429

修改于 2024-03-20 08:13:15

Delete permission

Get ACL settings