identity_providers

Creates, updates, deletes, gets or lists a identity_providers resource.

Overview

Name	identity_providers
Type	Resource
Id	confluent.iam.identity_providers

Fields

Name	Datatype	Description
id	string	ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").
description	string	A description of the identity provider.
api_version	string	APIVersion defines the schema version of this representation of a resource.
display_name	string	The human-readable name of the OAuth identity provider.
issuer	string	A publicly accessible URL uniquely identifying the OAuth identity provider authorized to issue access tokens.
jwks_uri	string	A publicly accessible JSON Web Key Set (JWKS) URI for the OAuth identity provider. JWKS provides a set of crypotgraphic keys used to verify the authenticity and integrity of JSON Web Tokens (JWTs) issued by the OAuth identity provider.
keys	array	The JWKS issued by the OAuth identity provider. Only kid (key ID) and alg (algorithm) properties for each key set are included.
kind	string	Kind defines the object this REST resource represents.
metadata	``	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
state	string	The current state of the identity provider.

Methods

Name	Accessible by	Required Params	Description
get_iam_v2identity_provider	SELECT	id	Make a request to read an identity provider.
list_iam_v2identity_providers	SELECT		Retrieve a sorted, filtered, paginated list of all identity providers.
create_iam_v2identity_provider	INSERT		Make a request to create an identity provider.
delete_iam_v2identity_provider	DELETE	id	Make a request to delete an identity provider.
update_iam_v2identity_provider	UPDATE	id	Make a request to update an identity provider.

SELECT examples

Retrieve a sorted, filtered, paginated list of all identity providers.

SELECT
id,
description,
api_version,
display_name,
issuer,
jwks_uri,
keys,
kind,
metadata,
state
FROM confluent.iam.identity_providers
;

INSERT example

Use the following StackQL query and manifest file to create a new identity_providers resource.

All Properties

/*+ create */
INSERT INTO confluent.iam.identity_providers (
data__display_name,
data__description,
data__issuer,
data__jwks_uri
)
SELECT 
'{{ display_name }}',
'{{ description }}',
'{{ issuer }}',
'{{ jwks_uri }}'
;

Manifest

- name: identity_providers
  props:
    - name: display_name
      value: string
    - name: description
      value: string
    - name: issuer
      value: string
    - name: jwks_uri
      value: string

UPDATE example

Updates a identity_providers resource.

/*+ update */
UPDATE confluent.iam.identity_providers
SET 
display_name = '{{ display_name }}',
description = '{{ description }}',
issuer = '{{ issuer }}',
jwks_uri = '{{ jwks_uri }}'
WHERE 
id = '{{ id }}';

DELETE example

Deletes the specified identity_providers resource.

/*+ delete */
DELETE FROM confluent.iam.identity_providers
WHERE id = '{{ id }}';