Function grantUserAccess

Parameters

• client: Client
• parameters: {
      orgId: string;
      resource?: string;
      role:
          | string & {}
          | "atlassian/org-admin"
          | "atlassian/site-admin"
          | "atlassian/user-access-admin"
          | "atlassian/user"
          | "atlassian/admin"
          | "atlassian/guest"
          | "atlassian/customer"
          | "atlassian/contributor"
          | "atlassian/basic"
          | "atlassian/stakeholder";
      userId: string;
  }

  • orgId: string

    Your organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.

  • Optionalresource?: string

    Use the Get Workspaces API to get an id. Resource is required for all roles other than org-admin. Any resource passed for org-admin shall be ignored

  • role:
        | string & {}
        | "atlassian/org-admin"
        | "atlassian/site-admin"
        | "atlassian/user-access-admin"
        | "atlassian/user"
        | "atlassian/admin"
        | "atlassian/guest"
        | "atlassian/customer"
        | "atlassian/contributor"
        | "atlassian/basic"
        | "atlassian/stakeholder"

    Role to assign/revoke for a user

  • userId: string

    The UserId on which the action(Role Assign) needs to happen. Use the Search for users within an organization API to get the userId.

• Optionaloptions: RequestOptions