Class: PlatformAPI::SpaceAppAccess

Inherits:
Object
  • Object
show all
Defined in:
lib/platform-api/client.rb

Overview

Space access represents the permissions a particular user has on a particular space.

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ SpaceAppAccess

Returns a new instance of SpaceAppAccess.



2928
2929
2930
# File 'lib/platform-api/client.rb', line 2928

def initialize(client)
  @client = client
end

Instance Method Details

#info(space_id_or_space_name, account_email_or_account_id_or_account_self) ⇒ Object

List permissions for a given user on a given space.

Parameters:

  • space_id_or_space_name:

    unique identifier of space or unique name of space

  • account_email_or_account_id_or_account_self:

    unique email address of account or unique identifier of an account or Implicit reference to currently authorized user



2936
2937
2938
# File 'lib/platform-api/client.rb', line 2936

def info(space_id_or_space_name, )
  @client.space_app_access.info(space_id_or_space_name, )
end

#list(space_id_or_space_name) ⇒ Object

List all users and their permissions on a space.

Parameters:

  • space_id_or_space_name:

    unique identifier of space or unique name of space



2952
2953
2954
# File 'lib/platform-api/client.rb', line 2952

def list(space_id_or_space_name)
  @client.space_app_access.list(space_id_or_space_name)
end

#update(space_id_or_space_name, account_email_or_account_id_or_account_self, body = {}) ⇒ Object

Update an existing user's set of permissions on a space.

Parameters:

  • space_id_or_space_name:

    unique identifier of space or unique name of space

  • account_email_or_account_id_or_account_self:

    unique email address of account or unique identifier of an account or Implicit reference to currently authorized user

  • body:

    the object to pass as the request payload



2945
2946
2947
# File 'lib/platform-api/client.rb', line 2945

def update(space_id_or_space_name, , body = {})
  @client.space_app_access.update(space_id_or_space_name, , body)
end