Retrieve Entitlements

GET 
/account/entitlements/

Account entitlements give detailed information of what features are available and what limits the account is subject to.

Responses

200

application/json

Schema

Schema

pool_size integerrequired
allow_extra_users booleanrequired
max_users integerrequired
max_scan_freq stringrequired
max_scan_number integerrequired
max_credit_targets integerrequired
allow_billing booleanrequired
allow_create_and_destroy_targets booleanrequired
max_ultd_targets integerrequired
allow_scope_labels booleanrequired
allowed_scope_types string[]required
spa_limit integerrequired
scanning_agent_limit integerrequired
verify_target_ownership booleanrequired
allowed_builtin_scan_profiles string[]required
allow_custom_scan_profiles booleanrequired
allow_bulk_scan booleanrequired
allow_pause_and_resume_scan booleanrequired
allow_partial_scan booleanrequired
allow_scanning_2fa_targets booleanrequired
allow_teams booleanrequired
allow_bulk booleanrequired
allow_dashboard booleanrequired
allow_roles booleanrequired
allow_scanning_agent booleanrequired
allow_user_labels booleanrequired
allow_custom_roles booleanrequired
allow_sso booleanrequired
allow_target_import_export booleanrequired
allow_full_coverage_report booleanrequired
allow_audit_log booleanrequired
allow_discovery booleanrequired
allow_aws booleanrequired
allow_cloudflare booleanrequired
allow_azure_devops booleanrequired
allow_jira_cloud booleanrequired
allow_jira_server booleanrequired
allow_slack booleanrequired
allow_defectdojo booleanrequired
allow_webhooks booleanrequired
allow_shortcut booleanrequired
allow_heroku_sso booleanrequired
allowed_report_file_formats string[]required
allowed_report_types string[]required
allow_stored_reports booleanrequired
allowed_stored_report_file_formats string[]required
allowed_stored_report_types string[]required
allow_buying_credits booleanrequired
allow_credits booleanrequired
allow_unlimited booleanrequired
allow_ultd_change booleanrequired
number_unused_slots integerrequired

allowed_credits_packs

object[]

required

Array [

id stringrequired

Possible values: <= 100 characters

name string

Possible values: <= 50 characters

price integer

Possible values: >= -2147483648 and <= 2147483647

currency_code string

Possible values: [USD, EUR, GBP, ``]

• USD - USD
• EUR - EUR
• GBP - GBP

pack_amount int64

Possible values: <= 4294967295

discount integerrequired

savings integerrequired

]

credits_hourly_cost integerrequired
credits_cap integerrequired
credits_lightning_cost integerrequired
credits_auth_cost integerrequired
allowed_monthly_promotional_credits integerrequired
number_available_ultd_targets_minus_team_quotas integerrequired
allowed_builtin_roles string[]required
allow_target_roles booleanrequired

Example (from schema)

{
  "pool_size": 0,
  "allow_extra_users": true,
  "max_users": 0,
  "max_scan_freq": "string",
  "max_scan_number": 0,
  "max_credit_targets": 0,
  "allow_billing": true,
  "allow_create_and_destroy_targets": true,
  "max_ultd_targets": 0,
  "allow_scope_labels": true,
  "allowed_scope_types": [
    "string"
  ],
  "spa_limit": 0,
  "scanning_agent_limit": 0,
  "verify_target_ownership": true,
  "allowed_builtin_scan_profiles": [
    "string"
  ],
  "allow_custom_scan_profiles": true,
  "allow_bulk_scan": true,
  "allow_pause_and_resume_scan": true,
  "allow_partial_scan": true,
  "allow_scanning_2fa_targets": true,
  "allow_teams": true,
  "allow_bulk": true,
  "allow_dashboard": true,
  "allow_roles": true,
  "allow_scanning_agent": true,
  "allow_user_labels": true,
  "allow_custom_roles": true,
  "allow_sso": true,
  "allow_target_import_export": true,
  "allow_full_coverage_report": true,
  "allow_audit_log": true,
  "allow_discovery": true,
  "allow_aws": true,
  "allow_cloudflare": true,
  "allow_azure_devops": true,
  "allow_jira_cloud": true,
  "allow_jira_server": true,
  "allow_slack": true,
  "allow_defectdojo": true,
  "allow_webhooks": true,
  "allow_shortcut": true,
  "allow_heroku_sso": true,
  "allowed_report_file_formats": [
    "string"
  ],
  "allowed_report_types": [
    "string"
  ],
  "allow_stored_reports": true,
  "allowed_stored_report_file_formats": [
    "string"
  ],
  "allowed_stored_report_types": [
    "string"
  ],
  "allow_buying_credits": true,
  "allow_credits": true,
  "allow_unlimited": true,
  "allow_ultd_change": true,
  "number_unused_slots": 0,
  "allowed_credits_packs": [
    {
      "id": "string",
      "name": "string",
      "price": 0,
      "currency_code": "USD",
      "pack_amount": 0,
      "discount": 0,
      "savings": 0
    }
  ],
  "credits_hourly_cost": 0,
  "credits_cap": 0,
  "credits_lightning_cost": 0,
  "credits_auth_cost": 0,
  "allowed_monthly_promotional_credits": 0,
  "number_available_ultd_targets_minus_team_quotas": 0,
  "allowed_builtin_roles": [
    "string"
  ],
  "allow_target_roles": true
}

400

application/json

Schema

Schema

<field name> string[]
non_field_errors string[]

Example (from schema)

{
  "<field name>": [
    "Errors related to field <field name>."
  ],
  "non_field_errors": [
    "Errors not related to any field specific field."
  ]
}

401

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Incorrect authentication credentials."
}

404

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Not found."
}

500

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Unexpected error while handling your request."
}

Loading...