Use the API to delegate the management of sharing requests to a specific role

This article is for developers with a full understanding of how to work with our API. 

Important note about the API explorer
When you follow the link we provide to the API explorer, you'll see a red warning.
API_image01.png
The API itself is not deprecated. It's the Google API explorer that is deprecated. All the processes described in our API articles function correctly and safely if you use this Google API explorer. 

This article is for internal use only. It is aimed at members of the Service Team and Support Team. 

By default, library administrators receive and manage sharing requests forwarded by the storage account.  As a library administrator, you can use the API to delegate the management of sharing requests to a specific role. After activating the feature, all sharing requests will be sent to users of the specified role. 

Learn more: What are library roles?

In this article:

Automatically generated table of contents


Delegate management of sharing requests  at the library level

1. As a library administrator, follow this link to the AODocs API:

https://apis-explorer.appspot.com/apis-explorer/?base=https://ao-docs.appspot.com/_ah/api#p/library/v1/library.library.patchLibrary

2. Enter the ID of the library in which you want to activate the custom configuration.
Learn how to identify the library ID

3. In the Request body field, press the Add a property menu and select forwardRequestAccessRole

4. Enter the required role ID next toforwardRequestAccessRole.

Learn how to list the role IDs in your library.

5. Press Authorize and execute. The response is displayed in the lower part of the screen.

image01.png

Note: To restore the default, use the same process, and enter the value ADMINISTRATORS in the Request body field.


Use the API to list the role IDs in your library

1. As a library administrator, follow this link to the AODocs API:

https://apis-explorer.appspot.com/apis-explorer/?base=https://ao-docs.appspot.com/_ah/api#search/roles/m/library/v1beta1/library.roles.list

2. Enter the ID of the library in which you want to activate the custom configuration.
Learn how to identify the library ID

3. Press Authorize and execute

image02.png

The response is displayed in the lower part of the screen.

Note: Pre-defined roles have human readable IDs, custom role IDs are random strings. 

image03.png

Was this article helpful? 2 out of 2 found this helpful
If you didn’t find what you were looking for, don’t hesitate to leave a comment!
Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.