Class Iam (5.12.0)

Get and set IAM policies for your Cloud Storage bucket.

[Cloud Storage IAM Management](https://cloud.google.com/storage/docs/access-control/iam#short_title_iam_management) [Granting, Changing, and Revoking Access]( https://cloud.google.com/iam/docs/granting-changing-revoking-access ) [IAM Roles]( https://cloud.google.com/iam/docs/understanding-roles )

Iam

Package

@google-cloud/storage!

Constructors

(constructor)(bucket)

  constructor 
 ( 
 bucket 
 : 
  
 Bucket 
 );

Constructs a new instance of the Iam class

Parameter

Name	Description
bucket	`Bucket`

Methods

getPolicy(options)

  getPolicy 
 ( 
 options 
 ?: 
  
 GetPolicyOptions 
 ) 
 : 
  
 Promise<GetPolicyResponse> 
 ;

Parameter

Name	Description
options	`GetPolicyOptions`

Returns

Type	Description
Promise < GetPolicyResponse >

getPolicy(options, callback)

  getPolicy 
 ( 
 options 
 : 
  
 GetPolicyOptions 
 , 
  
 callback 
 : 
  
 GetPolicyCallback 
 ) 
 : 
  
 void 
 ;

Parameters

Name	Description
options	`GetPolicyOptions`
callback	`GetPolicyCallback`

Returns

Type	Description
void

getPolicy(callback)

  getPolicy 
 ( 
 callback 
 : 
  
 GetPolicyCallback 
 ) 
 : 
  
 void 
 ;

Parameter

Name	Description
callback	`GetPolicyCallback`

Returns

Type	Description
void

setPolicy(policy, options)

  setPolicy 
 ( 
 policy 
 : 
  
 Policy 
 , 
  
 options 
 ?: 
  
 SetPolicyOptions 
 ) 
 : 
  
 Promise<SetPolicyResponse> 
 ;

Parameters

Name	Description
policy	`Policy`
options	`SetPolicyOptions`

Returns

Type	Description
Promise < SetPolicyResponse >

setPolicy(policy, callback)

  setPolicy 
 ( 
 policy 
 : 
  
 Policy 
 , 
  
 callback 
 : 
  
 SetPolicyCallback 
 ) 
 : 
  
 void 
 ;

Parameters

Name	Description
policy	`Policy`
callback	`SetPolicyCallback`

Returns

Type	Description
void

setPolicy(policy, options, callback)

  setPolicy 
 ( 
 policy 
 : 
  
 Policy 
 , 
  
 options 
 : 
  
 SetPolicyOptions 
 , 
  
 callback 
 : 
  
 SetPolicyCallback 
 ) 
 : 
  
 void 
 ;

Parameters

Name	Description
policy	`Policy`
options	`SetPolicyOptions`
callback	`SetPolicyCallback`

Returns

Type	Description
void

testPermissions(permissions, options)

  testPermissions 
 ( 
 permissions 
 : 
  
 string 
  
 | 
  
 string 
 [], 
  
 options 
 ?: 
  
 TestIamPermissionsOptions 
 ) 
 : 
  
 Promise<TestIamPermissionsResponse> 
 ;

Parameters

Name	Description
permissions	`string \| string[]`
options	`TestIamPermissionsOptions`

Returns

Type	Description
Promise < TestIamPermissionsResponse >

testPermissions(permissions, callback)

  testPermissions 
 ( 
 permissions 
 : 
  
 string 
  
 | 
  
 string 
 [], 
  
 callback 
 : 
  
 TestIamPermissionsCallback 
 ) 
 : 
  
 void 
 ;

Parameters

Name	Description
permissions	`string \| string[]`
callback	`TestIamPermissionsCallback`

Returns

Type	Description
void

testPermissions(permissions, options, callback)

  testPermissions 
 ( 
 permissions 
 : 
  
 string 
  
 | 
  
 string 
 [], 
  
 options 
 : 
  
 TestIamPermissionsOptions 
 , 
  
 callback 
 : 
  
 TestIamPermissionsCallback 
 ) 
 : 
  
 void 
 ;

Parameters

Name	Description
permissions	`string \| string[]`
options	`TestIamPermissionsOptions`
callback	`TestIamPermissionsCallback`

Returns

Type	Description
void

Class Iam (5.12.0) Stay organized with collections Save and categorize content based on your preferences.

Package

Constructors

(constructor)(bucket)

Methods

getPolicy(options)

getPolicy(options, callback)

getPolicy(callback)

setPolicy(policy, options)

setPolicy(policy, callback)

setPolicy(policy, options, callback)

testPermissions(permissions, options)

testPermissions(permissions, callback)

testPermissions(permissions, options, callback)

Class Iam (5.12.0)