|
1605 | 1605 | }
|
1606 | 1606 | }
|
1607 | 1607 | },
|
| 1608 | + "inboundOidcSsoProfiles": { |
| 1609 | + "methods": { |
| 1610 | + "create": { |
| 1611 | + "description": "Creates an InboundOidcSsoProfile for a customer. When the target customer has enabled [Multi-party approval for sensitive actions](https://support.google.com/a/answer/13790448), the `Operation` in the response will have `\"done\": false`, it will not have a response, and the metadata will have `\"state\": \"awaiting-multi-party-approval\"`.", |
| 1612 | + "flatPath": "v1/inboundOidcSsoProfiles", |
| 1613 | + "httpMethod": "POST", |
| 1614 | + "id": "cloudidentity.inboundOidcSsoProfiles.create", |
| 1615 | + "parameterOrder": [], |
| 1616 | + "parameters": {}, |
| 1617 | + "path": "v1/inboundOidcSsoProfiles", |
| 1618 | + "request": { |
| 1619 | + "$ref": "InboundOidcSsoProfile" |
| 1620 | + }, |
| 1621 | + "response": { |
| 1622 | + "$ref": "Operation" |
| 1623 | + }, |
| 1624 | + "scopes": [ |
| 1625 | + "https://www.googleapis.com/auth/cloud-identity.inboundsso", |
| 1626 | + "https://www.googleapis.com/auth/cloud-platform" |
| 1627 | + ] |
| 1628 | + }, |
| 1629 | + "delete": { |
| 1630 | + "description": "Deletes an InboundOidcSsoProfile.", |
| 1631 | + "flatPath": "v1/inboundOidcSsoProfiles/{inboundOidcSsoProfilesId}", |
| 1632 | + "httpMethod": "DELETE", |
| 1633 | + "id": "cloudidentity.inboundOidcSsoProfiles.delete", |
| 1634 | + "parameterOrder": [ |
| 1635 | + "name" |
| 1636 | + ], |
| 1637 | + "parameters": { |
| 1638 | + "name": { |
| 1639 | + "description": "Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the InboundOidcSsoProfile to delete. Format: `inboundOidcSsoProfiles/{sso_profile_id}`", |
| 1640 | + "location": "path", |
| 1641 | + "pattern": "^inboundOidcSsoProfiles/[^/]+$", |
| 1642 | + "required": true, |
| 1643 | + "type": "string" |
| 1644 | + } |
| 1645 | + }, |
| 1646 | + "path": "v1/{+name}", |
| 1647 | + "response": { |
| 1648 | + "$ref": "Operation" |
| 1649 | + }, |
| 1650 | + "scopes": [ |
| 1651 | + "https://www.googleapis.com/auth/cloud-identity.inboundsso", |
| 1652 | + "https://www.googleapis.com/auth/cloud-platform" |
| 1653 | + ] |
| 1654 | + }, |
| 1655 | + "get": { |
| 1656 | + "description": "Gets an InboundOidcSsoProfile.", |
| 1657 | + "flatPath": "v1/inboundOidcSsoProfiles/{inboundOidcSsoProfilesId}", |
| 1658 | + "httpMethod": "GET", |
| 1659 | + "id": "cloudidentity.inboundOidcSsoProfiles.get", |
| 1660 | + "parameterOrder": [ |
| 1661 | + "name" |
| 1662 | + ], |
| 1663 | + "parameters": { |
| 1664 | + "name": { |
| 1665 | + "description": "Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the InboundOidcSsoProfile to get. Format: `inboundOidcSsoProfiles/{sso_profile_id}`", |
| 1666 | + "location": "path", |
| 1667 | + "pattern": "^inboundOidcSsoProfiles/[^/]+$", |
| 1668 | + "required": true, |
| 1669 | + "type": "string" |
| 1670 | + } |
| 1671 | + }, |
| 1672 | + "path": "v1/{+name}", |
| 1673 | + "response": { |
| 1674 | + "$ref": "InboundOidcSsoProfile" |
| 1675 | + }, |
| 1676 | + "scopes": [ |
| 1677 | + "https://www.googleapis.com/auth/cloud-identity.inboundsso", |
| 1678 | + "https://www.googleapis.com/auth/cloud-identity.inboundsso.readonly", |
| 1679 | + "https://www.googleapis.com/auth/cloud-platform" |
| 1680 | + ] |
| 1681 | + }, |
| 1682 | + "list": { |
| 1683 | + "description": "Lists InboundOidcSsoProfile objects for a Google enterprise customer.", |
| 1684 | + "flatPath": "v1/inboundOidcSsoProfiles", |
| 1685 | + "httpMethod": "GET", |
| 1686 | + "id": "cloudidentity.inboundOidcSsoProfiles.list", |
| 1687 | + "parameterOrder": [], |
| 1688 | + "parameters": { |
| 1689 | + "filter": { |
| 1690 | + "description": "A [Common Expression Language](https://github.com/google/cel-spec) expression to filter the results. The only supported filter is filtering by customer. For example: `customer==\"customers/C0123abc\"`. Omitting the filter or specifying a filter of `customer==\"customers/my_customer\"` will return the profiles for the customer that the caller (authenticated user) belongs to. Specifying a filter of `customer==\"\"` will return the global shared OIDC profiles.", |
| 1691 | + "location": "query", |
| 1692 | + "type": "string" |
| 1693 | + }, |
| 1694 | + "pageSize": { |
| 1695 | + "description": "The maximum number of InboundOidcSsoProfiles to return. The service may return fewer than this value. If omitted (or defaulted to zero) the server will use a sensible default. This default may change over time. The maximum allowed value is 100. Requests with page_size greater than that will be silently interpreted as having this maximum value.", |
| 1696 | + "format": "int32", |
| 1697 | + "location": "query", |
| 1698 | + "type": "integer" |
| 1699 | + }, |
| 1700 | + "pageToken": { |
| 1701 | + "description": "A page token, received from a previous `ListInboundOidcSsoProfiles` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListInboundOidcSsoProfiles` must match the call that provided the page token.", |
| 1702 | + "location": "query", |
| 1703 | + "type": "string" |
| 1704 | + } |
| 1705 | + }, |
| 1706 | + "path": "v1/inboundOidcSsoProfiles", |
| 1707 | + "response": { |
| 1708 | + "$ref": "ListInboundOidcSsoProfilesResponse" |
| 1709 | + }, |
| 1710 | + "scopes": [ |
| 1711 | + "https://www.googleapis.com/auth/cloud-identity.inboundsso", |
| 1712 | + "https://www.googleapis.com/auth/cloud-identity.inboundsso.readonly", |
| 1713 | + "https://www.googleapis.com/auth/cloud-platform" |
| 1714 | + ] |
| 1715 | + }, |
| 1716 | + "patch": { |
| 1717 | + "description": "Updates an InboundOidcSsoProfile. When the target customer has enabled [Multi-party approval for sensitive actions](https://support.google.com/a/answer/13790448), the `Operation` in the response will have `\"done\": false`, it will not have a response, and the metadata will have `\"state\": \"awaiting-multi-party-approval\"`.", |
| 1718 | + "flatPath": "v1/inboundOidcSsoProfiles/{inboundOidcSsoProfilesId}", |
| 1719 | + "httpMethod": "PATCH", |
| 1720 | + "id": "cloudidentity.inboundOidcSsoProfiles.patch", |
| 1721 | + "parameterOrder": [ |
| 1722 | + "name" |
| 1723 | + ], |
| 1724 | + "parameters": { |
| 1725 | + "name": { |
| 1726 | + "description": "Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the OIDC SSO profile.", |
| 1727 | + "location": "path", |
| 1728 | + "pattern": "^inboundOidcSsoProfiles/[^/]+$", |
| 1729 | + "required": true, |
| 1730 | + "type": "string" |
| 1731 | + }, |
| 1732 | + "updateMask": { |
| 1733 | + "description": "Required. The list of fields to be updated.", |
| 1734 | + "format": "google-fieldmask", |
| 1735 | + "location": "query", |
| 1736 | + "type": "string" |
| 1737 | + } |
| 1738 | + }, |
| 1739 | + "path": "v1/{+name}", |
| 1740 | + "request": { |
| 1741 | + "$ref": "InboundOidcSsoProfile" |
| 1742 | + }, |
| 1743 | + "response": { |
| 1744 | + "$ref": "Operation" |
| 1745 | + }, |
| 1746 | + "scopes": [ |
| 1747 | + "https://www.googleapis.com/auth/cloud-identity.inboundsso", |
| 1748 | + "https://www.googleapis.com/auth/cloud-platform" |
| 1749 | + ] |
| 1750 | + } |
| 1751 | + } |
| 1752 | + }, |
1608 | 1753 | "inboundSamlSsoProfiles": {
|
1609 | 1754 | "methods": {
|
1610 | 1755 | "create": {
|
|
2085 | 2230 | }
|
2086 | 2231 | }
|
2087 | 2232 | },
|
2088 |
| - "revision": "20250701", |
| 2233 | + "revision": "20250805", |
2089 | 2234 | "rootUrl": "https://cloudidentity.googleapis.com/",
|
2090 | 2235 | "schemas": {
|
2091 | 2236 | "AddIdpCredentialOperationMetadata": {
|
|
2133 | 2278 | "properties": {},
|
2134 | 2279 | "type": "object"
|
2135 | 2280 | },
|
| 2281 | + "CreateInboundOidcSsoProfileOperationMetadata": { |
| 2282 | + "description": "LRO response metadata for InboundOidcSsoProfilesService.CreateInboundOidcSsoProfile.", |
| 2283 | + "id": "CreateInboundOidcSsoProfileOperationMetadata", |
| 2284 | + "properties": { |
| 2285 | + "state": { |
| 2286 | + "description": "State of this Operation Will be \"awaiting-multi-party-approval\" when the operation is deferred due to the target customer having enabled [Multi-party approval for sensitive actions](https://support.google.com/a/answer/13790448).", |
| 2287 | + "type": "string" |
| 2288 | + } |
| 2289 | + }, |
| 2290 | + "type": "object" |
| 2291 | + }, |
2136 | 2292 | "CreateInboundSamlSsoProfileOperationMetadata": {
|
2137 | 2293 | "description": "LRO response metadata for InboundSamlSsoProfilesService.CreateInboundSamlSsoProfile.",
|
2138 | 2294 | "id": "CreateInboundSamlSsoProfileOperationMetadata",
|
|
2168 | 2324 | "properties": {},
|
2169 | 2325 | "type": "object"
|
2170 | 2326 | },
|
| 2327 | + "DeleteInboundOidcSsoProfileOperationMetadata": { |
| 2328 | + "description": "LRO response metadata for InboundOidcSsoProfilesService.DeleteInboundOidcSsoProfile.", |
| 2329 | + "id": "DeleteInboundOidcSsoProfileOperationMetadata", |
| 2330 | + "properties": {}, |
| 2331 | + "type": "object" |
| 2332 | + }, |
2171 | 2333 | "DeleteInboundSamlSsoProfileOperationMetadata": {
|
2172 | 2334 | "description": "LRO response metadata for InboundSamlSsoProfilesService.DeleteInboundSamlSsoProfile.",
|
2173 | 2335 | "id": "DeleteInboundSamlSsoProfileOperationMetadata",
|
|
3494 | 3656 | },
|
3495 | 3657 | "type": "object"
|
3496 | 3658 | },
|
| 3659 | + "InboundOidcSsoProfile": { |
| 3660 | + "description": "An [OIDC](https://openid.net/developers/how-connect-works/) federation between a Google enterprise customer and an OIDC identity provider.", |
| 3661 | + "id": "InboundOidcSsoProfile", |
| 3662 | + "properties": { |
| 3663 | + "customer": { |
| 3664 | + "description": "Immutable. The customer. For example: `customers/C0123abc`.", |
| 3665 | + "type": "string" |
| 3666 | + }, |
| 3667 | + "displayName": { |
| 3668 | + "description": "Human-readable name of the OIDC SSO profile.", |
| 3669 | + "type": "string" |
| 3670 | + }, |
| 3671 | + "idpConfig": { |
| 3672 | + "$ref": "OidcIdpConfig", |
| 3673 | + "description": "OIDC identity provider configuration." |
| 3674 | + }, |
| 3675 | + "name": { |
| 3676 | + "description": "Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the OIDC SSO profile.", |
| 3677 | + "readOnly": true, |
| 3678 | + "type": "string" |
| 3679 | + }, |
| 3680 | + "rpConfig": { |
| 3681 | + "$ref": "OidcRpConfig", |
| 3682 | + "description": "OIDC relying party (RP) configuration for this OIDC SSO profile. These are the RP details provided by Google that should be configured on the corresponding identity provider." |
| 3683 | + } |
| 3684 | + }, |
| 3685 | + "type": "object" |
| 3686 | + }, |
3497 | 3687 | "InboundSamlSsoProfile": {
|
3498 | 3688 | "description": "A [SAML 2.0](https://www.oasis-open.org/standards#samlv2.0) federation between a Google enterprise customer and a SAML identity provider.",
|
3499 | 3689 | "id": "InboundSamlSsoProfile",
|
|
3535 | 3725 | "readOnly": true,
|
3536 | 3726 | "type": "string"
|
3537 | 3727 | },
|
| 3728 | + "oidcSsoInfo": { |
| 3729 | + "$ref": "OidcSsoInfo", |
| 3730 | + "description": "OpenID Connect SSO details. Must be set if and only if `sso_mode` is set to `OIDC_SSO`." |
| 3731 | + }, |
3538 | 3732 | "rank": {
|
3539 | 3733 | "description": "Must be zero (which is the default value so it can be omitted) for assignments with `target_org_unit` set and must be greater-than-or-equal-to one for assignments with `target_group` set.",
|
3540 | 3734 | "format": "int32",
|
|
3554 | 3748 | "SSO_MODE_UNSPECIFIED",
|
3555 | 3749 | "SSO_OFF",
|
3556 | 3750 | "SAML_SSO",
|
| 3751 | + "OIDC_SSO", |
3557 | 3752 | "DOMAIN_WIDE_SAML_IF_ENABLED"
|
3558 | 3753 | ],
|
3559 | 3754 | "enumDescriptions": [
|
3560 | 3755 | "Not allowed.",
|
3561 | 3756 | "Disable SSO for the targeted users.",
|
3562 | 3757 | "Use an external SAML Identity Provider for SSO for the targeted users.",
|
| 3758 | + "Use an external OIDC Identity Provider for SSO for the targeted users.", |
3563 | 3759 | "Use the domain-wide SAML Identity Provider for the targeted users if one is configured; otherwise, this is equivalent to `SSO_OFF`. Note that this will also be equivalent to `SSO_OFF` if/when support for domain-wide SAML is removed. Google may disallow this mode at that point and existing assignments with this mode may be automatically changed to `SSO_OFF`."
|
3564 | 3760 | ],
|
3565 | 3761 | "type": "string"
|
|
3622 | 3818 | },
|
3623 | 3819 | "type": "object"
|
3624 | 3820 | },
|
| 3821 | + "ListInboundOidcSsoProfilesResponse": { |
| 3822 | + "description": "Response of the InboundOidcSsoProfilesService.ListInboundOidcSsoProfiles method.", |
| 3823 | + "id": "ListInboundOidcSsoProfilesResponse", |
| 3824 | + "properties": { |
| 3825 | + "inboundOidcSsoProfiles": { |
| 3826 | + "description": "List of InboundOidcSsoProfiles.", |
| 3827 | + "items": { |
| 3828 | + "$ref": "InboundOidcSsoProfile" |
| 3829 | + }, |
| 3830 | + "type": "array" |
| 3831 | + }, |
| 3832 | + "nextPageToken": { |
| 3833 | + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", |
| 3834 | + "type": "string" |
| 3835 | + } |
| 3836 | + }, |
| 3837 | + "type": "object" |
| 3838 | + }, |
3625 | 3839 | "ListInboundSamlSsoProfilesResponse": {
|
3626 | 3840 | "description": "Response of the InboundSamlSsoProfilesService.ListInboundSamlSsoProfiles method.",
|
3627 | 3841 | "id": "ListInboundSamlSsoProfilesResponse",
|
|
4012 | 4226 | },
|
4013 | 4227 | "type": "object"
|
4014 | 4228 | },
|
| 4229 | + "OidcIdpConfig": { |
| 4230 | + "description": "OIDC IDP (identity provider) configuration.", |
| 4231 | + "id": "OidcIdpConfig", |
| 4232 | + "properties": { |
| 4233 | + "changePasswordUri": { |
| 4234 | + "description": "The **Change Password URL** of the identity provider. Users will be sent to this URL when changing their passwords at `myaccount.google.com`. This takes precedence over the change password URL configured at customer-level. Must use `HTTPS`.", |
| 4235 | + "type": "string" |
| 4236 | + }, |
| 4237 | + "issuerUri": { |
| 4238 | + "description": "Required. The Issuer identifier for the IdP. Must be a URL. The discovery URL will be derived from this as described in Section 4 of [the OIDC specification](https://openid.net/specs/openid-connect-discovery-1_0.html).", |
| 4239 | + "type": "string" |
| 4240 | + } |
| 4241 | + }, |
| 4242 | + "type": "object" |
| 4243 | + }, |
| 4244 | + "OidcRpConfig": { |
| 4245 | + "description": "OIDC RP (relying party) configuration.", |
| 4246 | + "id": "OidcRpConfig", |
| 4247 | + "properties": { |
| 4248 | + "clientId": { |
| 4249 | + "description": "OAuth2 client ID for OIDC.", |
| 4250 | + "type": "string" |
| 4251 | + }, |
| 4252 | + "clientSecret": { |
| 4253 | + "description": "Input only. OAuth2 client secret for OIDC.", |
| 4254 | + "type": "string" |
| 4255 | + }, |
| 4256 | + "redirectUris": { |
| 4257 | + "description": "Output only. The URL(s) that this client may use in authentication requests.", |
| 4258 | + "items": { |
| 4259 | + "type": "string" |
| 4260 | + }, |
| 4261 | + "readOnly": true, |
| 4262 | + "type": "array" |
| 4263 | + } |
| 4264 | + }, |
| 4265 | + "type": "object" |
| 4266 | + }, |
| 4267 | + "OidcSsoInfo": { |
| 4268 | + "description": "Details that are applicable when `sso_mode` is set to `OIDC_SSO`.", |
| 4269 | + "id": "OidcSsoInfo", |
| 4270 | + "properties": { |
| 4271 | + "inboundOidcSsoProfile": { |
| 4272 | + "description": "Required. Name of the `InboundOidcSsoProfile` to use. Must be of the form `inboundOidcSsoProfiles/{inbound_oidc_sso_profile}`. ", |
| 4273 | + "type": "string" |
| 4274 | + } |
| 4275 | + }, |
| 4276 | + "type": "object" |
| 4277 | + }, |
4015 | 4278 | "Operation": {
|
4016 | 4279 | "description": "This resource represents a long-running operation that is the result of a network API call.",
|
4017 | 4280 | "id": "Operation",
|
|
4387 | 4650 | "properties": {},
|
4388 | 4651 | "type": "object"
|
4389 | 4652 | },
|
| 4653 | + "UpdateInboundOidcSsoProfileOperationMetadata": { |
| 4654 | + "description": "LRO response metadata for InboundOidcSsoProfilesService.UpdateInboundOidcSsoProfile.", |
| 4655 | + "id": "UpdateInboundOidcSsoProfileOperationMetadata", |
| 4656 | + "properties": { |
| 4657 | + "state": { |
| 4658 | + "description": "State of this Operation Will be \"awaiting-multi-party-approval\" when the operation is deferred due to the target customer having enabled [Multi-party approval for sensitive actions](https://support.google.com/a/answer/13790448).", |
| 4659 | + "type": "string" |
| 4660 | + } |
| 4661 | + }, |
| 4662 | + "type": "object" |
| 4663 | + }, |
4390 | 4664 | "UpdateInboundSamlSsoProfileOperationMetadata": {
|
4391 | 4665 | "description": "LRO response metadata for InboundSamlSsoProfilesService.UpdateInboundSamlSsoProfile.",
|
4392 | 4666 | "id": "UpdateInboundSamlSsoProfileOperationMetadata",
|
|
0 commit comments