[{"label":"Latest (1.0)","version":"latest"}]
cloud-partner-navigator

Delete Groups On Org

Description

Removes the roles of a specified enterprise group within an organization and removes the group.

Request

Request

URL

URL


delete
https://{api_host}/v1/federation/orgs/{orgId}/groups
Copy

Path Parameters

Path Parameters

string
orgId Required

  • Organization selected for which the Group roles will be assigned


Request Body

Request Body

DeleteGroupRolesRequest of mimetype application/json Optional

  • Payload that captures Group role

{
    "DeleteGroupRolesRequest": {
        "ids": [
            "...",
            "..."
        ],
        "notifyUsersInGroups": true
    },
    "ids": [
        "...",
        "..."
    ],
    "notifyUsersInGroups": true
}
array of string
ids Optional

The client IDs to delete


boolean
notifyUsersInGroups Optional

Publish email notification to group members.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

204 No Content

Returns DeleteGroupRolesRequest of type application/json

Request has succeeded

{
	"ids": [
		"...",
		"..."
	],
	"notifyUsersInGroups": true
}
array of string
ids Optional

The client IDs to delete


boolean
notifyUsersInGroups Optional

Publish email notification to group members.

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl -X DELETE -H "Content-Type: application/json" -d '{"DeleteGroupRolesRequest":{"ids":["...","..."],"notifyUsersInGroups":true},"ids":["...","..."],"notifyUsersInGroups":true}' https://{api_host}/v1/federation/orgs/{orgId}/groups
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-codegen-request-body-name: body


Feedback

Was this page helpful?