Sign in

v50

latestOpenAPI 3.0.0Commercialraw.githubusercontent.com2022-08-0911645127.8 KB
Account

Create a new credential

put/account/credentials

Request body

namestring
type'miradore_api_key_v1' | 'aws_access_secret'
aclobject
globalboolean
cidrsstring

Example request

{
  "name": "credentials_name",
  "type": "miradore_api_key_v1",
  "acl": {
    "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8": "user",
    "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa9": "none"
  },
  "cidrs": "10.0.0.17/32, 192.168.1.0/24",
  "secret": {
    "hostname": "yourcompanyinc.online.miradore.com",
    "api_key": "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8"
  }
}

Response

credential details

idstring uuid required
client_idstring uuid
namestring
type'miradore_api_key_v1' | 'aws_access_secret' | 'crowdstrike_api_key' | 'azure_client_secret' | 'azure_username_password' | 'censys_search_api_key' | 'snmpv2_community' | 'snmpv3_credential' | 'vmware_username_password'

The service the credentials are for.

created_atinteger
created_by_idstring uuid
created_by_emailstring email
aclobject
globalboolean
cidrsstring[]
last_used_atinteger
last_used_by_idstring uuid

Example response

{
  "id": "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8",
  "client_id": "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8",
  "name": "credentials_name",
  "created_at": 1576300370,
  "created_by_id": "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8",
  "created_by_email": "user@example.com",
  "acl": {
    "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8": "user"
  },
  "cidrs": [
    "10.0.0.47/32",
    "192.168.1.0/24"
  ],
  "last_used_at": 1576300370,
  "last_used_by_id": "e77602e0-3fb8-4734-aef9-fbc6fdcb0fa8"
}