Bulk managing of collaborators (Owners/Contributors/Reviewers) to multiple streams at once?

RJCoolpix880 · 2 March 2022 16:16

Just getting started on a real project using speckle!

We have 6 streams at the moment, and it will increase as we go. I see that I have to go into each stream and add collaborators (Owners/Contributors/Reviewers) to each stream one by one. Is there a way to add people in bulk to multiple streams at once?

Right now I have to add 5 people to each stream so they have access, and if new people join the team I might have to add even more. I just went in and manually added all the people, but I’m not 100% confident that I didn’t miss adding someone to a specific stream since there is no global view of who is on what stream and with what permissions.

teocomi · 2 March 2022 18:58

Unfortunately, we don’t have such a feature yet! In the future it will be implemented as organizations/teams/projects and you’ll be able to set permissions at that level as well.

Joelmick · 27 July 2023 08:49

Would this be possible via the Speckle SDK?

jonathon · 27 July 2023 10:21

Great Question @Joelmick. As a stream owner, you can invite new users to a server, add users to a project stream and change their responsibility.

This is possible with the GraphQL API and, per your question, is also possible via the SDKs with wrappers to those functions.

e.g. specklepy change user role for a stream

github.com

specklesystems/specklepy/blob/8a91260887439446e41ec164b39ca10fd5b4a318/src/specklepy/core/api/resources/stream.py#L589-L633


      
          def update_permission(self, stream_id: str, user_id: str, role: str):
              """Updates permissions for a user on a given stream
          
          
    Valid for Speckle Server >=2.6.4
          
          
    Arguments:
                  stream_id {str} -- the id of the stream to grant permissions to
                  user_id {str} -- the id of the user to grant permissions for
                  role {str} -- the role to grant the user
          
          
    Returns:
                  bool -- True if the operation was successful
              """
              if self.server_version and (
                  self.server_version != ("dev",) and self.server_version < (2, 6, 4)
              ):
                  raise UnsupportedException(
                      "Server mutation `update_permission` is only supported as of Speckle"
                      " Server v2.6.4. Please update your Speckle Server to use this method"
                      " or use the `grant_permission` method instead."

This file has been truncated. show original

e.g. speckle-sharp

github.com

specklesystems/speckle-sharp/blob/3decc758364f8bece2900dcfa32090192acd9ed1/Core/Core/Api/GraphQL/Client.GraphqlCleintOperations/Client.StreamOperations.cs#L443-L460


      
          public async Task<bool> StreamUpdatePermission(
            StreamPermissionInput updatePermissionInput,
            CancellationToken cancellationToken = default
          )
          {
            var request = new GraphQLRequest
            {
              Query =
                @"
                    mutation streamUpdatePermission($permissionParams: StreamUpdatePermissionInput!) {
                      streamUpdatePermission(permissionParams:$permissionParams)
                    }",
              Variables = new { permissionParams = updatePermissionInput }
            };
          
          
  var res = await ExecuteGraphQLRequest<Dictionary<string, object>>(request, cancellationToken).ConfigureAwait(false);
            return (bool)res["streamUpdatePermission"];
          }

Note about “bulk”

The ability to perform these actions in bulk is reserved for Server Admins, but this can be looped and performed one at a time in code. The rate limits are fairly generous unless you discuss multiple hundreds of actions. You’ll receive a 429 if you hit it. Each interaction (if you are interacting with REST + GraphQL) also will include how much rate limit has been expended in the payload.

Joelmick · 27 July 2023 12:23

Nice, i’ll tinker with this!