Class Iam (5.17.0)

Get and set IAM policies for your Cloud Storage bucket.

See Cloud Storage IAM Management See Granting, Changing, and Revoking Access See IAM Roles

Iam

Package

@google-cloud/storage

Example


const {Storage} = require('@google-cloud/storage');
const storage = new Storage();
const bucket = storage.bucket('my-bucket');
// bucket.iam

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