Constructors

Properties

client: Client

Methods

  • This method adds an organization to a service desk. If the organization ID is already associated with the service desk, no change is made and the resource returns a 204 success code.

    Permissions required: Service desk's agent.

    Type Parameters

    • T = void

    Parameters

    Returns Promise<void>

  • This method adds an organization to a service desk. If the organization ID is already associated with the service desk, no change is made and the resource returns a 204 success code.

    Permissions required: Service desk's agent.

    Type Parameters

    • T = void

    Parameters

    Returns Promise<T>

  • This method deletes an organization. Note that the organization is deleted regardless of other associations it may have. For example, associations with service desks.

    Permissions required: Jira administrator.

    Type Parameters

    • T = void

    Parameters

    Returns Promise<void>

  • This method deletes an organization. Note that the organization is deleted regardless of other associations it may have. For example, associations with service desks.

    Permissions required: Jira administrator.

    Type Parameters

    • T = void

    Parameters

    Returns Promise<T>

  • This method returns details of an organization. Use this method to get organization details whenever your application component is passed an organization ID but needs to display other organization details.

    Permissions required: Any

    Response limitations: Customers can only retrieve organization of which they are members.

    Type Parameters

    Parameters

    Returns Promise<void>

  • This method returns details of an organization. Use this method to get organization details whenever your application component is passed an organization ID but needs to display other organization details.

    Permissions required: Any

    Response limitations: Customers can only retrieve organization of which they are members.

    Type Parameters

    Parameters

    Returns Promise<T>

  • This method returns a list of organizations in the Jira Service Management instance. Use this method when you want to present a list of organizations or want to locate an organization by name.

    Permissions required: Any. However, to fetch organizations based on accountId the user must have a Service Desk agent license.

    Response limitations: If the user is a customer, only those organizations of which the customer is a member are listed.

    Type Parameters

    Parameters

    Returns Promise<void>

  • This method returns a list of organizations in the Jira Service Management instance. Use this method when you want to present a list of organizations or want to locate an organization by name.

    Permissions required: Any. However, to fetch organizations based on accountId the user must have a Service Desk agent license.

    Response limitations: If the user is a customer, only those organizations of which the customer is a member are listed.

    Type Parameters

    Parameters

    Returns Promise<T>

  • This method returns all the users associated with an organization. Use this method where you want to provide a list of users for an organization or determine if a user is associated with an organization.

    Permissions required: Service desk administrator or agent.

    Type Parameters

    Parameters

    Returns Promise<void>

  • This method returns all the users associated with an organization. Use this method where you want to provide a list of users for an organization or determine if a user is associated with an organization.

    Permissions required: Service desk administrator or agent.

    Type Parameters

    Parameters

    Returns Promise<T>

  • This method removes an organization from a service desk. If the organization ID does not match an organization associated with the service desk, no change is made and the resource returns a 204 success code.

    Permissions required: Service desk's agent.

    Type Parameters

    • T = void

    Parameters

    Returns Promise<void>

  • This method removes an organization from a service desk. If the organization ID does not match an organization associated with the service desk, no change is made and the resource returns a 204 success code.

    Permissions required: Service desk's agent.

    Type Parameters

    • T = void

    Parameters

    Returns Promise<T>

  • Sets the value of a property for an organization. Use this resource to store custom data against an organization.

    Permissions required: Service Desk Administrator or Agent.

    Note: Permission to manage organizations can be switched to users with the Jira administrator permission, using the Organization management feature.

    Type Parameters

    • T = unknown

    Parameters

    Returns Promise<void>

  • Sets the value of a property for an organization. Use this resource to store custom data against an organization.

    Permissions required: Service Desk Administrator or Agent.

    Note: Permission to manage organizations can be switched to users with the Jira administrator permission, using the Organization management feature.

    Type Parameters

    • T = unknown

    Parameters

    Returns Promise<T>