Group Owners

The Group Owners API provides operations to manage owners of Okta Groups for your organization.

Note: This API is only available if you're subscribed to Okta Identity Governance. Contact your Customer Success Manager or Account Executive for more information.

List all Group Owners
OAuth 2.0: okta.groups.read

Lists all owners for a specific group

Request
path Parameters
groupId
required
string

The id of the group

Example: 00g1emaKYZTWRYYRRTSK
query Parameters
search
string

SCIM Filter expression for group owners. Allows to filter owners by type.

after
string

Specifies the pagination cursor for the next page of owners

limit
integer <int32>
Default: 1000

Specifies the number of owner results in a page

Responses
200

Success

403

Forbidden

404

Not Found

429

Too Many Requests

get/api/v1/groups/{groupId}/owners
Request samples
Response samples
application/json
[
  • {
    • "id": "00g1gae1k0znUcLuU0h8",
    • "type": "GROUP",
    • "resolved": true,
    • "originId": "null",
    • "originType": "OKTA_DIRECTORY",
    • "displayName": "Product & Engineering",
    • "lastUpdated": "2023-03-29 18:18:37.0"
    }
]

Assign a Group Owner
OAuth 2.0: okta.groups.manage

Assigns a group owner

Request
path Parameters
groupId
required
string

The id of the group

Example: 00g1emaKYZTWRYYRRTSK
Request Body schema: application/json
required
id
string

The id of the group owner

type
string (GroupOwnerType)

The entity type of the owner

Enum: "GROUP" "USER"
Responses
201

Success

400

Bad Request

403

Forbidden

404

Not Found

429

Too Many Requests

post/api/v1/groups/{groupId}/owners
Request samples
application/json
{
  • "id": "00u1cmc03xjzePoWD0h8",
  • "type": "USER"
}
Response samples
application/json
{
  • "id": "00u1cmc03xjzePoWD0h8",
  • "type": "USER",
  • "resolved": true,
  • "originId": null,
  • "originType": "OKTA_DIRECTORY",
  • "displayName": "Oliver Putnam",
  • "lastUpdated": "Wed Mar 29 18:34:31 UTC 2023"
}

Delete a Group Owner
OAuth 2.0: okta.groups.manage

Deletes a group owner from a specific group

Request
path Parameters
groupId
required
string

The id of the group

Example: 00g1emaKYZTWRYYRRTSK
ownerId
required
string

The id of the group owner

Example: 00u1emaK22TWRYd3TtG
Responses
204

No Content

403

Forbidden

404

Not Found

429

Too Many Requests

delete/api/v1/groups/{groupId}/owners/{ownerId}
Request samples
Response samples
application/json
{
  • "errorCode": "E0000006",
  • "errorSummary": "You do not have permission to perform the requested action",
  • "errorLink": "E0000006",
  • "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
  • "errorCauses": [ ]
}