push_mappings

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

Overview

Name	push_mappings
Type	Resource
Id	okta.apps.push_mappings

Fields

The following fields are returned by SELECT queries:

get_group_push_mapping

Name	Datatype	Description
id	string	The ID of the group push mapping
_links	object	Discoverable resources related to the group push mapping
appConfig	object	Additional app configuration for group push mappings. Currently only required for Active Directory.
created	string (date-time)	Timestamp when the group push mapping was created
errorSummary	string	The error message summary if the latest push failed
lastPush	string (date-time)	Timestamp when the group push mapping was pushed
lastUpdated	string (date-time)	Timestamp when the group push mapping was last updated
sourceGroupId	string	The ID of the source group for the group push mapping
status	string	The status of the group push mapping (ACTIVE, ERROR, INACTIVE)
targetGroupId	string	The ID of the target group for the group push mapping

list_group_push_mappings

Name	Datatype	Description
id	string	The ID of the group push mapping
_links	object	Discoverable resources related to the group push mapping
appConfig	object	Additional app configuration for group push mappings. Currently only required for Active Directory.
created	string (date-time)	Timestamp when the group push mapping was created
errorSummary	string	The error message summary if the latest push failed
lastPush	string (date-time)	Timestamp when the group push mapping was pushed
lastUpdated	string (date-time)	Timestamp when the group push mapping was last updated
sourceGroupId	string	The ID of the source group for the group push mapping
status	string	The status of the group push mapping (ACTIVE, ERROR, INACTIVE)
targetGroupId	string	The ID of the target group for the group push mapping

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_group_push_mapping	select	appId, mappingId, subdomain		Retrieves a group push mapping by ID
list_group_push_mappings	select	appId, subdomain	after, limit, lastUpdated, sourceGroupId, status	Lists all group push mappings with pagination support
create_group_push_mapping	insert	appId, subdomain, sourceGroupId		Creates or links a group push mapping. Note: Either targetGroupId or targetGroupName must be provided, but not both. If targetGroupId is provided, it links to an existing group. If targetGroupName is provided, it creates a new group.
update_group_push_mapping	update	appId, mappingId, subdomain, status		Updates the status of a group push mapping
delete_group_push_mapping	delete	deleteTargetGroup, appId, mappingId, subdomain		Deletes a specific group push mapping. The group push mapping must be in an INACTIVE state.

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
deleteTargetGroup	string	If set to true, the target group is also deleted. If set to false, the target group isn't deleted.
mappingId	string	Group push mapping ID
subdomain	string	(default: my-org)
after	string	Specifies the pagination cursor for the next page of mappings
lastUpdated	string	Filters group push mappings by last updated date. The lastUpdated parameter supports the following format: YYYY-MM-DDTHH:mm:ssZ. This filters mappings updated on or after the specified date and time in UTC. If you don't specify a value, all group push mappings are returned.
limit	integer (int32)	Specifies the number of results returned
sourceGroupId	string	Filters group push mappings by source group ID. If you don't specify a value, all group push mappings are returned.
status	string	Filters group push mappings by status. If you don't specify a value, all group push mappings are returned.

SELECT examples

get_group_push_mapping

Retrieves a group push mapping by ID

SELECT
id,
_links,
appConfig,
created,
errorSummary,
lastPush,
lastUpdated,
sourceGroupId,
status,
targetGroupId
FROM okta.apps.push_mappings
WHERE appId = '{{ appId }}' -- required
AND mappingId = '{{ mappingId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
;

list_group_push_mappings

Lists all group push mappings with pagination support

SELECT
id,
_links,
appConfig,
created,
errorSummary,
lastPush,
lastUpdated,
sourceGroupId,
status,
targetGroupId
FROM okta.apps.push_mappings
WHERE appId = '{{ appId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
AND after = '{{ after }}'
AND limit = '{{ limit }}'
AND lastUpdated = '{{ lastUpdated }}'
AND sourceGroupId = '{{ sourceGroupId }}'
AND status = '{{ status }}'
;

INSERT examples

create_group_push_mapping

Creates or links a group push mapping.

Note: Either targetGroupId or targetGroupName must be provided, but not both. If targetGroupId is provided, it links to an existing group. If targetGroupName is provided, it creates a new group.

INSERT INTO okta.apps.push_mappings (
appConfig,
sourceGroupId,
status,
targetGroupId,
targetGroupName,
appId,
subdomain
)
SELECT 
'{{ appConfig }}',
'{{ sourceGroupId }}' /* required */,
'{{ status }}',
'{{ targetGroupId }}',
'{{ targetGroupName }}',
'{{ appId }}',
'{{ subdomain }}'
RETURNING
id,
_links,
appConfig,
created,
errorSummary,
lastPush,
lastUpdated,
sourceGroupId,
status,
targetGroupId
;

Manifest

# Description fields are for documentation purposes
- name: push_mappings
props:
  - name: appId
    value: "{{ appId }}"
    description: Required parameter for the push_mappings resource.
  - name: subdomain
    value: "{{ subdomain }}"
    description: Required parameter for the push_mappings resource.
  - name: appConfig
    description: |
      Additional app configuration for group push mappings. Currently only required for Active Directory.
    value:
      type: "{{ type }}"
  - name: sourceGroupId
    value: "{{ sourceGroupId }}"
    description: |
      The ID of the source group for the group push mapping
  - name: status
    value: "{{ status }}"
    description: |
      The status of the group push mapping
    valid_values: ['ACTIVE', 'INACTIVE']
    default: ACTIVE
  - name: targetGroupId
    value: "{{ targetGroupId }}"
    description: |
      The ID of the existing target group for the group push mapping. This is used to link to an existing group. Required if `targetGroupName` is not provided.
  - name: targetGroupName
    value: "{{ targetGroupName }}"
    description: |
      The name of the target group for the group push mapping. This is used when creating a new downstream group. If the group already exists, it links to the existing group. Required if `targetGroupId` is not provided.

UPDATE examples

update_group_push_mapping

Updates the status of a group push mapping

UPDATE okta.apps.push_mappings
SET 
status = '{{ status }}'
WHERE 
appId = '{{ appId }}' --required
AND mappingId = '{{ mappingId }}' --required
AND subdomain = '{{ subdomain }}' --required
AND status = '{{ status }}' --required
RETURNING
id,
_links,
appConfig,
created,
errorSummary,
lastPush,
lastUpdated,
sourceGroupId,
status,
targetGroupId;

DELETE examples

delete_group_push_mapping

Deletes a specific group push mapping. The group push mapping must be in an INACTIVE state.

DELETE FROM okta.apps.push_mappings
WHERE deleteTargetGroup = '{{ deleteTargetGroup }}' --required
AND appId = '{{ appId }}' --required
AND mappingId = '{{ mappingId }}' --required
AND subdomain = '{{ subdomain }}' --required
;