sts
packageThis package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Documentation¶
Overview¶
Package sts provides access to the Security Token Service API.
For product documentation, see:http://cloud.google.com/iam/docs/workload-identity-federation
Library status¶
These client libraries are officially supported by Google. However, thislibrary is considered complete and is in maintenance mode. This meansthat we will address critical bugs and security issues but will not addany new features.
When possible, we recommend using our newer[Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)that are still actively being worked and iterated on.
Creating a client¶
Usage example:
import "google.golang.org/api/sts/v1"...ctx := context.Background()stsService, err := sts.NewService(ctx)
In this example, Google Application Default Credentials are used forauthentication. For information on how to create and obtain ApplicationDefault Credentials, seehttps://developers.google.com/identity/protocols/application-default-credentials.
Other authentication options¶
To use an API key for authentication (note: some APIs do not support APIkeys), usegoogle.golang.org/api/option.WithAPIKey:
stsService, err := sts.NewService(ctx, option.WithAPIKey("AIza..."))To use an OAuth token (e.g., a user token obtained via a three-legged OAuthflow, usegoogle.golang.org/api/option.WithTokenSource:
config := &oauth2.Config{...}// ...token, err := config.Exchange(ctx, ...)stsService, err := sts.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))Seegoogle.golang.org/api/option.ClientOption for details on options.
Index¶
- type GoogleIamV1Binding
- type GoogleIdentityStsV1AccessBoundary
- type GoogleIdentityStsV1AccessBoundaryRule
- type GoogleIdentityStsV1ExchangeTokenRequest
- type GoogleIdentityStsV1ExchangeTokenResponse
- type GoogleIdentityStsV1Options
- type GoogleIdentityStsV1betaAccessBoundary
- type GoogleIdentityStsV1betaAccessBoundaryRule
- type GoogleIdentityStsV1betaOptions
- type GoogleTypeExpr
- type Service
- type V1Service
- type V1TokenCall
Constants¶
This section is empty.
Variables¶
This section is empty.
Functions¶
This section is empty.
Types¶
typeGoogleIamV1Binding¶added inv0.55.0
type GoogleIamV1Binding struct {// Condition: The condition that is associated with this binding. If the// condition evaluates to `true`, then this binding applies to the current// request. If the condition evaluates to `false`, then this binding does not// apply to the current request. However, a different role binding might grant// the same role to one or more of the principals in this binding. To learn// which resources support conditions in their IAM policies, see the IAM// documentation// (https://cloud.google.com/iam/help/conditions/resource-policies).Condition *GoogleTypeExpr `json:"condition,omitempty"`// Members: Specifies the principals requesting access for a Google Cloud// resource. `members` can have the following values: * `allUsers`: A special// identifier that represents anyone who is on the internet; with or without a// Google account. * `allAuthenticatedUsers`: A special identifier that// represents anyone who is authenticated with a Google account or a service// account. Does not include identities that come from external identity// providers (IdPs) through identity federation. * `user:{emailid}`: An email// address that represents a specific Google account. For example,// `alice@example.com` . * `serviceAccount:{emailid}`: An email address that// represents a Google service account. For example,// `my-other-app@appspot.gserviceaccount.com`. *// `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An// identifier for a Kubernetes service account// (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).// For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. *// `group:{emailid}`: An email address that represents a Google group. For// example, `admins@example.com`. * `domain:{domain}`: The G Suite domain// (primary) that represents all the users of that domain. For example,// `google.com` or `example.com`. *// `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/sub// ject/{subject_attribute_value}`: A single identity in a workforce identity// pool. *// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/// group/{group_id}`: All workforce identities in a group. *// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/// attribute.{attribute_name}/{attribute_value}`: All workforce identities with// a specific attribute value. *// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/// *`: All identities in a workforce identity pool. *// `principal://iam.googleapis.com/projects/{project_number}/locations/global/wo// rkloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single// identity in a workload identity pool. *// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global// /workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool// group. *// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global// /workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}// `: All identities in a workload identity pool with a certain attribute. *// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global// /workloadIdentityPools/{pool_id}/*`: All identities in a workload identity// pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus// unique identifier) representing a user that has been recently deleted. For// example, `alice@example.com?uid=123456789012345678901`. If the user is// recovered, this value reverts to `user:{emailid}` and the recovered user// retains the role in the binding. *// `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus// unique identifier) representing a service account that has been recently// deleted. For example,// `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the// service account is undeleted, this value reverts to// `serviceAccount:{emailid}` and the undeleted service account retains the// role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email// address (plus unique identifier) representing a Google group that has been// recently deleted. For example,// `admins@example.com?uid=123456789012345678901`. If the group is recovered,// this value reverts to `group:{emailid}` and the recovered group retains the// role in the binding. *// `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool// _id}/subject/{subject_attribute_value}`: Deleted single identity in a// workforce identity pool. For example,// `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-po// ol-id/subject/my-subject-attribute-value`.Members []string `json:"members,omitempty"`// Role: Role that is assigned to the list of `members`, or principals. For// example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview// of the IAM roles and permissions, see the IAM documentation// (https://cloud.google.com/iam/docs/roles-overview). For a list of the// available pre-defined roles, see here// (https://cloud.google.com/iam/docs/understanding-roles).Rolestring `json:"role,omitempty"`// ForceSendFields is a list of field names (e.g. "Condition") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Condition") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleIamV1Binding: Associates `members`, or principals, with a `role`.
func (GoogleIamV1Binding)MarshalJSON¶added inv0.55.0
func (sGoogleIamV1Binding) MarshalJSON() ([]byte,error)
typeGoogleIdentityStsV1AccessBoundary¶added inv0.55.0
type GoogleIdentityStsV1AccessBoundary struct {// AccessBoundaryRules: A list of access boundary rules which defines the upper// bound of the permission a principal may carry. If multiple rules are// specified, the effective access boundary is the union of all the access// boundary rules attached. One access boundary can contain at most 10 rules.AccessBoundaryRules []*GoogleIdentityStsV1AccessBoundaryRule `json:"accessBoundaryRules,omitempty"`// ForceSendFields is a list of field names (e.g. "AccessBoundaryRules") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AccessBoundaryRules") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleIdentityStsV1AccessBoundary: An access boundary defines the upperbound of what a principal may access. It includes a list of access boundaryrules that each defines the resource that may be allowed as well aspermissions that may be used on those resources.
func (GoogleIdentityStsV1AccessBoundary)MarshalJSON¶added inv0.55.0
func (sGoogleIdentityStsV1AccessBoundary) MarshalJSON() ([]byte,error)
typeGoogleIdentityStsV1AccessBoundaryRule¶added inv0.55.0
type GoogleIdentityStsV1AccessBoundaryRule struct {// AvailabilityCondition: The availability condition further constrains the// access allowed by the access boundary rule. If the condition evaluates to// `true`, then this access boundary rule will provide access to the specified// resource, assuming the principal has the required permissions for the// resource. If the condition does not evaluate to `true`, then access to the// specified resource will not be available. Note that all access boundary// rules in an access boundary are evaluated together as a union. As such,// another access boundary rule may allow access to the resource, even if this// access boundary rule does not allow access. To learn which resources support// conditions in their IAM policies, see the IAM documentation// (https://cloud.google.com/iam/help/conditions/resource-policies). The// maximum length of the `expression` field is 2048 characters.AvailabilityCondition *GoogleTypeExpr `json:"availabilityCondition,omitempty"`// AvailablePermissions: A list of permissions that may be allowed for use on// the specified resource. The only supported values in the list are IAM roles,// following the format of google.iam.v1.Binding.role. Example value:// `inRole:roles/logging.viewer` for predefined roles and// `inRole:organizations/{ORGANIZATION_ID}/roles/logging.viewer` for custom// roles.AvailablePermissions []string `json:"availablePermissions,omitempty"`// AvailableResource: The full resource name of a Google Cloud resource entity.// The format definition is at//https://cloud.google.com/apis/design/resource_names. Example value:// `//cloudresourcemanager.googleapis.com/projects/my-project`.AvailableResourcestring `json:"availableResource,omitempty"`// ForceSendFields is a list of field names (e.g. "AvailabilityCondition") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AvailabilityCondition") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleIdentityStsV1AccessBoundaryRule: An access boundary rule defines anupper bound of IAM permissions on a single resource.
func (GoogleIdentityStsV1AccessBoundaryRule)MarshalJSON¶added inv0.55.0
func (sGoogleIdentityStsV1AccessBoundaryRule) MarshalJSON() ([]byte,error)
typeGoogleIdentityStsV1ExchangeTokenRequest¶
type GoogleIdentityStsV1ExchangeTokenRequest struct {// Audience: The full resource name of the identity provider; for example:// `//iam.googleapis.com/projects//locations/global/workloadIdentityPools//provi// ders/` for workload identity pool providers, or// `//iam.googleapis.com/locations/global/workforcePools//providers/` for// workforce pool providers. Required when exchanging an external credential// for a Google access token.Audiencestring `json:"audience,omitempty"`// GrantType: Required. The grant type. Must be// `urn:ietf:params:oauth:grant-type:token-exchange`, which indicates a token// exchange.GrantTypestring `json:"grantType,omitempty"`// Options: A set of features that Security Token Service supports, in addition// to the standard OAuth 2.0 token exchange, formatted as a serialized JSON// object of Options. The size of the parameter value must not exceed 4 * 1024// * 1024 characters (4 MB).Optionsstring `json:"options,omitempty"`// RequestedTokenType: Required. An identifier for the type of requested// security token. Can be `urn:ietf:params:oauth:token-type:access_token` or// `urn:ietf:params:oauth:token-type:access_boundary_intermediary_token`.RequestedTokenTypestring `json:"requestedTokenType,omitempty"`// Scope: The OAuth 2.0 scopes to include on the resulting access token,// formatted as a list of space-delimited, case-sensitive strings; for example,// `https://www.googleapis.com/auth/cloud-platform`. Required when exchanging// an external credential for a Google access token. For a list of OAuth 2.0// scopes, see OAuth 2.0 Scopes for Google APIs// (https://developers.google.com/identity/protocols/oauth2/scopes).Scopestring `json:"scope,omitempty"`// SubjectToken: Required. The input token. This token is either an external// credential issued by a workload identity pool provider, or a short-lived// access token issued by Google. If the token is an OIDC JWT, it must use the// JWT format defined inRFC 7523 (https://tools.ietf.org/html/rfc7523), and// the `subject_token_type` must be either// `urn:ietf:params:oauth:token-type:jwt` or// `urn:ietf:params:oauth:token-type:id_token`. The following headers are// required: - `kid`: The identifier of the signing key securing the JWT. -// `alg`: The cryptographic algorithm securing the JWT. Must be `RS256` or// `ES256`. The following payload fields are required. For more information,// seeRFC 7523, Section 3 (https://tools.ietf.org/html/rfc7523#section-3): -// `iss`: The issuer of the token. The issuer must provide a discovery document// at the URL `/.well-known/openid-configuration`, where “ is the value of// this field. The document must be formatted according to section 4.2 of the// OIDC 1.0 Discovery specification// (https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationResponse).// - `iat`: The issue time, in seconds, since the Unix epoch. Must be in the// past. - `exp`: The expiration time, in seconds, since the Unix epoch. Must// be less than 48 hours after `iat`. Shorter expiration times are more secure.// If possible, we recommend setting an expiration time less than 6 hours. -// `sub`: The identity asserted in the JWT. - `aud`: For workload identity// pools, this must be a value specified in the allowed audiences for the// workload identity pool provider, or one of the audiences allowed by default// if no audiences were specified. See//https://cloud.google.com/iam/docs/reference/rest/v1/projects.locations.workloadIdentityPools.providers#oidc.// For workforce pools, this must match the client ID specified in the provider// configuration. See//https://cloud.google.com/iam/docs/reference/rest/v1/locations.workforcePools.providers#oidc.// Example header: “` { "alg": "RS256", "kid": "us-east-11" } “` Example// payload: “` { "iss": "https://accounts.google.com", "iat": 1517963104,// "exp": 1517966704, "aud":// "//iam.googleapis.com/projects/1234567890123/locations/global/workloadIdentit// yPools/my-pool/providers/my-provider", "sub": "113475438248934895348",// "my_claims": { "additional_claim": "value" } } “` If `subject_token` is for// AWS, it must be a serialized `GetCallerIdentity` token. This token contains// the same information as a request to the AWS `GetCallerIdentity()`// (https://docs.aws.amazon.com/STS/latest/APIReference/API_GetCallerIdentity)// method, as well as the AWS signature// (https://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html)// for the request information. Use Signature Version 4. Format the request as// URL-encoded JSON, and set the `subject_token_type` parameter to// `urn:ietf:params:aws:token-type:aws4_request`. The following parameters are// required: - `url`: The URL of the AWS STS endpoint for// `GetCallerIdentity()`, such as// `https://sts.amazonaws.com?Action=GetCallerIdentity&Version=2011-06-15`.// Regional endpoints are also supported. - `method`: The HTTP request method:// `POST`. - `headers`: The HTTP request headers, which must include: -// `Authorization`: The request signature. - `x-amz-date`: The time you will// send the request, formatted as an ISO8601 Basic// (https://docs.aws.amazon.com/general/latest/gr/sigv4_elements.html#sigv4_elements_date)// string. This value is typically set to the current time and is used to help// prevent replay attacks. - `host`: The hostname of the `url` field; for// example, `sts.amazonaws.com`. - `x-goog-cloud-target-resource`: The full,// canonical resource name of the workload identity pool provider, with or// without an `https:` prefix. To help ensure data integrity, we recommend// including this header in the `SignedHeaders` field of the signed request.// For example:// //iam.googleapis.com/projects//locations/global/workloadIdentityPools//provid// ers///https://iam.googleapis.com/projects//locations/global/workloadIdentityPools//providers/// If you are using temporary security credentials provided by AWS, you must// also include the header `x-amz-security-token`, with the value set to the// session token. The following example shows a `GetCallerIdentity` token: “`// { "headers": [ {"key": "x-amz-date", "value": "20200815T015049Z"}, {"key":// "Authorization", "value":// "AWS4-HMAC-SHA256+Credential=$credential,+SignedHeaders=host;x-amz-date;x-goo// g-cloud-target-resource,+Signature=$signature"}, {"key":// "x-goog-cloud-target-resource", "value":// "//iam.googleapis.com/projects//locations/global/workloadIdentityPools//provi// ders/"}, {"key": "host", "value": "sts.amazonaws.com"} . ], "method":// "POST", "url":// "https://sts.amazonaws.com?Action=GetCallerIdentity&Version=2011-06-15" }// “` If the token is a SAML 2.0 assertion, it must use the format defined in// the SAML 2.0 spec// (https://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0-cd-02.pdf),// and the `subject_token_type` must be// `urn:ietf:params:oauth:token-type:saml2`. See Verification of external// credentials// (https://cloud.google.com/iam/docs/using-workload-identity-federation#verification_of_external_credentials)// for details on how SAML 2.0 assertions are validated during token exchanges.// You can also use a Google-issued OAuth 2.0 access token with this field to// obtain an access token with new security attributes applied, such as a// Credential Access Boundary. In this case, set `subject_token_type` to// `urn:ietf:params:oauth:token-type:access_token`. If an access token already// contains security attributes, you cannot apply additional security// attributes. If the request is for X.509 certificate-based authentication,// the `subject_token` must be a JSON-formatted list of X.509 certificates in// DER format, as defined inRFC 7515// (https://www.rfc-editor.org/rfc/rfc7515#section-4.1.6). `subject_token_type`// must be `urn:ietf:params:oauth:token-type:mtls`. The following example shows// a JSON-formatted list of X.509 certificate in DER format: “`// [\"MIIEYDCCA0i...\", \"MCIFFGAGTT0...\"] “`SubjectTokenstring `json:"subjectToken,omitempty"`// SubjectTokenType: Required. An identifier that indicates the type of the// security token in the `subject_token` parameter. Supported values are// `urn:ietf:params:oauth:token-type:jwt`,// `urn:ietf:params:oauth:token-type:id_token`,// `urn:ietf:params:aws:token-type:aws4_request`,// `urn:ietf:params:oauth:token-type:access_token`,// `urn:ietf:params:oauth:token-type:mtls`, and// `urn:ietf:params:oauth:token-type:saml2`.SubjectTokenTypestring `json:"subjectTokenType,omitempty"`// ForceSendFields is a list of field names (e.g. "Audience") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Audience") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleIdentityStsV1ExchangeTokenRequest: Request message for ExchangeToken.
func (GoogleIdentityStsV1ExchangeTokenRequest)MarshalJSON¶
func (sGoogleIdentityStsV1ExchangeTokenRequest) MarshalJSON() ([]byte,error)
typeGoogleIdentityStsV1ExchangeTokenResponse¶
type GoogleIdentityStsV1ExchangeTokenResponse struct {// AccessBoundarySessionKey: The access boundary session key. This key is used// along with the access boundary intermediary token to generate Credential// Access Boundary tokens at client side. This field is absent when the// `requested_token_type` from the request is not// `urn:ietf:params:oauth:token-type:access_boundary_intermediary_token`.AccessBoundarySessionKeystring `json:"access_boundary_session_key,omitempty"`// AccessToken: An OAuth 2.0 security token, issued by Google, in response to// the token exchange request. Tokens can vary in size, depending in part on// the size of mapped claims, up to a maximum of 12288 bytes (12 KB). Google// reserves the right to change the token size and the maximum length at any// time.AccessTokenstring `json:"access_token,omitempty"`// ExpiresIn: The amount of time, in seconds, between the time when the access// token was issued and the time when the access token will expire. This field// is absent when the `subject_token` in the request is a a short-lived access// token for a Cloud Identity or Google Workspace user account. In this case,// the access token has the same expiration time as the `subject_token`.ExpiresInint64 `json:"expires_in,omitempty"`// IssuedTokenType: The token type. Always matches the value of// `requested_token_type` from the request.IssuedTokenTypestring `json:"issued_token_type,omitempty"`// TokenType: The type of access token. Always has the value `Bearer`.TokenTypestring `json:"token_type,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AccessBoundarySessionKey")// to unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AccessBoundarySessionKey") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleIdentityStsV1ExchangeTokenResponse: Response message forExchangeToken.
func (GoogleIdentityStsV1ExchangeTokenResponse)MarshalJSON¶
func (sGoogleIdentityStsV1ExchangeTokenResponse) MarshalJSON() ([]byte,error)
typeGoogleIdentityStsV1Options¶added inv0.55.0
type GoogleIdentityStsV1Options struct {// AccessBoundary: An access boundary that defines the upper bound of// permissions the credential may have. The value should be a JSON object of// AccessBoundary. The access boundary can include up to 10 rules. The size of// the parameter value should not exceed 2048 characters.AccessBoundary *GoogleIdentityStsV1AccessBoundary `json:"accessBoundary,omitempty"`// BindCertFingerprint: The unpadded, base64url-encoded SHA-256 hash of the// certificate's DER encoding and it must be 43 characters long. The resulting// token will be bound to this value.BindCertFingerprintstring `json:"bindCertFingerprint,omitempty"`// UserProject: A Google project used for quota and billing purposes when the// credential is used to access Google APIs. The provided project overrides the// project bound to the credential. The value must be a project number or a// project ID. Example: `my-sample-project-191923`. The maximum length is 32// characters.UserProjectstring `json:"userProject,omitempty"`// ForceSendFields is a list of field names (e.g. "AccessBoundary") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AccessBoundary") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleIdentityStsV1Options: An `Options` object configures features that theSecurity Token Service supports, but that are not supported by standardOAuth 2.0 token exchange endpoints, as defined inhttps://tools.ietf.org/html/rfc8693.
func (GoogleIdentityStsV1Options)MarshalJSON¶added inv0.55.0
func (sGoogleIdentityStsV1Options) MarshalJSON() ([]byte,error)
typeGoogleIdentityStsV1betaAccessBoundary¶added inv0.55.0
type GoogleIdentityStsV1betaAccessBoundary struct {// AccessBoundaryRules: A list of access boundary rules which defines the upper// bound of the permission a principal may carry. If multiple rules are// specified, the effective access boundary is the union of all the access// boundary rules attached. One access boundary can contain at most 10 rules.AccessBoundaryRules []*GoogleIdentityStsV1betaAccessBoundaryRule `json:"accessBoundaryRules,omitempty"`// ForceSendFields is a list of field names (e.g. "AccessBoundaryRules") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AccessBoundaryRules") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleIdentityStsV1betaAccessBoundary: An access boundary defines the upperbound of what a principal may access. It includes a list of access boundaryrules that each defines the resource that may be allowed as well aspermissions that may be used on those resources.
func (GoogleIdentityStsV1betaAccessBoundary)MarshalJSON¶added inv0.55.0
func (sGoogleIdentityStsV1betaAccessBoundary) MarshalJSON() ([]byte,error)
typeGoogleIdentityStsV1betaAccessBoundaryRule¶added inv0.55.0
type GoogleIdentityStsV1betaAccessBoundaryRule struct {// AvailabilityCondition: The availability condition further constrains the// access allowed by the access boundary rule. If the condition evaluates to// `true`, then this access boundary rule will provide access to the specified// resource, assuming the principal has the required permissions for the// resource. If the condition does not evaluate to `true`, then access to the// specified resource will not be available. Note that all access boundary// rules in an access boundary are evaluated together as a union. As such,// another access boundary rule may allow access to the resource, even if this// access boundary rule does not allow access. To learn which resources support// conditions in their IAM policies, see the IAM documentation// (https://cloud.google.com/iam/help/conditions/resource-policies). The// maximum length of the `expression` field is 2048 characters.AvailabilityCondition *GoogleTypeExpr `json:"availabilityCondition,omitempty"`// AvailablePermissions: A list of permissions that may be allowed for use on// the specified resource. The only supported values in the list are IAM roles,// following the format of google.iam.v1.Binding.role. Example value:// `inRole:roles/logging.viewer` for predefined roles and// `inRole:organizations/{ORGANIZATION_ID}/roles/logging.viewer` for custom// roles.AvailablePermissions []string `json:"availablePermissions,omitempty"`// AvailableResource: The full resource name of a Google Cloud resource entity.// The format definition is at//https://cloud.google.com/apis/design/resource_names. Example value:// `//cloudresourcemanager.googleapis.com/projects/my-project`.AvailableResourcestring `json:"availableResource,omitempty"`// ForceSendFields is a list of field names (e.g. "AvailabilityCondition") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AvailabilityCondition") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleIdentityStsV1betaAccessBoundaryRule: An access boundary rule definesan upper bound of IAM permissions on a single resource.
func (GoogleIdentityStsV1betaAccessBoundaryRule)MarshalJSON¶added inv0.55.0
func (sGoogleIdentityStsV1betaAccessBoundaryRule) MarshalJSON() ([]byte,error)
typeGoogleIdentityStsV1betaOptions¶added inv0.55.0
type GoogleIdentityStsV1betaOptions struct {// AccessBoundary: An access boundary that defines the upper bound of// permissions the credential may have. The value should be a JSON object of// AccessBoundary. The access boundary can include up to 10 rules. The size of// the parameter value should not exceed 2048 characters.AccessBoundary *GoogleIdentityStsV1betaAccessBoundary `json:"accessBoundary,omitempty"`// UserProject: A Google project used for quota and billing purposes when the// credential is used to access Google APIs. The provided project overrides the// project bound to the credential. The value must be a project number or a// project ID. Example: `my-sample-project-191923`. The maximum length is 32// characters.UserProjectstring `json:"userProject,omitempty"`// ForceSendFields is a list of field names (e.g. "AccessBoundary") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AccessBoundary") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleIdentityStsV1betaOptions: An `Options` object configures features thatthe Security Token Service supports, but that are not supported by standardOAuth 2.0 token exchange endpoints, as defined inhttps://tools.ietf.org/html/rfc8693.
func (GoogleIdentityStsV1betaOptions)MarshalJSON¶added inv0.55.0
func (sGoogleIdentityStsV1betaOptions) MarshalJSON() ([]byte,error)
typeGoogleTypeExpr¶added inv0.55.0
type GoogleTypeExpr struct {// Description: Optional. Description of the expression. This is a longer text// which describes the expression, e.g. when hovered over it in a UI.Descriptionstring `json:"description,omitempty"`// Expression: Textual representation of an expression in Common Expression// Language syntax.Expressionstring `json:"expression,omitempty"`// Location: Optional. String indicating the location of the expression for// error reporting, e.g. a file name and a position in the file.Locationstring `json:"location,omitempty"`// Title: Optional. Title for the expression, i.e. a short string describing// its purpose. This can be used e.g. in UIs which allow to enter the// expression.Titlestring `json:"title,omitempty"`// ForceSendFields is a list of field names (e.g. "Description") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Description") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}GoogleTypeExpr: Represents a textual expression in the Common ExpressionLanguage (CEL) syntax. CEL is a C-like expression language. The syntax andsemantics of CEL are documented athttps://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determinesif a summary is less than 100 chars" expression: "document.summary.size() <100" Example (Equality): title: "Requestor is owner" description:"Determines if requestor is the document owner" expression: "document.owner== request.auth.claims.email" Example (Logic): title: "Public documents"description: "Determine whether the document should be publicly visible"expression: "document.type != 'private' && document.type != 'internal'"Example (Data Manipulation): title: "Notification string" description:"Create a notification string with a timestamp." expression: "'New messagereceived at ' + string(document.create_time)" The exact variables andfunctions that may be referenced within an expression are determined by theservice that evaluates it. See the service documentation for additionalinformation.
func (GoogleTypeExpr)MarshalJSON¶added inv0.55.0
func (sGoogleTypeExpr) MarshalJSON() ([]byte,error)
typeService¶
type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentV1 *V1Service// contains filtered or unexported fields} funcNewdeprecated
New creates a new Service. It uses the provided http.Client for requests.
Deprecated: please use NewService instead.To provide a custom HTTP client, use option.WithHTTPClient.If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
funcNewService¶
NewService creates a new Service.
typeV1Service¶
type V1Service struct {// contains filtered or unexported fields}funcNewV1Service¶
func (*V1Service)Token¶
func (r *V1Service) Token(googleidentitystsv1exchangetokenrequest *GoogleIdentityStsV1ExchangeTokenRequest) *V1TokenCall
Token: Exchanges a credential for a Google OAuth 2.0 access token. The tokenasserts an external identity within an identity pool, or it applies aCredential Access Boundary to a Google access token. Note that workforcepools do not support Credential Access Boundaries. When you call thismethod, do not send the `Authorization` HTTP header in the request. Thismethod does not require the `Authorization` header, and using the header cancause the request to fail.
typeV1TokenCall¶
type V1TokenCall struct {// contains filtered or unexported fields}func (*V1TokenCall)Context¶
func (c *V1TokenCall) Context(ctxcontext.Context) *V1TokenCall
Context sets the context to be used in this call's Do method.
func (*V1TokenCall)Do¶
func (c *V1TokenCall) Do(opts ...googleapi.CallOption) (*GoogleIdentityStsV1ExchangeTokenResponse,error)
Do executes the "sts.token" call.Any non-2xx status code is an error. Response headers are in either*GoogleIdentityStsV1ExchangeTokenResponse.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.
func (*V1TokenCall)Fields¶
func (c *V1TokenCall) Fields(s ...googleapi.Field) *V1TokenCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*V1TokenCall)Header¶
func (c *V1TokenCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.