Create Access rule Entity

Create Access rule Entity. It describes access rules which can be attached to identifiers.

application/json

Request Body required

• name string required

  Possible values: <= 100 characters

  Name of access rule entity

• description string required

  Possible values: <= 255 characters

  Description of access rule entity

• settings object[] required

  Describes relations the reader-to-relay relationship for the access rule entity

  reader string required

  Unique reader identifier

  relays integer[] required

  Set of relays

Responses

• 200
• 400
• 401

---

The id value returned in the response can be used as the access-rule-id parameter in:

• GET /access/access-rules/{access-rule-id}

• to get info about access rule

• PATH /access/access-rules/{access-rule-id}

• to update access rule

• DELETE /access/access-rules/{access-rule-id}

• to remove access rule

• POST /access/identifiers/{identifier-id}/access-rules/{access-rule-id}

• to attach access rule to identifier with id identifier-id

• DELETE /access/identifiers/{identifier-id}/access-rules/{access-rule-id}

• to detach access rule from identifier with id identifier-id

application/json

• Schema
• Example (from schema)

---

Schema

• id integer

  Possible values: >= -1

  UID for entities references. If value is -1, then it means that is no entity reference for this structure

{
  "id": 3
}

Bad Request

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error object

  Error object, contains error details

  code string

  Possible values: [invalid_authentication, permission_denied, not_valid, system_error, bad_request, connection_timeout]

  Error code

  message string

  Error message

  data object

  Did not pass validation parameters. Can be represented as an object, which can include field names, arrays, query parameters etc.

  param string

  Contains validation error details

{
  "error": {
    "code": "not_valid",
    "message": "Data validation error",
    "data": {
      "param": "must be an string"
    }
  }
}

{
  "error": {
    "code": "bad_request",
    "message": "Bad request sent"
  }
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error object

  Error object, contains error details

  code string

  Possible values: [invalid_authentication, permission_denied, not_valid, system_error, bad_request, connection_timeout]

  Error code

  message string

  Error message

  data object

  Did not pass validation parameters. Can be represented as an object, which can include field names, arrays, query parameters etc.

  param string

  Contains validation error details

{
  "error": {
    "code": "not_valid",
    "message": "Data validation error",
    "data": {
      "param": "must be an string"
    }
  }
}

{
  "error": {
    "code": "invalid_authentication",
    "message": "Invalid authentication"
  }
}

Loading...