Skip to content

Create an identity source group

Request

OAuth 2.0 scope:
  • okta.identitySources.manage

Creates a group in an identity source for the given identity source instance

Path
identitySourceIdstringrequired

The ID of the identity source for which the session is created

Example:0oa3l6l6WK6h0R0QW0g4
Bodyapplication/json
externalIdstring, <= 255 characters

The external ID of the identity source group to be created

profileobject(IdentitySourceGroupProfileForUpsert)

Contains a set of external group attributes and their values that are mapped to Okta standard properties. See the group profile object and Declaration of a Custom Identity Source Schema in Using anything as a source.

Note: Profile attributes can only be of the string type.

curl -i -X POST \
  https://subdomain.okta.com/api/v1/identity-sources/0oa3l6l6WK6h0R0QW0g4/groups \
  -H 'Content-Type: application/json' \
  -d '{
    "externalId": "GROUPEXT123456784C2IF",
    "profile": {
      "displayName": "West Coast users",
      "description": "All users West of The Rockies"
    }
  }'

Responses

Success

Bodyapplication/json
externalIdstring, <= 255 characters

The external ID of the identity source group

idstringread-only

The Okta group ID of the identity source group

profileobject

The profile information of the group

Response
{ "id": "00gsl4xM9ys8TdnbZ0g4", "externalId": "GROUPEXT123456784C2IF", "profile": { "displayName": "West Coast users", "description": "All users West of The Rockies" } }