Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SIEM][CASE] Init Cases Configuration API #58158

Closed
wants to merge 18 commits into from

Conversation

cnasikas
Copy link
Member

@cnasikas cnasikas commented Feb 20, 2020

Summary

The PR implements the Case Configuration API.

Routes:

Create action

Creates new action.

Endpoint: /api/cases/configure/action
Method: POST

Example Payload:

{
 "name": "test-action-servicenow",
 "actionTypeId": ".servicenow",
 "secrets": {
 	"username": "your_username",
 	"password": "your_password"
 },
 "config": {
 	"apiUrl": "https://<instance>.service-now.com/"
 }
}

Example response:

{
    "id": "dbe0900c-be50-4379-83e4-58b64b339dbe",
    "actionTypeId": ".servicenow",
    "name": "test-action-servicenow",
    "config": {
        "apiUrl": "https://<instance>.service-now.com/"
    }
}

Get actions

Get all actions supported by Case Management System.

Endpoint: /api/cases/configure/action/_find
Method: GET

Example parameters:

{}

Example response:

{
    "page": 1,
    "perPage": 20,
    "total": 2,
    "data": [
        {
            "id": "fa52ef8b-7408-4413-bf0a-dcdb0be2dd8d",
            "actionTypeId": ".servicenow",
            "name": "test-action-servicenow",
            "config": {
                "apiUrl": "https://instance1.service-now.com/"
            },
            "referencedByCount": 0
        },
        {
            "id": "7adf77ab-7c1d-411a-a5a0-d4ab38f957da",
            "actionTypeId": ".servicenow",
            "name": "test-action-servicenow2",
            "config": {
                "apiUrl": "https://instance2.service-now.com/"
            },
            "referencedByCount": 0
        }
    ]
}

Health check

Checks the health of a management system instance.

Endpoint: /api/cases/configure/action/health
Method: POST

Example Payload:

{
 "username": "your_username",
 "password": "your_password"
 "apiUrl": "https://<instance>.service-now.com/"
}

Example response:

{}

Issues: #57864 , #50103

TODO

  • Validate actionTypeId for supported actions (83ff116).
  • Mapping
  • Get user's configuration
  • Save user's configuration

Checklist

Delete any items that are not applicable to this PR.

For maintainers

@cnasikas cnasikas added in progress release_note:skip Skip the PR/issue when compiling release notes Team:SIEM WIP Work in progress labels Feb 23, 2020
@elasticmachine
Copy link
Contributor

Pinging @elastic/siem (Team:SIEM)

@cnasikas cnasikas changed the title [SIEM][CASE] Init Cases Configuration API [SIEM][CASE] [skip-ci] Init Cases Configuration API Feb 23, 2020
@cnasikas cnasikas changed the title [SIEM][CASE] [skip-ci] Init Cases Configuration API [SIEM][CASE] Init Cases Configuration API Feb 24, 2020
@kibanamachine
Copy link
Contributor

💚 Build Succeeded

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@cnasikas
Copy link
Member Author

cnasikas commented Mar 7, 2020

Closed in favor of #59358

@cnasikas cnasikas closed this Mar 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release_note:skip Skip the PR/issue when compiling release notes Team:SIEM v7.7.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants