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:

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)

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)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_federated_claim	select	appId, claimId, subdomain		Retrieves a federated claim by claimId
list_federated_claims	select	appId, subdomain		Lists all federated claims for your app
create_federated_claim	insert	appId, 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	appId, claimId, 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	appId, claimId, 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
appId	string	Application ID
claimId	string	The unique id of the federated claim (example: ofc2f4zrZbs8nUa7p0g4)
subdomain	string	(default: my-org)

SELECT examples

get_federated_claim

Retrieves a federated claim by claimId

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

list_federated_claims

Lists all federated claims for your app

SELECT
id,
name,
created,
expression,
lastUpdated
FROM okta.apps.federated_claims
WHERE appId = '{{ appId }}' -- required
AND 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 (
expression,
name,
appId,
subdomain
)
SELECT 
'{{ expression }}',
'{{ name }}',
'{{ appId }}',
'{{ subdomain }}'
RETURNING
id,
name,
created,
expression,
lastUpdated
;

Manifest

# Description fields are for documentation purposes
- name: federated_claims
props:
  - name: appId
    value: "{{ appId }}"
    description: Required parameter for the federated_claims resource.
  - name: subdomain
    value: "{{ subdomain }}"
    description: Required parameter for the federated_claims resource.
  - name: expression
    value: "{{ expression }}"
    description: |
      The Okta Expression Language expression to be evaluated at runtime
  - name: name
    value: "{{ name }}"
    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 
expression = '{{ expression }}',
name = '{{ name }}'
WHERE 
appId = '{{ appId }}' --required
AND claimId = '{{ claimId }}' --required
AND 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 appId = '{{ appId }}' --required
AND claimId = '{{ claimId }}' --required
AND subdomain = '{{ subdomain }}' --required
;