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

Query Parameters

systemname string
offset string
connectionname string
connectionType string

application/json

Body

usergroupkeystring
Example: 1
usergroupnamestring
Example: AdminGroup

Responses

200

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

• Referrer-Policy

  string

• Server

  string

• Set-Cookie

  string

• Strict-Transport-Security

  string

• X-Content-Type-Options

  string

• X-Frame-Options

  string

application/json

Schema

Schema

displaycountnumber
Example: 1
errorcodenumber
Example: 0
msgstring
Example: success
totalcountnumber
Example: 1

usergroups

object[]

Array [

entitlements

object[]

Array [

descriptionstring

Example:

displaynamestring

Example:

entitlement_valuestring

Example: Report Writer (Report_Writer)

entitlement_valuekeynumber

Example: 1

]

groupidstring

Example:

ownersundefined[]

Example: []

riskstring

Example:

user_groupdescriptionstring

Example: USERAPPROVAL

user_groupnamestring

Example: USERAPPROVAL

usergroupkeynumber

Example: 1

users

object[]

Array [

citystring

Example:

emailstring

Example:

firstnamestring

Example: adminfname

lastnamestring

Example: adminlname

userkeynumber

Example: 1

usernamestring

Example: admin

]

]

Example (from schema)

{
  "displaycount": 1,
  "errorcode": 0,
  "msg": "success",
  "totalcount": 1,
  "usergroups": [
    {
      "entitlements": [
        {
          "description": "",
          "displayname": "",
          "entitlement_value": "Report Writer (Report_Writer)",
          "entitlement_valuekey": 1
        },
        {
          "description": "",
          "displayname": "",
          "entitlement_value": "Job and Position Administrator (Job_and_Position_Administrator)",
          "entitlement_valuekey": 2
        },
        {
          "description": "",
          "displayname": "",
          "entitlement_value": "Organization Administrator (Organization_Administrator)",
          "entitlement_valuekey": 3
        },
        {
          "description": "",
          "displayname": "",
          "entitlement_value": "Setup Administrator (Setup_Administrator)",
          "entitlement_valuekey": 4
        },
        {
          "description": "",
          "displayname": "",
          "entitlement_value": "Compensation Administrator (Compensation_Administrator)",
          "entitlement_valuekey": 5
        },
        {
          "description": "",
          "displayname": "",
          "entitlement_value": "Benefits Administrator (Benefits_Administrator)",
          "entitlement_valuekey": 6
        },
        {
          "description": "",
          "displayname": "",
          "entitlement_value": "Payroll Interface Administrator (Payroll_Interface_Administrator)",
          "entitlement_valuekey": 7
        },
        {
          "description": "",
          "displayname": "",
          "entitlement_value": "Costing Administrator (Costing_Administrator)",
          "entitlement_valuekey": 8
        },
        {
          "description": "",
          "displayname": "",
          "entitlement_value": "Training Administrator (Inactive) (Training_Administrator)",
          "entitlement_valuekey": 9
        },
        {
          "description": "",
          "displayname": "",
          "entitlement_value": "Talent Administrator (Employee_Review_Administrator)",
          "entitlement_valuekey": 10
        },
        {
          "description": "",
          "displayname": "",
          "entitlement_value": "Business Process Administrator (Business_Process_Administrator)",
          "entitlement_valuekey": 11
        },
        {
          "description": "",
          "displayname": "",
          "entitlement_value": "Finance Administrator (Finance_Administrator)",
          "entitlement_valuekey": 12
        },
        {
          "description": "",
          "displayname": "",
          "entitlement_value": "Customer Administrator (Customer_Administrator)",
          "entitlement_valuekey": 13
        }
      ],
      "groupid": "",
      "owners": [],
      "risk": "",
      "user_groupdescription": "USERAPPROVAL",
      "user_groupname": "USERAPPROVAL",
      "usergroupkey": 1,
      "users": [
        {
          "city": "",
          "email": "",
          "firstname": "adminfname",
          "lastname": "adminlname",
          "userkey": 1,
          "username": "admin"
        },
        {
          "city": "San Francisco",
          "email": "lmcneil@workday.net",
          "firstname": "Logan",
          "lastname": "McNeil",
          "userkey": 12444,
          "username": "lmcneil"
        },
        {
          "city": "San Francisco",
          "email": "smorgan@workday.net",
          "firstname": "Steve",
          "lastname": "Morgan",
          "userkey": 12445,
          "username": "smorgan"
        },
        {
          "city": "San Francisco",
          "email": "oliverr@sav.net",
          "firstname": "Oliver",
          "lastname": "Reynolds",
          "userkey": 12446,
          "username": "Executive Management"
        }
      ]
    }
  ]
}

Fetch UserGroups - SUCCESS

