Function: getManagementPermissions()

function getManagementPermissions(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  apiToken.delete?:   | {
   [key: string]: unknown;
     allowed: true;
   }
     | {
   [key: string]: unknown;
     allowed: false;
     reason: {
      [key: string]: unknown;
        key:   | string & object
           | "administrative"
           | "administrative.notMyself"
           | "authPolicy.saml"
           | "blocked.exportControl"
           | "externalDirectory.scim"
           | "externalDirectory.google"
           | "myselfOnly"
           | "managedAccount";
     };
   };
  apiToken.read?:   | {
   [key: string]: unknown;
     allowed: true;
   }
     | {
   [key: string]: unknown;
     allowed: false;
     reason: {
      [key: string]: unknown;
        key:   | string & object
           | "administrative"
           | "administrative.notMyself"
           | "authPolicy.saml"
           | "blocked.exportControl"
           | "externalDirectory.scim"
           | "externalDirectory.google"
           | "myselfOnly"
           | "managedAccount";
     };
   };
  email.set?:   | {
   [key: string]: unknown;
     allowed: true;
   }
     | {
   [key: string]: unknown;
     allowed: false;
     reason: {
      [key: string]: unknown;
        key:   | string & object
           | "administrative"
           | "administrative.notMyself"
           | "authPolicy.saml"
           | "blocked.exportControl"
           | "externalDirectory.scim"
           | "externalDirectory.google"
           | "myselfOnly"
           | "managedAccount";
     };
   };
  lifecycle.delete?:   | {
   [key: string]: unknown;
     allowed: true;
   }
     | {
   [key: string]: unknown;
     allowed: false;
     reason: {
      [key: string]: unknown;
        key:   | string & object
           | "administrative"
           | "administrative.notMyself"
           | "authPolicy.saml"
           | "blocked.exportControl"
           | "externalDirectory.scim"
           | "externalDirectory.google"
           | "myselfOnly"
           | "managedAccount";
     };
   };
  lifecycle.enablement?:   | {
   [key: string]: unknown;
     allowed: true;
   }
     | {
   [key: string]: unknown;
     allowed: false;
     reason: {
      [key: string]: unknown;
        key:   | string & object
           | "administrative"
           | "administrative.notMyself"
           | "authPolicy.saml"
           | "blocked.exportControl"
           | "externalDirectory.scim"
           | "externalDirectory.google"
           | "myselfOnly"
           | "managedAccount";
     };
   };
  profile?: Record<string, 
     | {
   [key: string]: unknown;
     allowed: true;
   }
     | {
   [key: string]: unknown;
     allowed: false;
     reason: {
      [key: string]: unknown;
        key:   | string & object
           | "administrative"
           | "administrative.notMyself"
           | "authPolicy.saml"
           | "blocked.exportControl"
           | "externalDirectory.scim"
           | "externalDirectory.google"
           | "myselfOnly"
           | "managedAccount";
     };
  }>;
  profile.read?:   | {
   [key: string]: unknown;
     allowed: true;
   }
     | {
   [key: string]: unknown;
     allowed: false;
     reason: {
      [key: string]: unknown;
        key:   | string & object
           | "administrative"
           | "administrative.notMyself"
           | "authPolicy.saml"
           | "blocked.exportControl"
           | "externalDirectory.scim"
           | "externalDirectory.google"
           | "myselfOnly"
           | "managedAccount";
     };
   };
  profile.write?: Record<string, 
     | {
   [key: string]: unknown;
     allowed: true;
   }
     | {
   [key: string]: unknown;
     allowed: false;
     reason: {
      [key: string]: unknown;
        key:   | string & object
           | "administrative"
           | "administrative.notMyself"
           | "authPolicy.saml"
           | "blocked.exportControl"
           | "externalDirectory.scim"
           | "externalDirectory.google"
           | "myselfOnly"
           | "managedAccount";
     };
  }>;
}>;

Defined in: src/userManagement/api/manage.ts:6

Returns the set of permissions you have for managing the specified Atlassian account

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ accountId: string; privileges?: ( | string & object | "profile" | "profile.write" | "profile.read" | "email.set" | "lifecycle.enablement" | "lifecycle.delete" | "apiToken.read" | "apiToken.delete")[]; }	-
parameters.accountId	string	The user account to manage
parameters.privileges?	( | string & object | "profile" | "profile.write" | "profile.read" | "email.set" | "lifecycle.enablement" | "lifecycle.delete" | "apiToken.read" | "apiToken.delete")[]	-
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; apiToken.delete?: | { [key: string]: unknown; allowed: true; } | { [key: string]: unknown; allowed: false; reason: { [key: string]: unknown; key: | string & object | "administrative" | "administrative.notMyself" | "authPolicy.saml" | "blocked.exportControl" | "externalDirectory.scim" | "externalDirectory.google" | "myselfOnly" | "managedAccount"; }; }; apiToken.read?: | { [key: string]: unknown; allowed: true; } | { [key: string]: unknown; allowed: false; reason: { [key: string]: unknown; key: | string & object | "administrative" | "administrative.notMyself" | "authPolicy.saml" | "blocked.exportControl" | "externalDirectory.scim" | "externalDirectory.google" | "myselfOnly" | "managedAccount"; }; }; email.set?: | { [key: string]: unknown; allowed: true; } | { [key: string]: unknown; allowed: false; reason: { [key: string]: unknown; key: | string & object | "administrative" | "administrative.notMyself" | "authPolicy.saml" | "blocked.exportControl" | "externalDirectory.scim" | "externalDirectory.google" | "myselfOnly" | "managedAccount"; }; }; lifecycle.delete?: | { [key: string]: unknown; allowed: true; } | { [key: string]: unknown; allowed: false; reason: { [key: string]: unknown; key: | string & object | "administrative" | "administrative.notMyself" | "authPolicy.saml" | "blocked.exportControl" | "externalDirectory.scim" | "externalDirectory.google" | "myselfOnly" | "managedAccount"; }; }; lifecycle.enablement?: | { [key: string]: unknown; allowed: true; } | { [key: string]: unknown; allowed: false; reason: { [key: string]: unknown; key: | string & object | "administrative" | "administrative.notMyself" | "authPolicy.saml" | "blocked.exportControl" | "externalDirectory.scim" | "externalDirectory.google" | "myselfOnly" | "managedAccount"; }; }; profile?: Record<string, | { [key: string]: unknown; allowed: true; } | { [key: string]: unknown; allowed: false; reason: { [key: string]: unknown; key: | string & object | "administrative" | "administrative.notMyself" | "authPolicy.saml" | "blocked.exportControl" | "externalDirectory.scim" | "externalDirectory.google" | "myselfOnly" | "managedAccount"; }; }>; profile.read?: | { [key: string]: unknown; allowed: true; } | { [key: string]: unknown; allowed: false; reason: { [key: string]: unknown; key: | string & object | "administrative" | "administrative.notMyself" | "authPolicy.saml" | "blocked.exportControl" | "externalDirectory.scim" | "externalDirectory.google" | "myselfOnly" | "managedAccount"; }; }; profile.write?: Record<string, | { [key: string]: unknown; allowed: true; } | { [key: string]: unknown; allowed: false; reason: { [key: string]: unknown; key: | string & object | "administrative" | "administrative.notMyself" | "authPolicy.saml" | "blocked.exportControl" | "externalDirectory.scim" | "externalDirectory.google" | "myselfOnly" | "managedAccount"; }; }>; }>