IamUserGroupsApi.md

Fastly.IamUserGroupsApi

const apiInstance = new Fastly.IamUserGroupsApi();

Methods

Method	Fastly API endpoint	Description
deleteAUserGroup	DELETE /user-groups/{user_group_id}	Delete a user group
getAUserGroup	GET /user-groups/{user_group_id}	Get a user group
listUserGroupMembers	GET /user-groups/{user_group_id}/members	List members of a user group
listUserGroupRoles	GET /user-groups/{user_group_id}/roles	List roles in a user group
listUserGroupServiceGroups	GET /user-groups/{user_group_id}/service-groups	List service groups in a user group
listUserGroups	GET /user-groups	List user groups

deleteAUserGroup

deleteAUserGroup({ user_group_id })

Delete a user group.

Example

const options = {
  user_group_id: "user_group_id_example", // required
};

apiInstance.deleteAUserGroup(options)
  .then(() => {
    console.log('API called successfully.');
  })
  .catch((error) => {
    console.error(error);
  });

Options

Name	Type	Description	Notes
user_group_id	String	Alphanumeric string identifying the user group.

Return type

null (empty response body)

getAUserGroup

getAUserGroup({ user_group_id })

Get a user group.

Example

const options = {
  user_group_id: "user_group_id_example", // required
};

apiInstance.getAUserGroup(options)
  .then((data) => {
    console.log(data, "API called successfully.");
  })
  .catch((error) => {
    console.error(error);
  });

Options

Name	Type	Description	Notes
user_group_id	String	Alphanumeric string identifying the user group.

Return type

Object

listUserGroupMembers

listUserGroupMembers({ user_group_id, [per_page, ][page] })

List members of a user group.

Example

const options = {
  user_group_id: "user_group_id_example", // required
  per_page: 20,
  page: 1,
};

apiInstance.listUserGroupMembers(options)
  .then((data) => {
    console.log(data, "API called successfully.");
  })
  .catch((error) => {
    console.error(error);
  });

Options

Name	Type	Description	Notes
user_group_id	String	Alphanumeric string identifying the user group.
per_page	Number	Number of records per page.	[optional] [defaults to 20]
page	Number	Current page.	[optional]

Return type

Object

listUserGroupRoles

listUserGroupRoles({ user_group_id, [per_page, ][page] })

List roles in a user group.

Example

const options = {
  user_group_id: "user_group_id_example", // required
  per_page: 20,
  page: 1,
};

apiInstance.listUserGroupRoles(options)
  .then((data) => {
    console.log(data, "API called successfully.");
  })
  .catch((error) => {
    console.error(error);
  });

Options

Name	Type	Description	Notes
user_group_id	String	Alphanumeric string identifying the user group.
per_page	Number	Number of records per page.	[optional] [defaults to 20]
page	Number	Current page.	[optional]

Return type

Object

listUserGroupServiceGroups

listUserGroupServiceGroups({ user_group_id, [per_page, ][page] })

List service groups in a user group.

Example

const options = {
  user_group_id: "user_group_id_example", // required
  per_page: 20,
  page: 1,
};

apiInstance.listUserGroupServiceGroups(options)
  .then((data) => {
    console.log(data, "API called successfully.");
  })
  .catch((error) => {
    console.error(error);
  });

Options

Name	Type	Description	Notes
user_group_id	String	Alphanumeric string identifying the user group.
per_page	Number	Number of records per page.	[optional] [defaults to 20]
page	Number	Current page.	[optional]

Return type

Object

listUserGroups

listUserGroups({ , [per_page, ][page] })

List all user groups.

Example

const options = {
  per_page: 20,
  page: 1,
};

apiInstance.listUserGroups(options)
  .then((data) => {
    console.log(data, "API called successfully.");
  })
  .catch((error) => {
    console.error(error);
  });

Options

Name	Type	Description	Notes
per_page	Number	Number of records per page.	[optional] [defaults to 20]
page	Number	Current page.	[optional]

Return type

Object

[Back to top] [Back to API list] [Back to README]