federated_claims

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

Overview

Name	federated_claims
Type	Resource
Id	okta.apps.federated_claims

Fields

The following fields are returned by SELECT queries:

list_federated_claims

Name	Datatype	Description
id	string	The unique ID of the federated claim (example: ofc2f4zrZbs8nUa7p0g4)
name	string	The name of the claim to be used in the produced token (example: roleg)
created	string	Timestamp when the federated claim was created (example: 2024-02-29T20:08:24.000Z)
expression	string	The Okta Expression Language expression to be evaluated at runtime (example: appuser.entitlements.role)
lastUpdated	string	Timestamp when the federated claim was updated (example: 2023-02-21T20:08:24.000Z)

get_federated_claim

Name	Datatype	Description
name	string	The name of the claim to be used in the produced token (example: role)
expression	string	The Okta Expression Language expression to be evaluated at runtime (example: appuser.entitlements.role)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_federated_claims	select	subdomain		Lists all federated claims for your app
get_federated_claim	select	subdomain		Retrieves a federated claim by claimId
create_federated_claim	insert	subdomain		Creates a claim that will be included in tokens produced by federation protocols (for example: OIDC id_tokens or SAML Assertions)
replace_federated_claim	replace	subdomain		Replaces a claim that will be included in tokens produced by federation protocols (for example: OIDC id_tokens or SAML Assertions)
delete_federated_claim	delete	subdomain		Deletes a federated claim by claimId

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
subdomain	string	The domain of your organization. This can be a provided subdomain of an official okta domain (okta.com, oktapreview.com, etc) or one of your configured custom domains. (default: my-org)

SELECT examples

list_federated_claims

Lists all federated claims for your app

SELECT
id,
name,
created,
expression,
lastUpdated
FROM okta.apps.federated_claims
WHERE subdomain = '{{ subdomain }}' -- required;

get_federated_claim

Retrieves a federated claim by claimId

SELECT
name,
expression
FROM okta.apps.federated_claims
WHERE subdomain = '{{ subdomain }}' -- required;

INSERT examples

create_federated_claim

Creates a claim that will be included in tokens produced by federation protocols (for example: OIDC id_tokens or SAML Assertions)

INSERT INTO okta.apps.federated_claims (
data__expression,
data__name,
subdomain
)
SELECT 
'{{ expression }}',
'{{ name }}',
'{{ subdomain }}'
RETURNING
id,
name,
created,
expression,
lastUpdated
;

Manifest

# Description fields are for documentation purposes
- name: federated_claims
  props:
    - name: subdomain
      value: string
      description: Required parameter for the federated_claims resource.
    - name: expression
      value: string
      description: >
        The Okta Expression Language expression to be evaluated at runtime
        
    - name: name
      value: string
      description: >
        The name of the claim to be used in the produced token
        

REPLACE examples

replace_federated_claim

Replaces a claim that will be included in tokens produced by federation protocols (for example: OIDC id_tokens or SAML Assertions)

REPLACE okta.apps.federated_claims
SET 
data__expression = '{{ expression }}',
data__name = '{{ name }}'
WHERE 
subdomain = '{{ subdomain }}' --required
RETURNING
id,
name,
created,
expression,
lastUpdated;

DELETE examples

delete_federated_claim

Deletes a federated claim by claimId

DELETE FROM okta.apps.federated_claims
WHERE subdomain = '{{ subdomain }}' --required;