Class CustomerService

See

https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-customer

Hierarchy

  • CommonHttpService
    • CustomerService

Constructors

constructor

Methods

createCustomer revokePortalOnlyAccessForUser initialize

Constructors

constructor

  • new CustomerService(getClientInstance): CustomerService
  • Internal

    Create a new instance of the service.

    Parameters

    • getClientInstance: (() => CommonHttpClient)
        • (): CommonHttpClient

        • Returns CommonHttpClient

    Returns CustomerService

Methods

createCustomer

  • createCustomer(params): Promise<UserDto>

  • This method adds a customer to the Jira Service Management instance by passing a JSON file including an email address and display name. The display name does not need to be unique. The record's identifiers, name and key, are automatically generated from the request details.

    Permissions required: Jira Administrator Global permission

    Parameters

    • params: {
          customerCreateDto: CustomerCreateDto;
          strictConflictStatusCode?: boolean;
      }
      • customerCreateDto: CustomerCreateDto

        Example

        {
        "displayName": "Fred F. User",
          "email": "fred@example.com"
        }
      • OptionalstrictConflictStatusCode?: boolean

        Optional boolean flag to return 409 Conflict status code for duplicate customer creation request

    Returns Promise<UserDto>

    Returns the customer details.

    example:

    {
      "accountId": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
      "name": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
      "key": "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
      "emailAddress": "fred@example.com",
      "displayName": "Fred F. User",
      "active": true,
      "timeZone": "Australia/Sydney",
      "_links": {
        "jiraRest": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
        "avatarUrls": {
          "16x16": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue",
          "24x24": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue",
          "32x32": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue",
          "48x48": "https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue"
        },
        "self": "https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b"
      }
    }

    Path

    POST /rest/servicedeskapi/customer @scopes-current manage:servicedesk-customer @scopes-beta read:customer:jira-service-management, write:customer:jira-service-management, read:user:jira

    See

    https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-customer#api-rest-servicedeskapi-customer-post

revokePortalOnlyAccessForUser

  • revokePortalOnlyAccessForUser(params): Promise<void>

  • This method revokes portal-only access for a particular user, removing their ability to log in to the Jira Service Management customer portal as a portal-only user. After revocation, the user cannot submit or view requests through the portal.

    Permissions required: Site administration (that is, member of the site-admin group).

    Parameters

    • params: {
          accountId: string;
      }
      • accountId: string

        The account ID of the user, which uniquely identifies the portal-only account. For example, qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b.

    Returns Promise<void>

    Returned if the request is successful.

    Path

    PUT /rest/servicedeskapi/customer/user/{accountId}/revoke-portal-only-access @scopes-current manage:servicedesk-customer @scopes-beta write:customer:jira-service-management

    See

    https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-customer#api-rest-servicedeskapi-customer-user-accountid-revoke-portal-only-access-put

Protected Staticinitialize

  • initialize(): void

  • Method to initialize the class. Normally used to set up validation rules.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods