Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation
Guide That Contains This Content
[+] Expand All
[-] Collapse All

    Add an End Customer Organization in Partner Proxy Mode

    After you configure Junos Space Service Now to operate in Partner Proxy mode, you can add multiple end customers and manage end-customer Service Now applications over a secure https connection. The Service Now partner can communicate with the end-customer only after the Service Now application of an end-customer is activated.

    Use this API to add an end customer organization to Service Now operating in the Partner Proxy mode.

    URI

    https://[host]/api/juniper/servicenow/organization-management /addconnectedmember (HTTP method = POST)

    URI Parameters

    None.

    Consumes

    • application/vnd.juniper.servicenow.organization-management.connectedmember+xml; version=4;charset=UTF-8
    • application/vnd.juniper.servicenow.organization-management.connectedmember+json; version=4;charset=UTF-8

    Request Elements

    Element

    Type

    Mandatory

    Description

    siteName

    String

    Yes

    Site Name associated with the end-customer organization

    userName

    String

    Yes

    Username to authenticate the end customer site

    password

    String

    Yes

    Password to authenticate the end customer site

    Note: The password needs to be Base64 encrypted.

    jmbFilterValue

    String

    Yes

    JMB filter level configured for the organization:

    Possible values:

    • Do not send—JMBs are not sent to JSS.
    • Send all information except configuration—All information in the JMB except the device configuration information is sent to JSS.
    • Send all information—The JMB is sent as collected from the device to JSS.
    • Only send list of features used—Only the list of features used in sent in the JMB to JSS.
    • Send all information with IP addresses overwritten—IP addresses in the JMB are overwritten by asterisk (*).

    overrideECAddress

    Boolean

    Yes

    Flag to indicate if the address associated with a device by the end customer should be overridden in the Service Now partner

    Possible values:

    • true—The address specified by the end-customer is overridden with an address specified by the Service Now partner
    • false—he address specified by the end customer is not overridden with an address specified by the Service Now partner

    domainId

    Integer

    No

    ID of the domain in which the organization should be created.

    If no domain ID is provided, the organization is created in the Global domain.

    Note: The create request fails if a user does not have access to the Global domain and if no domain ID is provided with the create request.

    Produces

    • application/vnd.juniper.servicenow.organization-management.servicenowmsg+xml;version=4
    • application/vnd.juniper.servicenow.organization-management.servicenowmsg+json;version=4

    Response Elements

    Element

    Type

    Description

    msg

    String

    Status of the create end customer organization job

    Sample Input

    Sample XML Input

    <connectedmember>
    	<siteName>TestConnectedMember</siteName>
    	<userName>user@example.com</userName>
    	<password> password</password>
    	<jmbFilterValue>Do not send</jmbFilterValue>
        <overrideECAddress>true</overrideECAddress>
        <domainId>10</domainId>
    </connectedmember>
    

    Sample JSON Input

    {
      "connectedmember": {
        "siteName": "sampleConnectedMember",
        "userName": "sample@test.com",
        "password": " password",
        "jmbFilterValue": "Do not send",
        “overrideECAddress”: true
        "domainId":"10"
      }
    }
    

    Sample Output

    Sample XML Output

    <servicenowmsg>
    	<msg>Connected Member successfully created and added to Service Now</msg>
    </servicenowmsg>

    Sample JSON Output

    {"servicenowmsg":{"msg":" Connected Member successfully created and added to Service Now "}}

    Response Status Code

    Message

    Description

    503 Service Unavailable

    Service Now is not in Partner Proxy Mode and an end customer cannot be created when Service Now is not configured in Partner Proxy mode.

    400 Bad Request

    One of the following:

    • Site name is required but is not specified.
    • Site name is too long. The maximum number of characters allowed is 64.
    • Site name has an invalid character. Site names must begin with alphanumeric (a-z, 0-9) characters.
    • User name is required but is not specified.
    • User name is too long. The maximum number of characters allowed is 64.
    • Password is required but is not specified.
    • Password is too long. The maximum number of characters is 32.
    • jmbFilterValue is required but is not specified.
    • jmbFilterValue contains an invalid value.
    • submit-case-as is not specified.

    Modified: 2016-08-09