Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

PATCH /groups/{org}/{groupname}

Overview

This API adds or removes users from the specified group.

Prerequisites

You need:

  • Org Admin permissions.

Request

Appsplus panel macro confluence macro
data{"features":["

...

rounded"],"title":"

...

","titleColor":"

...

#FFFFFF","titleColorBG":"

...

#0052CC","titleSize":16,"titleBold":

...

false,"titleItalic":false,"titleUnderline":false,"link":"","linkIcon":false,"linkTab":false,"lozenge":"Hot stuff","lozengeColor":"#172B4D","lozengeColorBG":"#fff0b3","height":200,"panelPadding":12,"panelColor":"

...

#172B4D","panelColorBG":"

...

#dedede","borderColor":"#4C9AFF","borderRadius":3,"borderStyle":"solid","borderWidth":1,"icon":"editor/info","iconPrimary":"#FFFFFF","iconSecondary":"#0052CC","newMacro":false}

...

Request

...

themeAscetic

...

PATCH https://{pod_path}/api/1/rest/public/groups/{org}/{groupname}

Path Parameters

Key

Description

pod_path

Required. The path to your SnapLogic pod.

Example: elastic.snaplogic.com

org

Required. The name of the SnapLogic Org

...

.

groupname

Required. The name of the group.

Query Parameters

None.

Request Header

Specify Basic Auth for authorization.

...

appsplus-panel-macro-confluence-macro

...

themeAscetic
data{"features":["rounded"],"title":"","titleColor":"#FFFFFF","titleColorBG":"#0052CC","titleSize":16,"titleBold":false,"titleItalic":false,"titleUnderline":false,"link":"","linkIcon":false,"linkTab":false,"lozenge":"Hot stuff","lozengeColor":"#172B4D","lozengeColorBG":"#fff0b3","height":200,"panelPadding":12,"panelColor":"#172B4D","panelColorBG":"#dedede","borderColor":"#4C9AFF","borderRadius":3,"borderStyle":"solid","borderWidth":1,"icon":"editor/info","iconPrimary":"#FFFFFF","iconSecondary":"#0052CC","newMacro":false}

Authorization: Basic {your_encoded_security_credentials}

Request Body

...

Info

IMPORTANT: Only one of the following parameters can be used in each API call.

...

appsplus-panel-macro-confluence-macro

...

themeAscetic
data{"features":["rounded"],"title":"","titleColor":"#FFFFFF","titleColorBG":"#0052CC","titleSize":16,"titleBold":false,"titleItalic":false,"titleUnderline":false,"link":"","linkIcon":false,"linkTab":false,"lozenge":"Hot stuff","lozengeColor":"#172B4D","lozengeColorBG":"#fff0b3","height":200,"panelPadding":12,"panelColor":"#172B4D","panelColorBG":"#dedede","borderColor":"#4C9AFF","borderRadius":3,"borderStyle":"solid","borderWidth":1,"icon":"editor/info","iconPrimary":"#FFFFFF","iconSecondary":"#0052CC","newMacro":false}

{
"add_user"

...

:

...

"...",

...


"remove_user"

...

:

...

"...",

...


}

Key

Type

Description

add_user

string

The email address of the user to add to the group.

remove_user

string

The email address of the user to remove from the group.

Response

Response Header

Key

Description

X-SL-StatusCode

Status code indicating the results of the request.

Learn more: HTTP Status Code Registry

...

Response Body

...