create(parent, body=None, oauthIdpConfigId=None, x__xgafv=None)

Create an Oidc Idp configuration for an Identity Toolkit project.

Args:
  parent: string, The parent resource name where the config to be created, for example: "projects/my-awesome-project" (required)
  body: object, The request body.
    The object takes the form of:

{ # Configuration options for authenticating with an OAuth IDP.
  "clientId": "A String", # The client id of an OAuth client.
  "clientSecret": "A String", # The client secret of the OAuth client, to enable OIDC code flow.
  "displayName": "A String", # The config's display name set by developers.
  "enabled": True or False, # True if allows the user to sign in with the provider.
  "issuer": "A String", # For OIDC Idps, the issuer identifier.
  "name": "A String", # The name of the OAuthIdpConfig resource, for example: 'projects/my-awesome-project/oauthIdpConfigs/oauth-config-id'. Ignored during create requests.
  "responseType": { # The response type to request for in the OAuth authorization flow. You can set either `id_token` or `code` to true, but not both. Setting both types to be simultaneously true (`{code: true, id_token: true}`) is not yet supported. See https://openid.net/specs/openid-connect-core-1_0.html#Authentication for a mapping of response type to OAuth 2.0 flow. # The response type to request for in the OAuth authorization flow. You can set either `id_token` or `code` to true, but not both. Setting both types to be simultaneously true (`{code: true, id_token: true}`) is not yet supported.
    "code": True or False, # If true, authorization code is returned from IdP's authorization endpoint.
    "idToken": True or False, # If true, ID token is returned from IdP's authorization endpoint.
    "token": True or False, # Do not use. The `token` response type is not supported at the moment.
  },
}

  oauthIdpConfigId: string, The id to use for this config.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Configuration options for authenticating with an OAuth IDP.
  "clientId": "A String", # The client id of an OAuth client.
  "clientSecret": "A String", # The client secret of the OAuth client, to enable OIDC code flow.
  "displayName": "A String", # The config's display name set by developers.
  "enabled": True or False, # True if allows the user to sign in with the provider.
  "issuer": "A String", # For OIDC Idps, the issuer identifier.
  "name": "A String", # The name of the OAuthIdpConfig resource, for example: 'projects/my-awesome-project/oauthIdpConfigs/oauth-config-id'. Ignored during create requests.
  "responseType": { # The response type to request for in the OAuth authorization flow. You can set either `id_token` or `code` to true, but not both. Setting both types to be simultaneously true (`{code: true, id_token: true}`) is not yet supported. See https://openid.net/specs/openid-connect-core-1_0.html#Authentication for a mapping of response type to OAuth 2.0 flow. # The response type to request for in the OAuth authorization flow. You can set either `id_token` or `code` to true, but not both. Setting both types to be simultaneously true (`{code: true, id_token: true}`) is not yet supported.
    "code": True or False, # If true, authorization code is returned from IdP's authorization endpoint.
    "idToken": True or False, # If true, ID token is returned from IdP's authorization endpoint.
    "token": True or False, # Do not use. The `token` response type is not supported at the moment.
  },
}

delete(name, x__xgafv=None)

Delete an Oidc Idp configuration for an Identity Toolkit project.

Args:
  name: string, The resource name of the config to be deleted, for example: 'projects/my-awesome-project/oauthIdpConfigs/oauth-config-id'. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

get(name, x__xgafv=None)

Retrieve an Oidc Idp configuration for an Identity Toolkit project.

Args:
  name: string, The resource name of the config, for example: 'projects/my-awesome-project/oauthIdpConfigs/oauth-config-id'. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Configuration options for authenticating with an OAuth IDP.
  "clientId": "A String", # The client id of an OAuth client.
  "clientSecret": "A String", # The client secret of the OAuth client, to enable OIDC code flow.
  "displayName": "A String", # The config's display name set by developers.
  "enabled": True or False, # True if allows the user to sign in with the provider.
  "issuer": "A String", # For OIDC Idps, the issuer identifier.
  "name": "A String", # The name of the OAuthIdpConfig resource, for example: 'projects/my-awesome-project/oauthIdpConfigs/oauth-config-id'. Ignored during create requests.
  "responseType": { # The response type to request for in the OAuth authorization flow. You can set either `id_token` or `code` to true, but not both. Setting both types to be simultaneously true (`{code: true, id_token: true}`) is not yet supported. See https://openid.net/specs/openid-connect-core-1_0.html#Authentication for a mapping of response type to OAuth 2.0 flow. # The response type to request for in the OAuth authorization flow. You can set either `id_token` or `code` to true, but not both. Setting both types to be simultaneously true (`{code: true, id_token: true}`) is not yet supported.
    "code": True or False, # If true, authorization code is returned from IdP's authorization endpoint.
    "idToken": True or False, # If true, ID token is returned from IdP's authorization endpoint.
    "token": True or False, # Do not use. The `token` response type is not supported at the moment.
  },
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

List all Oidc Idp configurations for an Identity Toolkit project.

