Beta

Check Bulk Resources Authorization For User

POST

1 from credal import CredalApi
2 from credal.common import (
3     ResourceIdentifier_ExternalResourceId,
4     ResourceIdentifier_Url,
5 )
6 
7 client = CredalApi(
8     api_key="YOUR_API_KEY",
9 )
10 client.permissions_service.check_bulk_resources_authorization_for_user(
11     resource_identifiers=[
12         ResourceIdentifier_Url(
13             url="https://docs.google.com/document/d/170NrBm0Do7gdzvr54UvyslPVWkQFOA0lgNycFmdZJQr/edit",
14         ),
15         ResourceIdentifier_ExternalResourceId(
16             external_resource_id="sfsdfvr54UvyslPVWkQFOA0dfsdfsdflgNycFmdZJQr",
17             resource_type="ZENDESK_TICKET",
18         ),
19     ],
20     user_email="john.smith@foo.com",
21 )

Play

200Example0

1 [
2   {
3     "externalResourceId": {
4       "externalResourceId": "170NrBm0Do7gdzvr54UvyslPVWkQFOA0lgNycFmdZJQr",
5       "resourceType": "GOOGLE_DRIVE_ITEM"
6     },
7     "authorized": true,
8     "inputUrl": "https://docs.google.com/document/d/170NrBm0Do7gdzvr54UvyslPVWkQFOA0lgNycFmdZJQr/edit"
9   },
10   {
11     "externalResourceId": {
12       "externalResourceId": "123456",
13       "resourceType": "ZENDESK_TICKET"
14     },
15     "authorized": true
16   }
17 ]

Admin endpoint to check whether the specified user is authorized to read the specified set of resources.

Request

This endpoint expects an object.

resourceIdentifierslist of objectsRequired

The set of resource identifier for which you want to check authorization. Currently limited to 20 resources.

userEmailstringRequired

The user email to check authorization for.

disableCachebooleanOptional

If specified, Credal will bypass the permissions cache and check current permissions for all resources specified.

Response

This endpoint returns a list of objects.

externalResourceIdobject

authorizedboolean

inputUrlstringOptional

Headers

Request

Response