Interface STSOidcProviders

All Known Implementing Classes:
STSOidcProvidersImpl
public interface STSOidcProviders
Client interface for managing trusted OIDC providers within a root project (/v1/projects/{projectId}/oidcProviders).

Supports paging the providers of a project (pageOidcProviders), registering a new provider (createOidcProvider), modifying (patchOidcProvider) and permanently removing (deleteOidcProvider) one, and the reversible suspend/resume lifecycle (suspendOidcProvider / resumeOidcProvider).

  • Method Details

    • list

      OidcProviderPage list(String projectId)
      Pages through the OIDC providers of a project (first page, excluding suspended).
      Parameters:
      projectId - the project identifier
      Returns:
      the first page of OIDC providers

    • list

      OidcProviderPage list(String projectId, Boolean includeSuspended, String pageToken, Integer pageSize)
      Pages through the OIDC providers of a project, controlling inclusion of suspended providers and pagination.
      Parameters:
      projectId - the project identifier
      includeSuspended - true to include suspended providers, or null for the default
      pageToken - the opaque page token from a prior response, or null for the first page
      pageSize - the maximum number of results per page, or null for the server default
      Returns:
      the requested page of OIDC providers

    • create

      OidcProvider create(String projectId, CreateOidcProviderRequest request)
      Registers a new OIDC provider in a project.
      Parameters:
      projectId - the project identifier
      request - the provider registration request
      Returns:
      the registered OIDC provider

    • update

      OidcProvider update(String projectId, String idpId, PatchOidcProviderRequest request)
      Modifies specific properties of an existing OIDC provider.
      Parameters:
      projectId - the project identifier
      idpId - the identity provider identifier
      request - the patch request (its lastRev guards against concurrent updates)
      Returns:
      the updated OIDC provider

    • delete

      Boolean delete(String projectId, String idpId)
      Permanently removes the trust relationship for an OIDC provider. This cannot be reversed.
      Parameters:
      projectId - the project identifier
      idpId - the identity provider identifier
      Returns:
      true if the deletion request was accepted

    • suspend

      Boolean suspend(String projectId, String idpId)
      Suspends an OIDC provider (a reversible way to turn off token exchange for its ID tokens).
      Parameters:
      projectId - the project identifier
      idpId - the identity provider identifier
      Returns:
      true if the suspend request was accepted

    • resume

      Boolean resume(String projectId, String idpId)
      Restores (resumes) a previously suspended OIDC provider.
      Parameters:
      projectId - the project identifier
      idpId - the identity provider identifier
      Returns:
      true if the resume request was accepted