Application Groups

Groups assigned to an application

List all Assigned Groups
OAuth 2.0: okta.apps.read

Lists all group assignments for an application

Request
path Parameters
appId
required
string

Application ID

Example: 0oafxqCAJWWGELFTYASJ
query Parameters
q
string
after
string

Specifies the pagination cursor for the next page of assignments

limit
integer <int32>
Default: -1

Specifies the number of results for a page

expand
string
Responses
200

Success

403

Forbidden

404

Not Found

429

Too Many Requests

get/api/v1/apps/{appId}/groups
Request samples 
Response samples 
application/json
[
  • {
    • "id": "string",
    • "lastUpdated": "2019-08-24T14:15:22Z",
    • "priority": 0,
    • "profile": {
      },
    • "_embedded": {
      },
    • "_links": {
      }
    }
]
Retrieve an Assigned Group
OAuth 2.0: okta.apps.read
Retrieves an application group assignment


Request 
path Parameters
appId
required
string
 
groupId
required
string
 
query Parameters
expand
string
 
Responses 
200
Success


403
Forbidden


404
Not Found


429
Too Many Requests


get/api/v1/apps/{appId}/groups/{groupId}
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "priority": 0,
  • "profile": {
    • "property1": { },
    • "property2": { }
    },
  • "_embedded": {
    • "property1": { },
    • "property2": { }
    },
  • "_links": {
    • "self": {
      }
    }
}
Assign a Group
OAuth 2.0: okta.apps.manage
Assigns a group to an application


Request 
path Parameters
appId
required
string
 
groupId
required
string
 
Request Body schema: application/json
optional
priority
integer
 
object
 
property name*
additional property
object
 
Responses 
200
Success


400
Bad Request


403
Forbidden


404
Not Found


429
Too Many Requests


put/api/v1/apps/{appId}/groups/{groupId}
Request samples 
application/json
{
  • "priority": 0,
  • "profile": {
    • "property1": { },
    • "property2": { }
    }
}
Response samples 
application/json
{
  • "id": "string",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "priority": 0,
  • "profile": {
    • "property1": { },
    • "property2": { }
    },
  • "_embedded": {
    • "property1": { },
    • "property2": { }
    },
  • "_links": {
    • "self": {
      }
    }
}
Unassign a Group
OAuth 2.0: okta.apps.manage
Unassigns a group from an application


Request 
path Parameters
appId
required
string
 
groupId
required
string
 
Responses 
204
No Content


403
Forbidden


404
Not Found


429
Too Many Requests


delete/api/v1/apps/{appId}/groups/{groupId}
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": [ ]
}