Manage ITSM Connections

Note:

Refer to ITSM connection metadata APIs to get values of type and authType for creating/updating ITSM connections.

1. Get a list of ITSM Connections

This GET method retrieves all the ITSM connections created on Britive.

GET	{{url}}/api/itsm-manager/connections

Request Example

curl --location -g --request GET '{{url}}/api/itsm-manager/connections' 
--header 'Authorization: TOKEN {{token}}'

Response Example

Status: 200 OK

[
  {
    "id": "string",
    "type": "string",
    "authType": "string",
    "name": "string",
    "description": "string"
  }
]

2. Create an ITSM Connection

This POST method creates an ITSM connection.

Note:

This API returns the masked data for all secure attributes like passwords, tokens, etc.

POST	{{url}}/api/itsm-manager/connections

Request Example

curl --location -g --request POST '{{url}}/api/itsm-manager/connections' 
--header 'Authorization: TOKEN {{token}}'
{
  "id": "string",
  "type": "string",
  "authType": "string",
  "name": "string",
  "description": "string",
  "data": {}
}

Response Example

Status: 201 OK

{
  "id": "string",
  "type": "string",
  "authType": "string",
  "name": "string",
  "description": "string",
  "data": {}
}

3. Get ITSM Connection Details

This GET method gets ITSM connection details for a specified connection ID.

Note:

This API returns the masked data for all secure attributes like passwords, tokens, etc.

GET	{{url}}/api/itsm-manager/connections/{connectionId}

Request Parameters

The request parameters used in this method are shown in the following table:

Parameter	Description	Data Type	Required
connectionId	connectionId of an ITSM connection	String	Mandatory

Request Example

curl --location -g --request GET '{{url}}/api/itsm-manager/connections/{connectionId}' 
--header 'Authorization: TOKEN {{token}}'

Response Example

{
  "id": "string",
  "type": "string",
  "authType": "string",
  "name": "string",
  "description": "string",
}

Status: 200 OK

4. Validate an ITSM Connection

This GET method validates an ITSM connection for a given connectionId.

GET	{{url}}/api/itsm-manager/connections/{connectionId}/validate

Request Parameters

The request parameters used in this method are shown in the following table:

Parameter	Description	Data Type	Required
connectionId	connectionId of ITSM connection	string	Mandatory

Request Example

curl --location -g --request GET '{{url}}/api/itsm-manager/connections/{connectionId}/validate' 
--header 'Authorization: TOKEN {{token}}'

Response Example

Status: 204 No Content

5. Update an ITSM Connection

This POST method is used to update ITSM connection details.

POST	{{url}}/api/itsm-manager/connections/{connectionId}

Request Parameters

The request parameters used in this method are shown in the following table:

Parameter	Description	Data Type	Required
connectionId	connectionId of ITSM connection	string	Mandatory

Request Example

curl --location -g --request POST '{{url}}/api/itsm-manager/connections/{connectionId}' 
--header 'Authorization: TOKEN {{token}}'
{
  "id": "string",
  "type": "string",
  "authType": "string",
  "name": "string",
  "description": "string",
  "data": {}
}

Response Example

Status: 204 No Content

6. Delete an ITSM Connection

This DELETE method is used to delete an ITSM connection.

DELETE

{{url}}/api/itsm-manager/connections/{connectionId}

Request Parameters

The request parameters used in this method are shown in the following table:

Parameter	Description	Data Type	Required
connectionId	connectionId of ITSM connection	string	Mandatory

Request Example

curl --location -g --request DELETE '{{url}}/api/itsm-manager/connections/{connectionId}'
--header 'Authorization: TOKEN {{token}}'

Response Example

Status: 204 No Content

7. Get References of an ITSM Connection

This GET method is used to get references of an ITSM connection.

GET	{{url}}/api/itsm-manager/connections/<connectionId>/references

Request Parameters

The request parameters used in this method are shown in the following table:

Parameter	Description	Data Type	Required
connectionId	connectionId of ITSM connection	string	Mandatory

Request Example

curl --location -g --request GET '{{url}}/api/itsm-manager/connections/<connectionId>/references'
--header 'Authorization: TOKEN {{token}}'

Response Example

[
    {
        "id": "40734e53-83b7-4ed9-a09f-d878881b9ff5",
        "consumer": "APP_PROFILE",
        "entityType": "APPLICATION",
        "url": "https://company.com/admin/applications/xq8dtucsvbn5tnb25t13/advanced-settings",
        "entityData": {
            "APPLICATION": "xq8dtucsvbn5tnb25t13"
        }
    },
    {
        "id": "cac3328b-4554-4de1-90d0-b2b5d057e44a",
        "consumer": "APP_PROFILE",
        "entityType": "PROFILE",
        "url": "https://company.com/admin/applications/xq8dtucsvbn5tnb25t13/profiles/x81jskyq8gc5t2at8n01/details/advanced-settings",
        "entityData": {
            "PROFILE": "x81jskyq8gc5t2at8n01",
            "APPLICATION": "xq8dtucsvbn5tnb25t13"
        }
    },
    {
        "id": "91252493-fd8e-46ef-a15c-e33a57149bdb",
        "consumer": "APP_PROFILE",
        "entityType": "POLICY",
        "url": "https://company.com/admin/applications/xq8dtucsvbn5tnb25t13/profiles/x81jskyq8gc5t2at8n01/details/policies/manage/view/55b6634b-0cce-4e8d-bdb3-03a900c337bd",
        "entityData": {
            "POLICY": "55b6634b-0cce-4e8d-bdb3-03a900c337bd",
            "PROFILE": "x81jskyq8gc5t2at8n01",
            "APPLICATION": "xq8dtucsvbn5tnb25t13"
        }
    }
]

Status: 200 OK