You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<pclass="firstline">Gets information about a Google OAuth 2.0 access token issued by the Google Cloud [Security Token Service API](https://cloud.google.com/iam/docs/reference/sts/rest).</p>
<pclass="firstline">Exchanges a credential for a Google OAuth 2.0 access token. The token asserts an external identity within a workload identity pool, or it applies a Credential Access Boundary to a Google access token. When you call this method, do not send the `Authorization` HTTP header in the request. This method does not require the `Authorization` header, and using the header can cause the request to fail.</p>
<pre>Gets information about a Google OAuth 2.0 access token issued by the Google Cloud [Security Token Service API](https://cloud.google.com/iam/docs/reference/sts/rest).
95
+
96
+
Args:
97
+
body: object, The request body.
98
+
The object takes the form of:
99
+
100
+
{ # Request message for IntrospectToken.
101
+
"token": "A String", # Required. The OAuth 2.0 security token issued by the Security Token Service API.
102
+
"tokenTypeHint": "A String", # Optional. The type of the given token. Supported values are `urn:ietf:params:oauth:token-type:access_token` and `access_token`.
103
+
}
104
+
105
+
x__xgafv: string, V1 error format.
106
+
Allowed values
107
+
1 - v1 error format
108
+
2 - v2 error format
109
+
110
+
Returns:
111
+
An object of the form:
112
+
113
+
{ # Response message for IntrospectToken.
114
+
"active": True or False, # A boolean value that indicates whether the provided access token is currently active.
115
+
"client_id": "A String", # The client identifier for the OAuth 2.0 client that requested the provided token.
116
+
"exp": "A String", # The expiration timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token will expire.
117
+
"iat": "A String", # The issued timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token was originally issued.
118
+
"iss": "A String", # The issuer of the provided token.
119
+
"scope": "A String", # A list of scopes associated with the provided token.
120
+
"sub": "A String", # The unique user ID associated with the provided token. For Google Accounts, this value is based on the Google Account's user ID. For federated identities, this value is based on the identity pool ID and the value of the mapped `google.subject` attribute.
121
+
"username": "A String", # The human-readable identifier for the token principal subject. For example, if the provided token is associated with a workload identity pool, this field contains a value in the following format: `principal://iam.googleapis.com/projects//locations/global/workloadIdentityPools//subject/`
<pre>Exchanges a credential for a Google OAuth 2.0 access token. The token asserts an external identity within a workload identity pool, or it applies a Credential Access Boundary to a Google access token. When you call this method, do not send the `Authorization` HTTP header in the request. This method does not require the `Authorization` header, and using the header can cause the request to fail.
Copy file name to clipboardExpand all lines: googleapiclient/discovery_cache/documents/sts.v1.json
+72-1Lines changed: 72 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -98,6 +98,21 @@
98
98
"resources": {
99
99
"v1": {
100
100
"methods": {
101
+
"introspect": {
102
+
"description": "Gets information about a Google OAuth 2.0 access token issued by the Google Cloud [Security Token Service API](https://cloud.google.com/iam/docs/reference/sts/rest).",
"description": "Exchanges a credential for a Google OAuth 2.0 access token. The token asserts an external identity within a workload identity pool, or it applies a Credential Access Boundary to a Google access token. When you call this method, do not send the `Authorization` HTTP header in the request. This method does not require the `Authorization` header, and using the header can cause the request to fail.",
103
118
"flatPath": "v1/token",
@@ -116,7 +131,7 @@
116
131
}
117
132
}
118
133
},
119
-
"revision": "20210827",
134
+
"revision": "20210910",
120
135
"rootUrl": "https://sts.googleapis.com/",
121
136
"schemas": {
122
137
"GoogleIamV1Binding": {
@@ -236,6 +251,62 @@
236
251
},
237
252
"type": "object"
238
253
},
254
+
"GoogleIdentityStsV1IntrospectTokenRequest": {
255
+
"description": "Request message for IntrospectToken.",
"description": "A boolean value that indicates whether the provided access token is currently active.",
275
+
"type": "boolean"
276
+
},
277
+
"client_id": {
278
+
"description": "The client identifier for the OAuth 2.0 client that requested the provided token.",
279
+
"type": "string"
280
+
},
281
+
"exp": {
282
+
"description": "The expiration timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token will expire.",
283
+
"format": "int64",
284
+
"type": "string"
285
+
},
286
+
"iat": {
287
+
"description": "The issued timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token was originally issued.",
288
+
"format": "int64",
289
+
"type": "string"
290
+
},
291
+
"iss": {
292
+
"description": "The issuer of the provided token.",
293
+
"type": "string"
294
+
},
295
+
"scope": {
296
+
"description": "A list of scopes associated with the provided token.",
297
+
"type": "string"
298
+
},
299
+
"sub": {
300
+
"description": "The unique user ID associated with the provided token. For Google Accounts, this value is based on the Google Account's user ID. For federated identities, this value is based on the identity pool ID and the value of the mapped `google.subject` attribute.",
301
+
"type": "string"
302
+
},
303
+
"username": {
304
+
"description": "The human-readable identifier for the token principal subject. For example, if the provided token is associated with a workload identity pool, this field contains a value in the following format: `principal://iam.googleapis.com/projects//locations/global/workloadIdentityPools//subject/`",
305
+
"type": "string"
306
+
}
307
+
},
308
+
"type": "object"
309
+
},
239
310
"GoogleIdentityStsV1Options": {
240
311
"description": "An `Options` object configures features that the Security Token Service supports, but that are not supported by standard OAuth 2.0 token exchange endpoints, as defined in https://tools.ietf.org/html/rfc8693.",
0 commit comments