owners

Creates, updates, deletes, gets or lists an owners resource.

Overview

Name	owners
Type	Resource
Id	okta.groups.owners

Fields

The following fields are returned by SELECT queries:

list_group_owners

Name	Datatype	Description
id	string	The id of the group owner
displayName	string	The display name of the group owner
lastUpdated	string (date-time)	Timestamp when the group owner was last updated
originId	string	The ID of the app instance if the originType is APPLICATION. This value is NULL if originType is OKTA_DIRECTORY.
originType	string	The source where group ownership is managed (APPLICATION, OKTA_DIRECTORY)
resolved	boolean	If originTypeis APPLICATION, this parameter is set to FALSE until the owner's originId is reconciled with an associated Okta ID.
type	string	The entity type of the owner (GROUP, USER)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_group_owners	select	groupId, subdomain	search, after, limit	Lists all owners for a specific group
assign_group_owner	insert	groupId, subdomain		Assigns a group owner
delete_group_owner	delete	groupId, ownerId, subdomain		Deletes a group owner from a specific group

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
groupId	string	The id of the group
ownerId	string	The id of the group owner
subdomain	string	(default: my-org)
after	string	Specifies the pagination cursor for the next page of owners
limit	integer (int32)	Specifies the number of owner results in a page
search	string	SCIM filter expression for group owners. Allows you to filter owners by type.

SELECT examples

list_group_owners

Lists all owners for a specific group

SELECT
id,
displayName,
lastUpdated,
originId,
originType,
resolved,
type
FROM okta.groups.owners
WHERE groupId = '{{ groupId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
AND search = '{{ search }}'
AND after = '{{ after }}'
AND limit = '{{ limit }}'
;

INSERT examples

assign_group_owner

Assigns a group owner

INSERT INTO okta.groups.owners (
id,
type,
groupId,
subdomain
)
SELECT 
'{{ id }}',
'{{ type }}',
'{{ groupId }}',
'{{ subdomain }}'
RETURNING
id,
displayName,
lastUpdated,
originId,
originType,
resolved,
type
;

Manifest

# Description fields are for documentation purposes
- name: owners
props:
  - name: groupId
    value: "{{ groupId }}"
    description: Required parameter for the owners resource.
  - name: subdomain
    value: "{{ subdomain }}"
    description: Required parameter for the owners resource.
  - name: id
    value: "{{ id }}"
    description: |
      The `id` of the group owner
  - name: type
    value: "{{ type }}"
    description: |
      The entity type of the owner
    valid_values: ['GROUP', 'USER']

DELETE examples

delete_group_owner

Deletes a group owner from a specific group

DELETE FROM okta.groups.owners
WHERE groupId = '{{ groupId }}' --required
AND ownerId = '{{ ownerId }}' --required
AND subdomain = '{{ subdomain }}' --required
;