Function: updateApplicationRole()

function updateApplicationRole(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  defaultGroups?: string[];
  defined?: boolean;
  groups?: string[];
  hasUnlimitedSeats?: boolean;
  key?: string;
  name?: string;
  numberOfSeats?: number;
  platform?: boolean;
  remainingSeats?: number;
  selectedByDefault?: boolean;
  userCount?: number;
  userCountDescription?: string;
}>;

Defined in: src/server/api/applicationRoles.ts:65

Updates the ApplicationRole with the passed data. Only the groups and default groups setting of the role may be updated. Requests to change the key or the name of the role will be silently ignored.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ body?: { defaultGroups?: string[]; defined?: boolean; groups?: string[]; hasUnlimitedSeats?: boolean; key?: string; name?: string; numberOfSeats?: number; platform?: boolean; remainingSeats?: number; selectedByDefault?: boolean; userCount?: number; userCountDescription?: string; }; If-Match?: string; key: string; versionHash?: string; }	-
parameters.body?	{ defaultGroups?: string[]; defined?: boolean; groups?: string[]; hasUnlimitedSeats?: boolean; key?: string; name?: string; numberOfSeats?: number; platform?: boolean; remainingSeats?: number; selectedByDefault?: boolean; userCount?: number; userCountDescription?: string; }	-
parameters.body.defaultGroups?	string[]	-
parameters.body.defined?	boolean	-
parameters.body.groups?	string[]	-
parameters.body.hasUnlimitedSeats?	boolean	-
parameters.body.key?	string	-
parameters.body.name?	string	-
parameters.body.numberOfSeats?	number	-
parameters.body.platform?	boolean	-
parameters.body.remainingSeats?	number	-
parameters.body.selectedByDefault?	boolean	-
parameters.body.userCount?	number	-
parameters.body.userCountDescription?	string	-
parameters.If-Match?	string	-
parameters.key?	string	The key of the role to update.
parameters.versionHash?	string	The hash of the version to update. Optional Param
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; defaultGroups?: string[]; defined?: boolean; groups?: string[]; hasUnlimitedSeats?: boolean; key?: string; name?: string; numberOfSeats?: number; platform?: boolean; remainingSeats?: number; selectedByDefault?: boolean; userCount?: number; userCountDescription?: string; }>