security

The Security API endpoints provide an interface for interacting with security-related objects and actions.

LoginActivity

Information about a particular login event.

Properties

Name	Type	Description	Restrictions
city	string
context	string
country	string
created_at	string
failure_reason	string
id	ID	The unique identifier of a resource (can be a GUID).
identity	string
ip	string
region	string
success	boolean
user_id	ID	The unique identifier of a resource (can be a GUID).

Example

{
  "city": "string",
  "context": "string",
  "country": "string",
  "created_at": "string",
  "failure_reason": "string",
  "id": "74",
  "identity": "string",
  "ip": "string",
  "region": "string",
  "success": true,
  "user_id": "74"
}

Activity

An object representing an event within chains.

Properties

Name	Type	Description	Restrictions
created_at	string
id	ID	The unique identifier of a resource (can be a GUID).
key	string
owner_id	ID	The unique identifier of a resource (can be a GUID).
owner_type	string
parameters	object
parameters.id	ID	The unique identifier of a resource (can be a GUID).
recipient_id	ID	The unique identifier of a resource (can be a GUID).
recipient_type	string
trackable_id	ID	The unique identifier of a resource (can be a GUID).
trackable_type	string
updated_at	string

Example

{
  "created_at": "string",
  "id": "74",
  "key": "string",
  "owner_id": "74",
  "owner_type": "string",
  "parameters": {
    "id": "74"
  },
  "recipient_id": "74",
  "recipient_type": "string",
  "trackable_id": "74",
  "trackable_type": "string",
  "updated_at": "string"
}

ActivityResponse

Properties

Name	Type	Description	Restrictions
data	[Activity]	An object representing an event within chains.

Example

{
  "data": [
    {
      "created_at": "string",
      "id": "74",
      "key": "string",
      "owner_id": "74",
      "owner_type": "string",
      "parameters": {
        "id": "74"
      },
      "recipient_id": "74",
      "recipient_type": "string",
      "trackable_id": "74",
      "trackable_type": "string",
      "updated_at": "string"
    }
  ]
}

User

An object containing information about a particular user in Chains.

Properties

Name	Type	Description	Restrictions
created_at	string
email	string
first_name	string¦null
id	ID	The unique identifier of a resource (can be a GUID).
last_name	string¦null
last_sign_in_at	string¦null
sso_enabled	boolean

Example

{
  "created_at": "string",
  "email": "string",
  "first_name": "string",
  "id": "74",
  "last_name": "string",
  "last_sign_in_at": "string",
  "sso_enabled": true
}

UserGroup

An object containing information about a particular group in Chains.

Properties

Name	Type	Description	Restrictions
created_at	string
default	boolean
id	ID	The unique identifier of a resource (can be a GUID).
name	string

Example

{
  "created_at": "string",
  "default": true,
  "id": "74",
  "name": "string"
}

Permission

An object containing information about access permission to particular chains resources.

Properties

Name	Type	Description	Restrictions
id	ID	The unique identifier of a resource (can be a GUID).
name	string
object_id	ID	The unique identifier of a resource (can be a GUID).
object_name	string
object_type	string
user_groups	[UserGroup]	An object containing information about a particular group in Chains.

Enumerated Values

Property	Value
name	read
name	execute
name	write
name	create
name	admin

Example

{
  "id": "74",
  "name": "read",
  "object_id": "74",
  "object_name": "string",
  "object_type": "string",
  "user_groups": [
    {
      "created_at": "string",
      "default": true,
      "id": "74",
      "name": "string"
    }
  ]
}