Args:
  parent: string, The parent resource name, for example, "projects/my-awesome-project". (required)
  pageSize: integer, The maximum number of items to return.
  pageToken: string, The next_page_token value returned from a previous List request, if any.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for ListOAuthIdpConfigs
  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
  "oauthIdpConfigs": [ # The set of configs.
    { # Configuration options for authenticating with an OAuth IDP.
      "clientId": "A String", # The client id of an OAuth client.
      "clientSecret": "A String", # The client secret of the OAuth client, to enable OIDC code flow.
      "displayName": "A String", # The config's display name set by developers.
      "enabled": True or False, # True if allows the user to sign in with the provider.
      "issuer": "A String", # For OIDC Idps, the issuer identifier.
      "name": "A String", # The name of the OAuthIdpConfig resource, for example: 'projects/my-awesome-project/oauthIdpConfigs/oauth-config-id'. Ignored during create requests.
      "responseType": { # The response type to request for in the OAuth authorization flow. You can set either `id_token` or `code` to true, but not both. Setting both types to be simultaneously true (`{code: true, id_token: true}`) is not yet supported. See https://openid.net/specs/openid-connect-core-1_0.html#Authentication for a mapping of response type to OAuth 2.0 flow. # The response type to request for in the OAuth authorization flow. You can set either `id_token` or `code` to true, but not both. Setting both types to be simultaneously true (`{code: true, id_token: true}`) is not yet supported.
        "code": True or False, # If true, authorization code is returned from IdP's authorization endpoint.
        "idToken": True or False, # If true, ID token is returned from IdP's authorization endpoint.
        "token": True or False, # Do not use. The `token` response type is not supported at the moment.
      },
    },
  ],
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

patch(name, body=None, updateMask=None, x__xgafv=None)

Update an Oidc Idp configuration for an Identity Toolkit project.

Args:
  name: string, The name of the OAuthIdpConfig resource, for example: 'projects/my-awesome-project/oauthIdpConfigs/oauth-config-id'. Ignored during create requests. (required)
  body: object, The request body.
    The object takes the form of:

{ # Configuration options for authenticating with an OAuth IDP.
  "clientId": "A String", # The client id of an OAuth client.
  "clientSecret": "A String", # The client secret of the OAuth client, to enable OIDC code flow.
  "displayName": "A String", # The config's display name set by developers.
  "enabled": True or False, # True if allows the user to sign in with the provider.
  "issuer": "A String", # For OIDC Idps, the issuer identifier.
  "name": "A String", # The name of the OAuthIdpConfig resource, for example: 'projects/my-awesome-project/oauthIdpConfigs/oauth-config-id'. Ignored during create requests.
  "responseType": { # The response type to request for in the OAuth authorization flow. You can set either `id_token` or `code` to true, but not both. Setting both types to be simultaneously true (`{code: true, id_token: true}`) is not yet supported. See https://openid.net/specs/openid-connect-core-1_0.html#Authentication for a mapping of response type to OAuth 2.0 flow. # The response type to request for in the OAuth authorization flow. You can set either `id_token` or `code` to true, but not both. Setting both types to be simultaneously true (`{code: true, id_token: true}`) is not yet supported.
    "code": True or False, # If true, authorization code is returned from IdP's authorization endpoint.
    "idToken": True or False, # If true, ID token is returned from IdP's authorization endpoint.
    "token": True or False, # Do not use. The `token` response type is not supported at the moment.
  },
}

  updateMask: string, The update mask applies to the resource. Empty update mask will result in updating nothing. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Configuration options for authenticating with an OAuth IDP.
  "clientId": "A String", # The client id of an OAuth client.
  "clientSecret": "A String", # The client secret of the OAuth client, to enable OIDC code flow.
  "displayName": "A String", # The config's display name set by developers.
  "enabled": True or False, # True if allows the user to sign in with the provider.
  "issuer": "A String", # For OIDC Idps, the issuer identifier.
  "name": "A String", # The name of the OAuthIdpConfig resource, for example: 'projects/my-awesome-project/oauthIdpConfigs/oauth-config-id'. Ignored during create requests.
  "responseType": { # The response type to request for in the OAuth authorization flow. You can set either `id_token` or `code` to true, but not both. Setting both types to be simultaneously true (`{code: true, id_token: true}`) is not yet supported. See https://openid.net/specs/openid-connect-core-1_0.html#Authentication for a mapping of response type to OAuth 2.0 flow. # The response type to request for in the OAuth authorization flow. You can set either `id_token` or `code` to true, but not both. Setting both types to be simultaneously true (`{code: true, id_token: true}`) is not yet supported.
    "code": True or False, # If true, authorization code is returned from IdP's authorization endpoint.
    "idToken": True or False, # If true, ID token is returned from IdP's authorization endpoint.
    "token": True or False, # Do not use. The `token` response type is not supported at the moment.
  },
}

Identity Toolkit API . projects . tenants . oauthIdpConfigs

Instance Methods

Method Details