Function: getApplicationRole()

function getApplicationRole(
   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:46

Returns the ApplicationRole with passed key if it exists.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ key: string; }	-
parameters.key	string	The key of the role to use.
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; }>