Versions Compared

Old Version 1

changes.mady.by.user Eleanor Tesoro

Saved on

compared with

New Version Current

changes.mady.by.user Subhajit Sengupta

Saved on

Key

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

This page is no longer maintained (). For the most current information, go to https://docs.snaplogic.com/public-apis/post-groups.html.

Redirect
filename
locationhttps://docs.snaplogic.com/public-apis/post-groups.html

POST /groups

Overview

This API creates a group.

To create the group and add its members,

  1. Verify that the target Org exists.

  2. Create the group using this API.

  3. Add the members to the group using this API.

Note

IMPORTANT: Avoid space characters in your Group name; instead, use underscores.

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}
Table of Contents
minLevel1
maxLevel1
classtocsidebar

Request

...

themeAscetic

POST https://{pod_path}/api/1/rest/public/groups

Path Parameters

Key

Description

pod_path

Required. The path to your SnapLogic pod.

Example: elastic.snaplogic.com

Query Parameters

None.

Request Header

Specify Basic

...

for authorization and application/json for content type.

...

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}

Content-Type: application/json

Request Body

...

Code Block

...

{
  "organization" : "...",
  "name" : "...",
  "members" : [ ... ]
}

...

Key
Type
Description
organization
string
The Org to create the group in.
name
string
Required. The name of the group.
members
array
An array 
...
Response
Response Header
 Paste code macro
themeAscetic
...
where:
...
Key
...
Description
...
keyA
...
…
...
…
Response Body
 Paste code macro
themeAscetic
{...}
where:
...
Key
...
Description
...
keyA
...
…
...
…
...
of strings containing email addresses of users to add to the group.
Response
Status code only.