Security Identity Models
Security Identity Models
In this article
BatchIdentityBody
See also:
Key | Value type |
---|---|
members |
Array of IdentityBody
|
mappings |
Array of MappedIdentityBody
|
deleted |
Array of BaseIdentityBody
|
Sample BatchIdentityBody
{
"members": [
{
"identity": {
"name": "SampleGroup",
"type": "GROUP",
"additionalInfo": {}
},
"members": [
{
"name": "asmith@example.com",
"type": "USER",
"additionalInfo": {}
}
],
"wellKnowns": [
{
"name": "SampleGrantedIdentity",
"type": "GROUP",
"additionalInfo": {}
}
]
}
],
"mappings": [
{
"identity": {
"name": "asmith@example.com",
"type": "USER",
"additionalInfo": {}
},
"mappings": [
{
"name": "alice_smith@example.com",
"type": "USER",
"provider": "Email Security Provider",
"additionalInfo": {}
}
],
"wellKnowns": [
{
"name": "SampleGrantedIdentity2",
"type": "VIRTUAL_GROUP",
"additionalInfo": {}
}
]
}
],
"deleted": [
{
"identity": {
"name": "bjones@example.com",
"type": "USER",
"additionalInfo": {}
}
}
]
}
IdentityBody
See also:
- Add or Update a Single Security Identity in a Security Identity Provider.
- Security Identity Definition Examples.
Key | Value type |
---|---|
identity |
Identity |
members |
Array of Identity
|
wellKnowns |
Array of Identity
|
Sample IdentityBody
{
"identity": {
"name": "SampleGroup",
"type": "GROUP",
"additionalInfo": {}
},
"members": [
{
"name": "asmith@example.com",
"type": "USER",
"additionalInfo": {}
}
],
"wellKnowns": [
{
"name": "SampleGrantedIdentity",
"type": "GROUP",
"additionalInfo": {}
}
]
}
BaseIdentityBody
See also:
Key | Value type |
---|---|
identity |
Identity |
Sample BaseIdentityBody
{
"identity": {
"name": "bjones@example.com",
"type": "USER",
"additionalInfo": {}
}
}
Identity
Key | Value type |
---|---|
name |
String |
type |
"GROUP" | "UNKNOWN" | "USER" | "VIRTUAL_GROUP"
|
additionalInfo |
Object |
Sample Identity
{
"name": "asmith@example.com",
"type": "USER",
"additionalInfo": {}
}
MappedIdentityBody
See also:
Key | Value type |
---|---|
identity |
Identity |
mappings |
Array of MappedIdentity
|
wellKnowns |
Array of Identity
|
Sample MappedIdentityBody
{
"identity": {
"name": "asmith@example.com",
"type": "USER",
"additionalInfo": {}
},
"mappings": [
{
"name": "alice_smith@example.com",
"type": "USER",
"provider": "Email Security Provider",
"additionalInfo": {}
}
],
"wellKnowns": [
{
"name": "SampleGrantedIdentity2",
"type": "VIRTUAL_GROUP",
"additionalInfo": {}
}
]
}
MappedIdentity
Key | Value type |
---|---|
name |
String |
type |
Group | Unknown |User |VirtualGroup
|
provider |
String |
additionalInfo |
Object |
Sample MappedIdentity
{
"name": "alice_smith@example.com",
"type": "USER",
"provider": "Email Security Provider",
"additionalInfo": {}
}