Skip to main content
POST
/
group-bindings
cURL
curl --request POST \
  --url https://api.opal.dev/v1/group-bindings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "source_group_id": "f454d283-ca87-4a8a-bdbb-df212eca5353",
  "groups": [
    {
      "group_id": "f454d283-ca87-4a8a-bdbb-df212eca5353"
    },
    {
      "group_id": "99d0b81d-14be-4cf6-bd27-348b4af1d11b"
    }
  ]
}'
{
  "group_binding_id": "f454d283-ca87-4a8a-bdbb-df212eca5353",
  "created_by_id": "99d0b81d-14be-4cf6-bd27-348b4af1d11b",
  "created_at": "2022-01-23T04:56:07.000Z",
  "source_group_id": "f454d283-ca87-4a8a-bdbb-df212eca5353",
  "groups": [
    {
      "group_id": "f454d283-ca87-4a8a-bdbb-df212eca5353",
      "group_type": "OKTA_GROUP"
    },
    {
      "group_id": "99d0b81d-14be-4cf6-bd27-348b4af1d11b",
      "group_type": "AWS_SSO_GROUP"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

CreateGroupBindingInfo Object

Description

The CreateGroupBindingInfo object is used as an input to the CreateGroupBinding API.

​
source_group_id
string<uuid>
required

The ID of the source group.

Example:

"f454d283-ca87-4a8a-bdbb-df212eca5353"

​
groups
object[]
required

The list of groups.

Response

200 - application/json

The group binding just created.

Group Binding Object

Description

The GroupBinding object is used to represent a group binding.

Usage Example

Get group bindings from the GET Group Bindings endpoint.

​
group_binding_id
string<uuid>
required

The ID of the group binding.

Example:

"f454d283-ca87-4a8a-bdbb-df212eca5353"

​
created_by_id
string<uuid>
required

The ID of the user that created the group binding.

Example:

"99d0b81d-14be-4cf6-bd27-348b4af1d11b"

​
created_at
string<date-time>
required

The date the group binding was created.

Example:

"2022-01-23T04:56:07.000Z"

​
source_group_id
string<uuid>
required

The ID of the source group.

Example:

"f454d283-ca87-4a8a-bdbb-df212eca5353"

​
groups
object[]
required

The list of groups.