Skip to main content

Get all service policies​

Returns a list of all service policies available to the enterprise.

Query Parameters
  • domainId string

    Possible values: Value must match regular expression ^([A-Za-z0-9]{8}-){0,6}[A-Za-z0-9]{8}$

    Domain id for a service policy to filter on. If omitted, the domain to which the user belongs is used as default.

  • key string

    Name of key in a metadata key-value pair to filter on. Case insensitive exact match is used for the key query parameter meaning that only keys that are identical to the key query parameter are matched.

  • value string

    Name of the value in the metadata key-value pair to filter on. Case insensitive wildcard-based match is used for the value query parameter meaning that if the value query parameter is query, all results matching *query* will be returned. The key parameter is mandatory if the value parameter is included in the request.

Responses

List of service policies.

Schema
  • items object[]

    Array containing service policies

  • attributes object
  • id string

    Possible values: Value must match regular expression ^22[A-HJ-NP-Z2-9]{6}$

    Identifies the service policy.

  • domainId string

    Possible values: Value must match regular expression ^([A-Za-z0-9]{8}-){0,6}[A-Za-z0-9]{8}$

    Domain the resource belongs to. Used to determine which users have access to the resource.

  • name string

    Possible values: non-empty and <= 256 characters

    Name of the service policy.

  • type string

    Possible values: [IOTA_SERVICE_POLICY, ARQIA_SERVICE_POLICY, THINGSPACE_SERVICE_POLICY]

    Specifies the underlying service policy type in the Connectivity Management Platform (CMP).

  • metadata object

    All metadata key-value pairs associated with this service policy. This object contains dynamic properties since metadata has a customized definition process.

  • relationships object
  • cmpServicePolicy object
    anyOf
  • url string

    Possible values: non-empty and <= 256 characters

Loading...