Documentation ¶
Overview ¶
Package admin is an auto-generated package for the Identity and Access Management (IAM) API.
Manages identity and access control for Google Cloud Platform resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls.
NOTE: This package is in beta. It is not stable, and may be subject to changes.
Example usage ¶
To get started with this package, create a client.
ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := admin.NewIamClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close()
The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.
Using the Client ¶
The following is an example of making an API call with the newly created client.
ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := admin.NewIamClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &adminpb.ListServiceAccountsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/iam/admin/v1#ListServiceAccountsRequest. } it := c.ListServiceAccounts(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Use of Context ¶
The ctx passed to NewIamClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.
To close the open connection, use the Close() method.
For information about setting deadlines, reusing contexts, and more please visit https://pkg.go.dev/cloud.google.com/go.
Index ¶
- func DefaultAuthScopes() []string
- func IamKeyPath(project, serviceAccount, key string) string
- func IamProjectPath(project string) string
- func IamServiceAccountPath(project, serviceAccount string) string
- type IamCallOptions
- type IamClient
- func (c *IamClient) Close() error
- func (c *IamClient) Connection() *grpc.ClientConn
- func (c *IamClient) CreateRole(ctx context.Context, req *adminpb.CreateRoleRequest, opts ...gax.CallOption) (*adminpb.Role, error)
- func (c *IamClient) CreateServiceAccount(ctx context.Context, req *adminpb.CreateServiceAccountRequest, ...) (*adminpb.ServiceAccount, error)
- func (c *IamClient) CreateServiceAccountKey(ctx context.Context, req *adminpb.CreateServiceAccountKeyRequest, ...) (*adminpb.ServiceAccountKey, error)
- func (c *IamClient) DeleteRole(ctx context.Context, req *adminpb.DeleteRoleRequest, opts ...gax.CallOption) (*adminpb.Role, error)
- func (c *IamClient) DeleteServiceAccount(ctx context.Context, req *adminpb.DeleteServiceAccountRequest, ...) error
- func (c *IamClient) DeleteServiceAccountKey(ctx context.Context, req *adminpb.DeleteServiceAccountKeyRequest, ...) error
- func (c *IamClient) GetIamPolicy(ctx context.Context, req *iampb.GetIamPolicyRequest) (*iam.Policy, error)
- func (c *IamClient) GetRole(ctx context.Context, req *adminpb.GetRoleRequest, opts ...gax.CallOption) (*adminpb.Role, error)
- func (c *IamClient) GetServiceAccount(ctx context.Context, req *adminpb.GetServiceAccountRequest, ...) (*adminpb.ServiceAccount, error)
- func (c *IamClient) GetServiceAccountKey(ctx context.Context, req *adminpb.GetServiceAccountKeyRequest, ...) (*adminpb.ServiceAccountKey, error)
- func (c *IamClient) ListRoles(ctx context.Context, req *adminpb.ListRolesRequest, opts ...gax.CallOption) (*adminpb.ListRolesResponse, error)
- func (c *IamClient) ListServiceAccountKeys(ctx context.Context, req *adminpb.ListServiceAccountKeysRequest, ...) (*adminpb.ListServiceAccountKeysResponse, error)
- func (c *IamClient) ListServiceAccounts(ctx context.Context, req *adminpb.ListServiceAccountsRequest, ...) *ServiceAccountIterator
- func (c *IamClient) QueryGrantableRoles(ctx context.Context, req *adminpb.QueryGrantableRolesRequest, ...) (*adminpb.QueryGrantableRolesResponse, error)
- func (c *IamClient) QueryTestablePermissions(ctx context.Context, req *adminpb.QueryTestablePermissionsRequest, ...) (*adminpb.QueryTestablePermissionsResponse, error)
- func (c *IamClient) SetIamPolicy(ctx context.Context, req *SetIamPolicyRequest) (*iam.Policy, error)
- func (c *IamClient) SignBlob(ctx context.Context, req *adminpb.SignBlobRequest, opts ...gax.CallOption) (*adminpb.SignBlobResponse, error)
- func (c *IamClient) SignJwt(ctx context.Context, req *adminpb.SignJwtRequest, opts ...gax.CallOption) (*adminpb.SignJwtResponse, error)
- func (c *IamClient) TestIamPermissions(ctx context.Context, req *iampb.TestIamPermissionsRequest, ...) (*iampb.TestIamPermissionsResponse, error)
- func (c *IamClient) UndeleteRole(ctx context.Context, req *adminpb.UndeleteRoleRequest, opts ...gax.CallOption) (*adminpb.Role, error)
- func (c *IamClient) UpdateRole(ctx context.Context, req *adminpb.UpdateRoleRequest, opts ...gax.CallOption) (*adminpb.Role, error)
- func (c *IamClient) UpdateServiceAccount(ctx context.Context, req *adminpb.ServiceAccount, opts ...gax.CallOption) (*adminpb.ServiceAccount, error)
- type ServiceAccountIterator
- type SetIamPolicyRequest
Examples ¶
- IamClient.CreateRole
- IamClient.CreateServiceAccount
- IamClient.CreateServiceAccountKey
- IamClient.DeleteRole
- IamClient.DeleteServiceAccount
- IamClient.DeleteServiceAccountKey
- IamClient.GetRole
- IamClient.GetServiceAccount
- IamClient.GetServiceAccountKey
- IamClient.ListRoles
- IamClient.ListServiceAccountKeys
- IamClient.ListServiceAccounts
- IamClient.QueryGrantableRoles
- IamClient.QueryTestablePermissions
- IamClient.SignBlob
- IamClient.SignJwt
- IamClient.TestIamPermissions
- IamClient.UndeleteRole
- IamClient.UpdateRole
- IamClient.UpdateServiceAccount
- NewIamClient
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DefaultAuthScopes ¶
func DefaultAuthScopes() []string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
func IamKeyPath ¶
IamKeyPath returns the path for the key resource.
func IamProjectPath ¶
IamProjectPath returns the path for the project resource.
func IamServiceAccountPath ¶
IamServiceAccountPath returns the path for the service account resource.
Types ¶
type IamCallOptions ¶
type IamCallOptions struct { ListServiceAccounts []gax.CallOption GetServiceAccount []gax.CallOption CreateServiceAccount []gax.CallOption UpdateServiceAccount []gax.CallOption DeleteServiceAccount []gax.CallOption ListServiceAccountKeys []gax.CallOption GetServiceAccountKey []gax.CallOption CreateServiceAccountKey []gax.CallOption DeleteServiceAccountKey []gax.CallOption SignBlob []gax.CallOption GetIamPolicy []gax.CallOption SetIamPolicy []gax.CallOption TestIamPermissions []gax.CallOption QueryGrantableRoles []gax.CallOption SignJwt []gax.CallOption ListRoles []gax.CallOption GetRole []gax.CallOption CreateRole []gax.CallOption UpdateRole []gax.CallOption DeleteRole []gax.CallOption UndeleteRole []gax.CallOption QueryTestablePermissions []gax.CallOption }
IamCallOptions contains the retry settings for each method of IamClient.
type IamClient ¶
type IamClient struct { // The call options for this service. CallOptions *IamCallOptions // contains filtered or unexported fields }
IamClient is a client for interacting with Google Identity and Access Management (IAM) API.
Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
func NewIamClient ¶
NewIamClient creates a new iam client.
Creates and manages service account objects.
Service account is an account that belongs to your project instead of to an individual end user. It is used to authenticate calls to a Google API.
To create a service account, specify the project_id and account_id for the account. The account_id is unique within the project, and used to generate the service account email address and a stable unique_id.
All other methods can identify accounts using the format projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}. Using - as a wildcard for the project will infer the project from the account. The account value can be the email address or the unique_id of the service account.
Example ¶
package main import ( "context" admin "cloud.google.com/go/iam/admin/apiv1" ) func main() { ctx := context.Background() c, err := admin.NewIamClient(ctx) if err != nil { // TODO: Handle error. } // TODO: Use client. _ = c }
Output:
func (*IamClient) Close ¶
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*IamClient) Connection ¶
func (c *IamClient) Connection() *grpc.ClientConn
Connection returns the client's connection to the API service.
func (*IamClient) CreateRole ¶
func (c *IamClient) CreateRole(ctx context.Context, req *adminpb.CreateRoleRequest, opts ...gax.CallOption) (*adminpb.Role, error)
CreateRole creates a new Role.
Example ¶
package main import ( "context" admin "cloud.google.com/go/iam/admin/apiv1" "cloud.google.com/go/iam/admin/apiv1/adminpb" ) func main() { ctx := context.Background() c, err := admin.NewIamClient(ctx) if err != nil { // TODO: Handle error. } req := &adminpb.CreateRoleRequest{ // TODO: Fill request struct fields. } resp, err := c.CreateRole(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*IamClient) CreateServiceAccount ¶
func (c *IamClient) CreateServiceAccount(ctx context.Context, req *adminpb.CreateServiceAccountRequest, opts ...gax.CallOption) (*adminpb.ServiceAccount, error)
CreateServiceAccount creates a [ServiceAccount][google.iam.admin.v1.ServiceAccount] and returns it.
Example ¶
package main import ( "context" admin "cloud.google.com/go/iam/admin/apiv1" "cloud.google.com/go/iam/admin/apiv1/adminpb" ) func main() { ctx := context.Background() c, err := admin.NewIamClient(ctx) if err != nil { // TODO: Handle error. } req := &adminpb.CreateServiceAccountRequest{ // TODO: Fill request struct fields. } resp, err := c.CreateServiceAccount(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*IamClient) CreateServiceAccountKey ¶
func (c *IamClient) CreateServiceAccountKey(ctx context.Context, req *adminpb.CreateServiceAccountKeyRequest, opts ...gax.CallOption) (*adminpb.ServiceAccountKey, error)
CreateServiceAccountKey creates a [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey] and returns it.
Example ¶
package main import ( "context" admin "cloud.google.com/go/iam/admin/apiv1" "cloud.google.com/go/iam/admin/apiv1/adminpb" ) func main() { ctx := context.Background() c, err := admin.NewIamClient(ctx) if err != nil { // TODO: Handle error. } req := &adminpb.CreateServiceAccountKeyRequest{ // TODO: Fill request struct fields. } resp, err := c.CreateServiceAccountKey(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*IamClient) DeleteRole ¶
func (c *IamClient) DeleteRole(ctx context.Context, req *adminpb.DeleteRoleRequest, opts ...gax.CallOption) (*adminpb.Role, error)
DeleteRole soft deletes a role. The role is suspended and cannot be used to create new IAM Policy Bindings. The Role will not be included in ListRoles() unless show_deleted is set in the ListRolesRequest. The Role contains the deleted boolean set. Existing Bindings remains, but are inactive. The Role can be undeleted within 7 days. After 7 days the Role is deleted and all Bindings associated with the role are removed.
Example ¶
package main import ( "context" admin "cloud.google.com/go/iam/admin/apiv1" "cloud.google.com/go/iam/admin/apiv1/adminpb" ) func main() { ctx := context.Background() c, err := admin.NewIamClient(ctx) if err != nil { // TODO: Handle error. } req := &adminpb.DeleteRoleRequest{ // TODO: Fill request struct fields. } resp, err := c.DeleteRole(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*IamClient) DeleteServiceAccount ¶
func (c *IamClient) DeleteServiceAccount(ctx context.Context, req *adminpb.DeleteServiceAccountRequest, opts ...gax.CallOption) error
DeleteServiceAccount deletes a [ServiceAccount][google.iam.admin.v1.ServiceAccount].
Example ¶
package main import ( "context" admin "cloud.google.com/go/iam/admin/apiv1" "cloud.google.com/go/iam/admin/apiv1/adminpb" ) func main() { ctx := context.Background() c, err := admin.NewIamClient(ctx) if err != nil { // TODO: Handle error. } req := &adminpb.DeleteServiceAccountRequest{ // TODO: Fill request struct fields. } err = c.DeleteServiceAccount(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*IamClient) DeleteServiceAccountKey ¶
func (c *IamClient) DeleteServiceAccountKey(ctx context.Context, req *adminpb.DeleteServiceAccountKeyRequest, opts ...gax.CallOption) error
DeleteServiceAccountKey deletes a [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey].
Example ¶
package main import ( "context" admin "cloud.google.com/go/iam/admin/apiv1" "cloud.google.com/go/iam/admin/apiv1/adminpb" ) func main() { ctx := context.Background() c, err := admin.NewIamClient(ctx) if err != nil { // TODO: Handle error. } req := &adminpb.DeleteServiceAccountKeyRequest{ // TODO: Fill request struct fields. } err = c.DeleteServiceAccountKey(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*IamClient) GetIamPolicy ¶
func (c *IamClient) GetIamPolicy(ctx context.Context, req *iampb.GetIamPolicyRequest) (*iam.Policy, error)
GetIamPolicy returns the IAM access control policy for a ServiceAccount.
func (*IamClient) GetRole ¶
func (c *IamClient) GetRole(ctx context.Context, req *adminpb.GetRoleRequest, opts ...gax.CallOption) (*adminpb.Role, error)
GetRole gets a Role definition.
Example ¶
package main import ( "context" admin "cloud.google.com/go/iam/admin/apiv1" "cloud.google.com/go/iam/admin/apiv1/adminpb" ) func main() { ctx := context.Background() c, err := admin.NewIamClient(ctx) if err != nil { // TODO: Handle error. } req := &adminpb.GetRoleRequest{ // TODO: Fill request struct fields. } resp, err := c.GetRole(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*IamClient) GetServiceAccount ¶
func (c *IamClient) GetServiceAccount(ctx context.Context, req *adminpb.GetServiceAccountRequest, opts ...gax.CallOption) (*adminpb.ServiceAccount, error)
GetServiceAccount gets a [ServiceAccount][google.iam.admin.v1.ServiceAccount].
Example ¶
package main import ( "context" admin "cloud.google.com/go/iam/admin/apiv1" "cloud.google.com/go/iam/admin/apiv1/adminpb" ) func main() { ctx := context.Background() c, err := admin.NewIamClient(ctx) if err != nil { // TODO: Handle error. } req := &adminpb.GetServiceAccountRequest{ // TODO: Fill request struct fields. } resp, err := c.GetServiceAccount(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*IamClient) GetServiceAccountKey ¶
func (c *IamClient) GetServiceAccountKey(ctx context.Context, req *adminpb.GetServiceAccountKeyRequest, opts ...gax.CallOption) (*adminpb.ServiceAccountKey, error)
GetServiceAccountKey gets the [ServiceAccountKey][google.iam.admin.v1.ServiceAccountKey] by key id.
Example ¶
package main import ( "context" admin "cloud.google.com/go/iam/admin/apiv1" "cloud.google.com/go/iam/admin/apiv1/adminpb" ) func main() { ctx := context.Background() c, err := admin.NewIamClient(ctx) if err != nil { // TODO: Handle error. } req := &adminpb.GetServiceAccountKeyRequest{ // TODO: Fill request struct fields. } resp, err := c.GetServiceAccountKey(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*IamClient) ListRoles ¶
func (c *IamClient) ListRoles(ctx context.Context, req *adminpb.ListRolesRequest, opts ...gax.CallOption) (*adminpb.ListRolesResponse, error)
ListRoles lists the Roles defined on a resource.
Example ¶
package main import ( "context" admin "cloud.google.com/go/iam/admin/apiv1" "cloud.google.com/go/iam/admin/apiv1/adminpb" ) func main() { ctx := context.Background() c, err := admin.NewIamClient(ctx) if err != nil { // TODO: Handle error. } req := &adminpb.ListRolesRequest{ // TODO: Fill request struct fields. } resp, err := c.ListRoles(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*IamClient) ListServiceAccountKeys ¶
func (c *IamClient) ListServiceAccountKeys(ctx context.Context, req *adminpb.ListServiceAccountKeysRequest, opts ...gax.CallOption) (*adminpb.ListServiceAccountKeysResponse, error)
ListServiceAccountKeys lists [ServiceAccountKeys][google.iam.admin.v1.ServiceAccountKey].
Example ¶
package main import ( "context" admin "cloud.google.com/go/iam/admin/apiv1" "cloud.google.com/go/iam/admin/apiv1/adminpb" ) func main() { ctx := context.Background() c, err := admin.NewIamClient(ctx) if err != nil { // TODO: Handle error. } req := &adminpb.ListServiceAccountKeysRequest{ // TODO: Fill request struct fields. } resp, err := c.ListServiceAccountKeys(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*IamClient) ListServiceAccounts ¶
func (c *IamClient) ListServiceAccounts(ctx context.Context, req *adminpb.ListServiceAccountsRequest, opts ...gax.CallOption) *ServiceAccountIterator
ListServiceAccounts lists [ServiceAccounts][google.iam.admin.v1.ServiceAccount] for a project.
Example ¶
package main import ( "context" admin "cloud.google.com/go/iam/admin/apiv1" "cloud.google.com/go/iam/admin/apiv1/adminpb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() c, err := admin.NewIamClient(ctx) if err != nil { // TODO: Handle error. } req := &adminpb.ListServiceAccountsRequest{ // TODO: Fill request struct fields. } it := c.ListServiceAccounts(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*IamClient) QueryGrantableRoles ¶
func (c *IamClient) QueryGrantableRoles(ctx context.Context, req *adminpb.QueryGrantableRolesRequest, opts ...gax.CallOption) (*adminpb.QueryGrantableRolesResponse, error)
QueryGrantableRoles queries roles that can be granted on a particular resource. A role is grantable if it can be used as the role in a binding for a policy for that resource.
Example ¶
package main import ( "context" admin "cloud.google.com/go/iam/admin/apiv1" "cloud.google.com/go/iam/admin/apiv1/adminpb" ) func main() { ctx := context.Background() c, err := admin.NewIamClient(ctx) if err != nil { // TODO: Handle error. } req := &adminpb.QueryGrantableRolesRequest{ // TODO: Fill request struct fields. } resp, err := c.QueryGrantableRoles(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*IamClient) QueryTestablePermissions ¶
func (c *IamClient) QueryTestablePermissions(ctx context.Context, req *adminpb.QueryTestablePermissionsRequest, opts ...gax.CallOption) (*adminpb.QueryTestablePermissionsResponse, error)
QueryTestablePermissions lists the permissions testable on a resource. A permission is testable if it can be tested for an identity on a resource.
Example ¶
package main import ( "context" admin "cloud.google.com/go/iam/admin/apiv1" "cloud.google.com/go/iam/admin/apiv1/adminpb" ) func main() { ctx := context.Background() c, err := admin.NewIamClient(ctx) if err != nil { // TODO: Handle error. } req := &adminpb.QueryTestablePermissionsRequest{ // TODO: Fill request struct fields. } resp, err := c.QueryTestablePermissions(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*IamClient) SetIamPolicy ¶
func (c *IamClient) SetIamPolicy(ctx context.Context, req *SetIamPolicyRequest) (*iam.Policy, error)
SetIamPolicy sets the IAM access control policy for a ServiceAccount.
func (*IamClient) SignBlob ¶
func (c *IamClient) SignBlob(ctx context.Context, req *adminpb.SignBlobRequest, opts ...gax.CallOption) (*adminpb.SignBlobResponse, error)
SignBlob signs a blob using a service account's system-managed private key.
Example ¶
package main import ( "context" admin "cloud.google.com/go/iam/admin/apiv1" "cloud.google.com/go/iam/admin/apiv1/adminpb" ) func main() { ctx := context.Background() c, err := admin.NewIamClient(ctx) if err != nil { // TODO: Handle error. } req := &adminpb.SignBlobRequest{ // TODO: Fill request struct fields. } resp, err := c.SignBlob(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*IamClient) SignJwt ¶
func (c *IamClient) SignJwt(ctx context.Context, req *adminpb.SignJwtRequest, opts ...gax.CallOption) (*adminpb.SignJwtResponse, error)
SignJwt signs a JWT using a service account's system-managed private key.
If no expiry time (exp) is provided in the SignJwtRequest, IAM sets an an expiry time of one hour by default. If you request an expiry time of more than one hour, the request will fail.
Example ¶
package main import ( "context" admin "cloud.google.com/go/iam/admin/apiv1" "cloud.google.com/go/iam/admin/apiv1/adminpb" ) func main() { ctx := context.Background() c, err := admin.NewIamClient(ctx) if err != nil { // TODO: Handle error. } req := &adminpb.SignJwtRequest{ // TODO: Fill request struct fields. } resp, err := c.SignJwt(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*IamClient) TestIamPermissions ¶
func (c *IamClient) TestIamPermissions(ctx context.Context, req *iampb.TestIamPermissionsRequest, opts ...gax.CallOption) (*iampb.TestIamPermissionsResponse, error)
TestIamPermissions tests the specified permissions against the IAM access control policy for a [ServiceAccount][google.iam.admin.v1.ServiceAccount].
Example ¶
package main import ( "context" admin "cloud.google.com/go/iam/admin/apiv1" "cloud.google.com/go/iam/apiv1/iampb" ) func main() { ctx := context.Background() c, err := admin.NewIamClient(ctx) if err != nil { // TODO: Handle error. } req := &iampb.TestIamPermissionsRequest{ // TODO: Fill request struct fields. } resp, err := c.TestIamPermissions(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*IamClient) UndeleteRole ¶
func (c *IamClient) UndeleteRole(ctx context.Context, req *adminpb.UndeleteRoleRequest, opts ...gax.CallOption) (*adminpb.Role, error)
UndeleteRole undelete a Role, bringing it back in its previous state.
Example ¶
package main import ( "context" admin "cloud.google.com/go/iam/admin/apiv1" "cloud.google.com/go/iam/admin/apiv1/adminpb" ) func main() { ctx := context.Background() c, err := admin.NewIamClient(ctx) if err != nil { // TODO: Handle error. } req := &adminpb.UndeleteRoleRequest{ // TODO: Fill request struct fields. } resp, err := c.UndeleteRole(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*IamClient) UpdateRole ¶
func (c *IamClient) UpdateRole(ctx context.Context, req *adminpb.UpdateRoleRequest, opts ...gax.CallOption) (*adminpb.Role, error)
UpdateRole updates a Role definition.
Example ¶
package main import ( "context" admin "cloud.google.com/go/iam/admin/apiv1" "cloud.google.com/go/iam/admin/apiv1/adminpb" ) func main() { ctx := context.Background() c, err := admin.NewIamClient(ctx) if err != nil { // TODO: Handle error. } req := &adminpb.UpdateRoleRequest{ // TODO: Fill request struct fields. } resp, err := c.UpdateRole(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*IamClient) UpdateServiceAccount ¶
func (c *IamClient) UpdateServiceAccount(ctx context.Context, req *adminpb.ServiceAccount, opts ...gax.CallOption) (*adminpb.ServiceAccount, error)
UpdateServiceAccount updates a [ServiceAccount][google.iam.admin.v1.ServiceAccount].
Currently, only the following fields are updatable: display_name . The etag is mandatory.
Example ¶
package main import ( "context" admin "cloud.google.com/go/iam/admin/apiv1" "cloud.google.com/go/iam/admin/apiv1/adminpb" ) func main() { ctx := context.Background() c, err := admin.NewIamClient(ctx) if err != nil { // TODO: Handle error. } req := &adminpb.ServiceAccount{ // TODO: Fill request struct fields. } resp, err := c.UpdateServiceAccount(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
type ServiceAccountIterator ¶
type ServiceAccountIterator struct { // InternalFetch is for use by the Google Cloud Libraries only. // It is not part of the stable interface of this package. // // InternalFetch returns results from a single call to the underlying RPC. // The number of results is no greater than pageSize. // If there are no more results, nextPageToken is empty and err is nil. InternalFetch func(pageSize int, pageToken string) (results []*adminpb.ServiceAccount, nextPageToken string, err error) // contains filtered or unexported fields }
ServiceAccountIterator manages a stream of *adminpb.ServiceAccount.
func (*ServiceAccountIterator) Next ¶
func (it *ServiceAccountIterator) Next() (*adminpb.ServiceAccount, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*ServiceAccountIterator) PageInfo ¶
func (it *ServiceAccountIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type SetIamPolicyRequest ¶
SetIamPolicyRequest is the request type for the SetIamPolicy method.