directories_integration

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

Overview

Name	directories_integration
Type	Resource
Id	okta.directories.directories_integration

Fields

The following fields are returned by SELECT queries:

get_group_attribute_query_result

OK. Returns the group profile.

Name	Datatype	Description
id	string	The ID of the group (example: 00g19oiNHkbKFvNTX0g4)
profile	object	Map of requested attributes and their values

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_group_attribute_query_result	select	appInstanceId, groupId, resultId, subdomain		Retrieves the results of the requested Active Directory (AD) group attributes using the resultId returned from the POST /api/v1/directories/{appInstanceId}/groups/{groupId}/query call. If the operation has expired or if the resultId is invalid, returns a 404 status.
update_group_membership	exec	appInstanceId, subdomain, id, parameters		Updates an Active Directory or LDAP group membership directly in the Active Directory or LDAP server. You can add or remove users from groups based on their identity and access requirements. This ensures that changes made to user access in Okta are reflected in AD or LDAP. When you use Okta Access Certifications to revoke a user's membership to an AD or LDAP group, the removal is reflected in AD or LDAP. See AD Bidirectional Group Management and LDAP Bidirectional Group Management.
submit_group_attribute_query	exec	appInstanceId, groupId, subdomain, attributes		Submits a query search on the on-premises agent to asynchronously fetch specific Active Directory (AD) attributes for a group. Returns a resultId that is used to poll for the results.

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
appInstanceId	string	ID of the AD instance in Okta (example: 00a1xucgTZFrziXg10g4)
groupId	string	ID of the Okta group (example: 00g1xucgTZFrziXg10g4)
resultId	string	The unique identifier returned by the initial POST request (POST /api/v1/directories/{appInstanceId}/groups/{groupId}/query)
subdomain	string	(default: my-org)

SELECT examples

get_group_attribute_query_result

Retrieves the results of the requested Active Directory (AD) group attributes using the resultId returned from the POST /api/v1/directories/{appInstanceId}/groups/{groupId}/query call.
If the operation has expired or if the resultId is invalid, returns a 404 status.

SELECT
id,
profile
FROM okta.directories.directories_integration
WHERE appInstanceId = '{{ appInstanceId }}' -- required
AND groupId = '{{ groupId }}' -- required
AND resultId = '{{ resultId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
;

Lifecycle Methods

update_group_membership

Updates an Active Directory or LDAP group membership directly in the Active Directory or LDAP server.

You can add or remove users from groups based on their identity and access requirements. This ensures that changes made to user access in Okta are reflected in AD or LDAP. When you use Okta Access Certifications to revoke a user's membership to an AD or LDAP group, the removal is reflected in AD or LDAP.

See AD Bidirectional Group Management and LDAP Bidirectional Group Management.

EXEC okta.directories.directories_integration.update_group_membership 
@appInstanceId='{{ appInstanceId }}' --required, 
@subdomain='{{ subdomain }}' --required 
@@json=
'{
"id": "{{ id }}", 
"parameters": "{{ parameters }}"
}'
;

submit_group_attribute_query

Submits a query search on the on-premises agent to asynchronously fetch specific Active Directory (AD) attributes for a group.
Returns a resultId that is used to poll for the results.

EXEC okta.directories.directories_integration.submit_group_attribute_query 
@appInstanceId='{{ appInstanceId }}' --required, 
@groupId='{{ groupId }}' --required, 
@subdomain='{{ subdomain }}' --required 
@@json=
'{
"attributes": "{{ attributes }}"
}'
;