Skip to main content

Get List of UserGroups

POST 
/fetchUserGroup

This API returns list of UserGroups in SSM.

The Authorization must have Bearer followed by Token.

Optional params:

usergroupkey, usergroupname, usergroupdescription,groupid, max (default value is 5), offset (default value is 0)

Request​

Path Parameters

    path stringrequired

Query Parameters

    systemname string
    offset string
    connectionname string
    connectionType string

Body

    usergroupkey string
    usergroupname string

Responses​

Fetch UserGroups - SUCCESS / Get List of UserGroups - usergroupkey

Response Headers

  • Access-Control-Allow-Credentials

    string

  • Access-Control-Allow-Origin

    string

  • Cache-Control

    string

  • Date

    string

  • Expires

    string

  • Pragma

    string

  • Referrer-Policy

    string

  • Server

    string

  • Set-Cookie

    string

  • Strict-Transport-Security

    string

  • Transfer-Encoding

    string

  • X-Content-Type-Options

    string

  • X-Frame-Options

    string

  • X-XSS-Protection

    string

Schema

    displaycount number
    errorcode number
    msg string
    totalcount number

    usergroups

    object[]

  • Array [

    • entitlements

    object[]

  • Array [

    • description string
    displayname string
    entitlement_value string
    entitlement_valuekey number

  • ]

    • groupid string
    owners undefined[]
    risk string
    user_groupdescription string
    user_groupname string
    usergroupkey number

    users

    object[]

  • Array [

    • city string
    email string
    firstname string
    lastname string
    userkey number
    username string

  • ]

  • ]

Loading...