Batch list members
Returns users and groups.
Request
POST
https://api.datalens.tech/rpc/batchListMembers
Headers
|
Name |
Description |
|
x-dl-api-version |
Type: string API version header. Const: Example: |
Body
application/json
{
"language": "en",
"search": "example",
"tabId": "SUBJECT_TYPE_UNSPECIFIED",
"pageSize": 0.5,
"pageToken": "example",
"filter": "example"
}
|
Name |
Description |
|
filter |
Type: string Filter applied to the member list. Example: |
|
language |
Type: string Language used for member data. Enum: |
|
pageSize |
Type: number Maximum number of members to return. |
|
pageToken |
Type: string Token for the next page of members. Example: |
|
search |
Type: string Text used to search for members. Example: |
|
tabId |
Type: string Subject type used to filter members. Enum: |
Responses
200 OK
Response
Body
application/json
{
"members": [
{
"sub": "example",
"subType": "SUBJECT_TYPE_UNSPECIFIED",
"email": "example",
"name": "example",
"givenName": "example",
"familyName": "example",
"preferredUsername": "example",
"federation": null,
"pictureData": "example",
"picture": "example",
"idpType": "example"
}
],
"nextPageToken": "example"
}
|
Name |
Description |
|
members |
Type: AccessExtSubjectClaims[] Members matching the request. Example |
|
nextPageToken |
Type: string Token for the next page of members. Example: |
AccessExtSubjectClaims
|
Name |
Description |
|
|
Type: string Subject email address. Example: |
|
familyName |
Type: string Subject family name. Example: |
|
givenName |
Type: string Subject given name. Example: |
|
name |
Type: string Subject display name. Example: |
|
preferredUsername |
Type: string Preferred username of the subject. Example: |
|
sub |
Type: string Subject identifier. Example: |
|
subType |
Type: string Subject type. Enum: |
|
federation |
Type: unknown Federation associated with the subject. Example: |
|
idpType |
Type: string | null Type of the subject identity provider. Example: |
|
picture |
Type: string URL of the subject profile picture. Example: |
|
pictureData |
Type: string Encoded profile picture data. Example: |
Example
{
"sub": "example",
"subType": "SUBJECT_TYPE_UNSPECIFIED",
"email": "example",
"name": "example",
"givenName": "example",
"familyName": "example",
"preferredUsername": "example",
"federation": null,
"pictureData": "example",
"picture": "example",
"idpType": "example"
}