🤝GET - Service Provider Groups

my_api.get.groups()

Returns the specificied Service Provider's Groups

Parameters

  • service_provider_id (str): Target Service Provider ID

Returns

  • List: List of groups and their Names, alongside groupID's and userLimits.

How To Use:

from odins_spear import api

my_api= api.Api(base_url="https://base_url/api/vx", username="john.smith", password="ODIN_INSTANCE_1")
my_api.authenticate()

my_api.get.groups{
    "serviceProviderId"
}

Example Data Returned (Formatted)

[
  {
    "groupId": "otest.mock.grp1",
    "groupName": "test Mock Group 1",
    "userLimit": 25,
    "serviceProviderId": "test.mock.ent1"
  },
  {
    "groupId": "otest.mock.grp5",
    "groupName": "Group 5",
    "userLimit": 25,
    "serviceProviderId": "test.mock.ent1"
  }
]

Last updated