GRgravitee-io
Groups

Create or update a Group from an automation GroupSpec

Changed on

Create/update a Group from an automation Group Spec

put/organizations/{orgId}/environments/{envId}/groups

Request

  • Base URL
    https://eu.cloudgate.gravitee.io/apim/automation
  • URL
    https://eu.cloudgate.gravitee.io/apim/automation/organizations/{orgId}/environments/{envId}/groups
  • Auth
    • HTTP bearer
    • or HTTP basic
    • or HTTP bearer

Path parameters

orgIdstring required
Example:dedd0e0f-b3e9-4d2f-89cd-b2a9de7cb145

organization ID

envIdstring required
Example:a44e0d1b-9fa9-4d64-8b76-3634623a2e27

environment ID

Query parameters

dryRunboolean
Example:true

For modifying requests, this parameter allow you to test the result of an endpoint without actually persisting the state of the underlying spec.

hridContainsUUIDboolean

When true, the HRID path or spec value is treated as an existing UUID rather than a human-readable identifier. This is to support backward compatibility for resources created before migration to the automation API and should not be used for new resources.

ignoreMembersboolean

When true, members in the group spec is not applied: no member is added and none is removed. Name, notifyMembers and defaultMemberRoles still converge. Use it for groups whose members an identity provider manages through group mapping.

Request body

hridstring required

A unique human readable id identifying this resource

namestring required

Group's name.

notifyMembersboolean

If true, members will be notified when the group is synced with APIM.

Example request

{
  "hrid": "demo_api",
  "name": "developers",
  "members": [
    {
      "source": "gravitee",
      "sourceId": "john.doe@acme.com",
      "roles": {
        "API": "USER",
        "APPLICATION": "ADMIN",
        "INTEGRATION": "ACME_READ_ONLY"
      }
    }
  ],
  "defaultMemberRoles": {
    "api": "USER",
    "application": "USER",
    "apiProduct": "USER"
  }
}

Response

State of the successfully created/updated Group

hridstring required

A unique human readable id identifying this resource

namestring required

Group's name.

notifyMembersboolean

If true, members will be notified when the group is synced with APIM.

idstring

Resource UUID.

environmentIdstring

The environment ID.

organizationIdstring

The organization ID.

memberCountinteger

Number of members in the group.

Example response

{
  "hrid": "demo_api",
  "name": "developers",
  "members": [
    {
      "source": "gravitee",
      "sourceId": "john.doe@acme.com",
      "roles": {
        "API": "USER",
        "APPLICATION": "ADMIN",
        "INTEGRATION": "ACME_READ_ONLY"
      }
    }
  ],
  "defaultMemberRoles": {
    "api": "USER",
    "application": "USER",
    "apiProduct": "USER"
  },
  "memberCount": 5
}

Changes

  • 460368511daeRevision changes
    • warning

      changed the pattern of the request property from ^[a-zA-Z0-9][a-zA-Z0-9_-]+[a-zA-Z0-9]$ to ^[a-zA-Z0-9][a-zA-Z0-9_.-]+[a-zA-Z0-9]$

    • info

      the //// response's property pattern was changed from ^[a-zA-Z0-9][a-zA-Z0-9_-]+[a-zA-Z0-9]$ to ^[a-zA-Z0-9][a-zA-Z0-9_.-]+[a-zA-Z0-9]$ for the status

  • 2ec1da1d109fRevision changes
    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status