{
  "displaycount": 1,
  "errorcode": 0,
  "msg": "success",
  "totalcount": 1,
  "usergroups": [
    {
      "entitlements": [
        {
          "description": "",
          "displayname": "",
          "entitlement_value": "Report Writer (Report_Writer)",
          "entitlement_valuekey": 1
        },
        {
          "description": "",
          "displayname": "",
          "entitlement_value": "Job and Position Administrator (Job_and_Position_Administrator)",
          "entitlement_valuekey": 2
        },
        {
          "description": "",
          "displayname": "",
          "entitlement_value": "Organization Administrator (Organization_Administrator)",
          "entitlement_valuekey": 3
        },
        {
          "description": "",
          "displayname": "",
          "entitlement_value": "Setup Administrator (Setup_Administrator)",
          "entitlement_valuekey": 4
        },
        {
          "description": "",
          "displayname": "",
          "entitlement_value": "Compensation Administrator (Compensation_Administrator)",
          "entitlement_valuekey": 5
        },
        {
          "description": "",
          "displayname": "",
          "entitlement_value": "Benefits Administrator (Benefits_Administrator)",
          "entitlement_valuekey": 6
        },
        {
          "description": "",
          "displayname": "",
          "entitlement_value": "Payroll Interface Administrator (Payroll_Interface_Administrator)",
          "entitlement_valuekey": 7
        },
        {
          "description": "",
          "displayname": "",
          "entitlement_value": "Costing Administrator (Costing_Administrator)",
          "entitlement_valuekey": 8
        },
        {
          "description": "",
          "displayname": "",
          "entitlement_value": "Training Administrator (Inactive) (Training_Administrator)",
          "entitlement_valuekey": 9
        },
        {
          "description": "",
          "displayname": "",
          "entitlement_value": "Talent Administrator (Employee_Review_Administrator)",
          "entitlement_valuekey": 10
        },
        {
          "description": "",
          "displayname": "",
          "entitlement_value": "Business Process Administrator (Business_Process_Administrator)",
          "entitlement_valuekey": 11
        },
        {
          "description": "",
          "displayname": "",
          "entitlement_value": "Finance Administrator (Finance_Administrator)",
          "entitlement_valuekey": 12
        },
        {
          "description": "",
          "displayname": "",
          "entitlement_value": "Customer Administrator (Customer_Administrator)",
          "entitlement_valuekey": 13
        }
      ],
      "groupid": "",
      "owners": [],
      "risk": "",
      "user_groupdescription": "USERAPPROVAL",
      "user_groupname": "USERAPPROVAL",
      "usergroupkey": 1,
      "users": [
        {
          "city": "",
          "email": "",
          "firstname": "adminfname",
          "lastname": "adminlname",
          "userkey": 1,
          "username": "admin"
        },
        {
          "city": "San Francisco",
          "email": "lmcneil@workday.net",
          "firstname": "Logan",
          "lastname": "McNeil",
          "userkey": 12444,
          "username": "lmcneil"
        },
        {
          "city": "San Francisco",
          "email": "smorgan@workday.net",
          "firstname": "Steve",
          "lastname": "Morgan",
          "userkey": 12445,
          "username": "smorgan"
        },
        {
          "city": "San Francisco",
          "email": "oliverr@sav.net",
          "firstname": "Oliver",
          "lastname": "Reynolds",
          "userkey": 12446,
          "username": "Executive Management"
        }
      ]
    }
  ]
}

Get List of UserGroups - usergroupkey

{
  "displaycount": 1,
  "errorcode": 0,
  "msg": "success",
  "totalcount": 1,
  "usergroups": [
    {
      "entitlements": [
        {
          "description": "Fixed Assets Inquiry - Tech IN",
          "displayname": "",
          "entitlement_value": "FIXED_ASSET_INQUIRY_TECH_IN",
          "entitlement_valuekey": 3
        }
      ],
      "groupid": "",
      "owners": [
        {
          "city": "",
          "comments": "",
          "email": "example@saviynt.com",
          "firstname": "Lilith",
          "lastname": "Larionova",
          "rank": 1,
          "userkey": 301254,
          "username": "zz003487"
        }
      ],
      "risk": "",
      "user_groupdescription": "Group admin",
      "user_groupname": "AdminGroup",
      "usergroupkey": 1,
      "users": [
        {
          "city": "Los Angeles",
          "email": "example@saviynt.com",
          "firstname": "margar'etm-anager",
          "lastname": "margaretm'a:nager",
          "userkey": 317375,
          "username": "margaret'manager"
        },
        {
          "city": "Los Angeles",
          "email": "example@saviynt.com",
          "firstname": "Stacy",
          "lastname": "Sponsor",
          "userkey": 317378,
          "username": "stacysponsor"
        }
      ]
    }
  ]
}

412

Get List of UserGroups - FAIL

Response Headers

• Access-Control-Allow-Credentials

  string

• Access-Control-Allow-Origin

  string

• Cache-Control

  string

• Date

  string

• Expires

  string

• Referrer-Policy

  string

• Server

  string

• Set-Cookie

  string

• Strict-Transport-Security

  string

• X-Content-Type-Options

  string

• X-Frame-Options

  string

application/json

Schema

Schema

errorcodenumber
Example: 1
msgstring
Example: user group not found with groupid 100

Example (from schema)

{
  "errorcode": 1,
  "msg": "user group not found  with groupid 100"
}

Get List of UserGroups - FAIL

{
  "errorcode": 1,
  "msg": "user group not found  with groupid 100"
}