UpdateAddress
objectArray of protocol IDs (UUIDs) to associate with this address
Example:550e8400-e29b-41d4-a716-446655440000
Network address (IP address or domain name)
Example:192.168.1.100
{
"address": "192.168.1.100",
"protocols": [
"550e8400-e29b-41d4-a716-446655440000"
]
}CreateProtocol
objectData required to create a new network protocol definition
Human-readable name for the protocol
Example:Custom Web Services
Array of network protocol configurations (TCP, UDP, ICMP)
Example:{"protocol":"TCP","port":"80"}
Show Child Parameters
{
"name": "Custom Web Services",
"networkProtocols": [
{
"protocol": "TCP",
"port": "8080"
},
{
"protocol": "TCP",
"port": "8443"
}
]
}CreateGroup
objectData required to create a new user group
Array of role IDs to assign to the group
Example:550e8400-e29b-41d4-a716-446655440000, 550e8400-e29b-41d4-a716-446655440001
Human-readable name for the group
Example:Marketing Team
Detailed description of the group’s purpose and scope
Example:Marketing team with access to customer data and analytics tools
{
"name": "Marketing Team",
"description": "Marketing team with access to customer data and analytics tools",
"roles": [
"550e8400-e29b-41d4-a716-446655440000",
"550e8400-e29b-41d4-a716-446655440001"
]
}GroupUser
objectUser information within a group context
Unique identifier for the user
Example:550e8400-e29b-41d4-a716-446655440000
Timestamp when the user was added to the group
Example:2023-01-15T10:30:00Z
Timestamp when the user’s group membership was last modified
Example:2023-01-15T10:30:00Z
User’s first name
Example:John
User’s last name
Example:Doe
User’s email address
Example:john.doe@company.com
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@company.com",
"createdAt": "2023-01-15T10:30:00Z",
"updatedAt": "2023-01-15T10:30:00Z"
}Group
objectComplete user group information with members, roles, and configuration
Unique identifier for the group
Example:550e8400-e29b-41d4-a716-446655440000
Timestamp when the group was created
Example:2023-01-15T10:30:00Z
Timestamp when the group was last modified
Example:2023-01-15T10:30:00Z
Human-readable name for the group
Example:Engineering Team
Detailed description of the group’s purpose and scope
Example:Software engineering team with access to development resources
User role definition with specific permissions and capabilities
Show Child Parameters
Whether this group can be deleted
Example:true
User information within a group context
Example:{"id":"550e8400-e29b-41d4-a716-446655440000","firstName":"John","lastName":"Doe","email":"john.doe@company.com","createdAt":"2023-01-15T10:30:00Z","updatedAt":"2023-01-15T10:30:00Z"}
Show Child Parameters
Maximum number of devices per user in this group
Example:5
Whether this is the default group for SAML users
Identity provider mapping for this group
Example:engineering@company.com
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Engineering Team",
"description": "Software engineering team with access to development resources",
"deleteable": true,
"maxDevices": 5,
"isSamlDefaultGroup": false,
"idpMapping": [
"engineering@company.com"
],
"createdAt": "2023-01-15T10:30:00Z",
"updatedAt": "2023-01-15T10:30:00Z"
}