Permissions

>>>

GET /api/permissions
List all permissions

Examples

GET /api/permissions
200
{
  "total": 141,
  "subtotal": 141,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "name": "view_architectures",
      "id": 350275019,
      "resource_type": "Architecture"
    },
    {
      "name": "create_architectures",
      "id": 912770095,
      "resource_type": "Architecture"
    },
    {
      "name": "edit_architectures",
      "id": 874798611,
      "resource_type": "Architecture"
    },
    {
      "name": "destroy_architectures",
      "id": 586604735,
      "resource_type": "Architecture"
    },
    {
      "name": "view_authenticators",
      "id": 687843582,
      "resource_type": "AuthSource"
    },
    {
      "name": "create_authenticators",
      "id": 956119309,
      "resource_type": "AuthSource"
    },
    {
      "name": "edit_authenticators",
      "id": 395314704,
      "resource_type": "AuthSource"
    },
    {
      "name": "destroy_authenticators",
      "id": 1067518973,
      "resource_type": "AuthSource"
    },
    {
      "name": "create_bookmarks",
      "id": 435712857,
      "resource_type": "Bookmark"
    },
    {
      "name": "edit_bookmarks",
      "id": 978016136,
      "resource_type": "Bookmark"
    },
    {
      "name": "destroy_bookmarks",
      "id": 1027408783,
      "resource_type": "Bookmark"
    },
    {
      "name": "view_compute_resources",
      "id": 524255159,
      "resource_type": "ComputeResource"
    },
    {
      "name": "create_compute_resources",
      "id": 673360498,
      "resource_type": "ComputeResource"
    },
    {
      "name": "edit_compute_resources",
      "id": 385985960,
      "resource_type": "ComputeResource"
    },
    {
      "name": "destroy_compute_resources",
      "id": 382135357,
      "resource_type": "ComputeResource"
    },
    {
      "name": "view_compute_profiles",
      "id": 944771383,
      "resource_type": "ComputeProfile"
    },
    {
      "name": "create_compute_profiles",
      "id": 1035871455,
      "resource_type": "ComputeProfile"
    },
    {
      "name": "edit_compute_profiles",
      "id": 884230802,
      "resource_type": "ComputeProfile"
    },
    {
      "name": "destroy_compute_profiles",
      "id": 932164668,
      "resource_type": "ComputeProfile"
    },
    {
      "name": "view_provisioning_templates",
      "id": 311192153,
      "resource_type": "ProvisioningTemplate"
    }
  ]
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
search
optional

filter results

Validations:

  • Must be a String
order
optional

Sort and order by a searchable field, e.g. '<field> DESC'

Validations:

  • Must be a String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return, 'all' to return all results

Validations:

  • Must match regular expression /\A([1-9]\d*|all)\Z$/.

Search fields

Field name Type Possible values
id integer
name string
resource_type string
>>>

GET /api/permissions/:id
Show a permission

Examples

GET /api/permissions/350275019
200
{
  "name": "view_architectures",
  "id": 350275019,
  "resource_type": "Architecture"
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
>>>

GET /api/permissions/resource_types
List available resource types

Examples

GET /api/permissions/resource_types
200
{
  "total": 34,
  "subtotal": 34,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "name": "Architecture"
    },
    {
      "name": "Audit"
    },
    {
      "name": "AuthSource"
    },
    {
      "name": "Bookmark"
    },
    {
      "name": "CommonParameter"
    },
    {
      "name": "ComputeProfile"
    },
    {
      "name": "ComputeResource"
    },
    {
      "name": "ConfigReport"
    },
    {
      "name": "Domain"
    },
    {
      "name": "FactValue"
    },
    {
      "name": "Host"
    },
    {
      "name": "Hostgroup"
    },
    {
      "name": "Image"
    },
    {
      "name": "Location"
    },
    {
      "name": "Medium"
    },
    {
      "name": "Model"
    },
    {
      "name": "MyPlugin"
    },
    {
      "name": "Operatingsystem"
    },
    {
      "name": "Organization"
    },
    {
      "name": "Parameter"
    },
    {
      "name": "PersonalAccessToken"
    },
    {
      "name": "ProvisioningTemplate"
    },
    {
      "name": "Ptable"
    },
    {
      "name": "Puppetclass"
    },
    {
      "name": "Realm"
    },
    {
      "name": "Report"
    },
    {
      "name": "ReportTemplate"
    },
    {
      "name": "Role"
    },
    {
      "name": "Setting"
    },
    {
      "name": "SmartProxy"
    },
    {
      "name": "Subnet"
    },
    {
      "name": "Test::Resource"
    },
    {
      "name": "User"
    },
    {
      "name": "Usergroup"
    }
  ]
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer