How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Okta Group API

The Group API from Okta — 16 operation(s) for group.

Okta Group API is one of 28 APIs that Okta publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include Group. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, authentication docs, rate-limit docs, a JSON-LD context, and 4 JSON Schemas.

This API exposes 28 operations across 16 paths, and defines 47 schemas. It is described by OpenAPI 3.0.1, at version 2.16.0.

Requests are made against a single base URL, https://your-subdomain.okta.com/.

28 operations 16 paths 47 schemas 7 DELETE10 GET5 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.16.0
Base URL
https://your-subdomain.okta.com
Authentication
API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Okta Group API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (api_token).

  • api_token — SSWS {API Token}

Paths & Operations 28

Across 16 paths, the API surfaces 28 operations — 7 DELETE, 10 GET, 5 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

Group 28
GET
/api/v1/groups
Okta List Groups
listGroups 6 params → 200
POST
/api/v1/groups
Okta Add Group
createGroup body → 200
GET
/api/v1/groups/rules
Okta List Group Rules
listGroupRules 4 params → 200
POST
/api/v1/groups/rules
Okta Create Group Rule
createGroupRule body → 200
GET
/api/v1/groups/rules/{ruleId}
Okta Get Group Rule
getGroupRule 2 params → 200
PUT
/api/v1/groups/rules/{ruleId}
Updates a group rule. Only INACTIVE rules can be updated.
updateGroupRule 1 param body → 200
DELETE
/api/v1/groups/rules/{ruleId}
Okta Delete a group Rule
deleteGroupRule 2 params → 202
POST
/api/v1/groups/rules/{ruleId}/lifecycle/activate
Okta Activate a group Rule
activateGroupRule 1 param → 204
POST
/api/v1/groups/rules/{ruleId}/lifecycle/deactivate
Okta Deactivate a group Rule
deactivateGroupRule 1 param → 204
GET
/api/v1/groups/{groupId}
Okta List Group Rules
getGroup 1 param → 200
PUT
/api/v1/groups/{groupId}
Okta Update Group
updateGroup 1 param body → 200
DELETE
/api/v1/groups/{groupId}
Okta Remove Group
deleteGroup 1 param → 204
GET
/api/v1/groups/{groupId}/apps
Okta List Assigned Applications
listAssignedApplicationsForGroup 3 params → 200
GET
/api/v1/groups/{groupId}/roles
Success
listGroupAssignedRoles 2 params → 200
POST
/api/v1/groups/{groupId}/roles
Assigns a Role to a Group
assignRoleToGroup 2 params body → 200201
GET
/api/v1/groups/{groupId}/roles/{roleId}
Success
getRole 2 params → 200
DELETE
/api/v1/groups/{groupId}/roles/{roleId}
Unassigns a Role from a Group
removeRoleFromGroup 2 params → 204
GET
/api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps
Lists all App targets for an APPADMIN Role assigned to a Group. This methods return list may include full Applications or Instances. The response for an instance will have an ID value, while Applicat…
listApplicationTargetsForApplicationAdministratorRoleForGroup 4 params → 200
PUT
/api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}
Success
addApplicationTargetToAdminRoleGivenToGroup 3 params → 200
DELETE
/api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}
Success
removeApplicationTargetFromApplicationAdministratorRoleGivenToGroup 3 params → 204
PUT
/api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId}
Okta Add App Instance Target to App Administrator Role given to a Group
addApplicationInstanceTargetToAppAdminRoleGivenToGroup 4 params → 204
DELETE
/api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId}
Okta Remove App Instance Target to App Administrator Role given to a Group
removeApplicationTargetFromAdministratorRoleGivenToGroup 4 params → 204
GET
/api/v1/groups/{groupId}/roles/{roleId}/targets/groups
Success
listGroupTargetsForGroupRole 4 params → 200
PUT
/api/v1/groups/{groupId}/roles/{roleId}/targets/groups/{targetGroupId}
addGroupTargetToGroupAdministratorRoleForGroup 3 params → 204
DELETE
/api/v1/groups/{groupId}/roles/{roleId}/targets/groups/{targetGroupId}
removeGroupTargetFromGroupAdministratorRoleGivenToGroup 3 params → 204
GET
/api/v1/groups/{groupId}/users
Okta List Group Members
listGroupUsers 3 params → 200
PUT
/api/v1/groups/{groupId}/users/{userId}
Okta Add User to Group
addUserToGroup 2 params → 204
DELETE
/api/v1/groups/{groupId}/users/{userId}
Okta Remove User from Group
removeUserFromGroup 2 params → 204

Schemas 47

The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are UserProfile (31 properties), Application (16 properties), User (14 properties), CatalogApplication (12 properties). Each schema is shown below with its type and property counts.

GroupRuleGroupAssignment
object
1 property
ApplicationCredentialsSigning
object
5 properties
CatalogApplicationStatus
string
AuthenticationProvider
object
2 properties
UserType
object
10 properties
GroupRuleExpression
object
2 properties
GroupRule
object
8 properties
ApplicationSignOnMode
string
GroupRuleStatus
string
GroupRuleGroupCondition
object
2 properties
Role
object
10 properties
ApplicationSettingsNotes
object
2 properties
ApplicationSettingsNotificationsVpn
object
3 properties
ApplicationVisibilityHide
object
2 properties
Application
object
16 properties
User
object
14 properties
PasswordCredentialHash
object
5 properties
UserCredentials
object
3 properties
RoleAssignmentType
string
PasswordCredential
object
3 properties
GroupRulePeopleCondition
object
2 properties
GroupRuleUserCondition
object
2 properties
UserStatus
string
AssignRoleRequest
object
1 property
GroupRuleAction
object
1 property
ApplicationCredentialsUsernameTemplate
object
4 properties
ApplicationCredentials
object
2 properties
ApplicationSettingsNotificationsVpnNetwork
object
3 properties
AuthenticationProviderType
string
CatalogApplication
object
12 properties
RoleType
string
Group
object
9 properties
ApplicationSettings
object
5 properties
RoleStatus
string
UserProfile
object
31 properties
ApplicationVisibility
object
4 properties
PasswordCredentialHook
object
1 property
ApplicationLicensing
object
1 property
PasswordCredentialHashAlgorithm
string
RecoveryQuestionCredential
object
2 properties
GroupProfile
object
2 properties
ApplicationAccessibility
object
3 properties
ApplicationSettingsNotifications
object
1 property
ApplicationCredentialsSigningUse
string
GroupType
string
GroupRuleConditions
object
2 properties
ApplicationSettingsApplication
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

okta-group-api-openapi.yml Raw ↑

Other APIs Okta publishes across the network.

Cross-App Access (XAA)
Okta for AI Agents
Okta Application API
Okta Authenticator API
Okta AuthorizationServer API
Okta Brand API
Okta Domain API
Okta EventHook API
Okta Feature API
Okta GroupSchema API
Okta IdentityProvider API
Okta InlineHook API
Where this information came from

This is an independent, third-party profile of Okta Group API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.