Identity Service API Data Structures
{
"resourceRefId": "string",
"roleId": "string",
"principalId": "string",
"tenant": "string"
}
resourceRefId
roleId
principalId
tenant
{
"syncStatus": {
"message": "string",
"status": "string"
}
}
{
"message": "string",
"status": "string"
}
message
status
{
"href": "string"
}
href
{
"key": "string"
}
key
{
"number": "integer",
"size": "integer",
"last": "boolean",
"numberOfElements": "integer",
"totalPages": "integer",
"content": [
{
"resourceRefId": "string",
"roleId": "string",
"principalId": "string",
"tenant": "string"
}
],
"first": "boolean",
"totalElements": "integer"
}
number
size
last
numberOfElements
totalPages
first
totalElements
{
"number": "integer",
"size": "integer",
"last": "boolean",
"numberOfElements": "integer",
"totalPages": "integer",
"content": [
{
"domainAdminPassword": "string",
"userObjectQuery": "string",
"groupBaseSearchDn": "string",
"certificate": "string",
"description": "string",
"type": "string",
"subdomains": [
"string"
],
"password": "string",
"bindUserObjectQuery": "string",
"alias": "string",
"customDirectorySearchAttribute": "string",
"new": "boolean",
"groupObjectQuery": "string",
"domainAdminUsername": "string",
"trustAll": "boolean",
"url": "string",
"membershipAttribute": "string",
"userNameDn": "string",
"groupBaseSearchDns": [
"string"
],
"distinguishedNameAttribute": "string",
"userBaseSearchDn": "string",
"customDirectorySearchAttributeForGroups": "string",
"domain": "string",
"name": "string",
"userBaseSearchDns": [
"string"
],
"useGlobalCatalog": "boolean",
"objectUuidAttribute": "string"
}
],
"first": "boolean",
"totalElements": "integer"
}
number
size
last
numberOfElements
totalPages
first
totalElements
{
"number": "integer",
"size": "integer",
"last": "boolean",
"numberOfElements": "integer",
"totalPages": "integer",
"content": [
{
"name": "string",
"principalId": {
"domain": "string",
"name": "string"
},
"principalType": "string"
}
],
"first": "boolean",
"totalElements": "integer"
}
number
size
last
numberOfElements
totalPages
first
totalElements
{
"number": "integer",
"size": "integer",
"last": "boolean",
"numberOfElements": "integer",
"totalPages": "integer",
"content": [
{
"subtenantRoles": [
{
"name": "string",
"principalId": [
"string"
],
"id": "string",
"scopeRoleRef": "string"
}
],
"name": "string",
"description": "string",
"id": "string",
"tenant": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}
],
"first": "boolean",
"totalElements": "integer"
}
number
size
last
numberOfElements
totalPages
first
totalElements
{
"number": "integer",
"size": "integer",
"last": "boolean",
"numberOfElements": "integer",
"totalPages": "integer",
"content": [
{
"name": "string",
"principalId": [
"string"
],
"id": "string",
"scopeRoleRef": "string"
}
],
"first": "boolean",
"totalElements": "integer"
}
number
size
last
numberOfElements
totalPages
first
totalElements
{
"passwordPolicyTO": {
"maxConsecutiveIdenticalCharacters": "integer",
"minUpper": "integer",
"minLen": "integer",
"minDigit": "integer",
"maxPreviousPasswordCharactersReused": "integer",
"minLower": "integer",
"tempPasswordTtl": "integer",
"history": "integer",
"passwordTtlInHours": "integer",
"notificationThreshold": "integer",
"minSpecial": "integer",
"notificationInterval": "integer"
}
}
_links
{
"maxConsecutiveIdenticalCharacters": "integer",
"minUpper": "integer",
"minLen": "integer",
"minDigit": "integer",
"maxPreviousPasswordCharactersReused": "integer",
"minLower": "integer",
"tempPasswordTtl": "integer",
"history": "integer",
"passwordTtlInHours": "integer",
"notificationThreshold": "integer",
"minSpecial": "integer",
"notificationInterval": "integer"
}
maxConsecutiveIdenticalCharacters
minUpper
minLen
minDigit
maxPreviousPasswordCharactersReused
minLower
tempPasswordTtl
history
passwordTtlInHours
notificationThreshold
minSpecial
notificationInterval
{
"name": "string",
"description": "string",
"id": "string",
"prereqAdminPermissions": [
"Permission Object"
],
"status": "string"
}
name
description
id
status
{
"domain": "string",
"name": "string"
}
domain
name
{
"resourceTypeRef": {
"id": "string",
"label": "string"
},
"id": "string",
"label": "string",
"tenant": "string"
}
id
label
tenant
{
"id": "string",
"label": "string"
}
id
label
{
"setLocation": "boolean",
"httpStatus": "string"
}
setLocation
httpStatus
httpHeaders
body
{
"assignedPermissions": [
{
"name": "string",
"description": "string",
"id": "string",
"prereqAdminPermissions": [
"Permission Object"
],
"status": "string"
}
],
"name": "string",
"description": "string",
"id": "string",
"status": "string"
}
name
description
id
status
{
"role": {
"assignedPermissions": [
{
"name": "string",
"description": "string",
"id": "string",
"prereqAdminPermissions": [
"Permission Object"
],
"status": "string"
}
],
"name": "string",
"description": "string",
"id": "string",
"status": "string"
},
"assignedPermissions": [
{
"name": "string",
"description": "string",
"id": "string",
"prereqAdminPermissions": [
"Permission Object"
],
"status": "string"
}
],
"name": "string",
"description": "string",
"id": "string",
"status": "string"
}
name
description
id
status
{
"scopeType": {
"name": "string",
"description": "string",
"id": "string",
"prereqAdminPermissions": [
{
"name": "string",
"description": "string",
"id": "string",
"prereqAdminPermissions": [
"Permission Object"
],
"status": "string"
}
],
"status": "string"
},
"name": "string",
"description": "string",
"id": "string",
"tenant": "string",
"status": "string"
}
name
description
id
tenant
status
{
"scope": "string",
"authorities": [
"string"
]
}
scope
authorities
{
"name": "string",
"description": "string",
"id": "string",
"prereqAdminPermissions": [
{
"name": "string",
"description": "string",
"id": "string",
"prereqAdminPermissions": [
"Permission Object"
],
"status": "string"
}
],
"status": "string"
}
name
description
id
status
{
"assignedPermissions": [
{
"name": "string",
"description": "string",
"id": "string",
"prereqAdminPermissions": [
"Permission Object"
],
"status": "string"
}
],
"name": "string",
"description": "string",
"id": "string",
"status": "string"
}
name
description
id
status
{
"defaultTenant": "boolean",
"urlName": "string",
"password": "string",
"contactEmail": "string",
"name": "string",
"description": "string",
"id": "string"
}
defaultTenant
urlName
password
contactEmail
name
description
id
{
"assignedPermissions": [
{
"name": "string",
"description": "string",
"id": "string",
"prereqAdminPermissions": [
"Permission Object"
],
"status": "string"
}
],
"name": "string",
"description": "string",
"id": "string",
"status": "string"
}
name
description
id
status
{
"password": "string",
"tenant": "string",
"username": "string"
}
password
tenant
username
{
"scopeAuthorities": [
{
"scope": "string",
"authorities": [
"string"
]
}
],
"authorities": [
"string"
]
}
authorities
{
"domainAdminPassword": "string",
"userObjectQuery": "string",
"groupBaseSearchDn": "string",
"certificate": "string",
"description": "string",
"type": "string",
"subdomains": [
"string"
],
"password": "string",
"bindUserObjectQuery": "string",
"alias": "string",
"customDirectorySearchAttribute": "string",
"new": "boolean",
"groupObjectQuery": "string",
"domainAdminUsername": "string",
"trustAll": "boolean",
"url": "string",
"membershipAttribute": "string",
"userNameDn": "string",
"groupBaseSearchDns": [
"string"
],
"distinguishedNameAttribute": "string",
"userBaseSearchDn": "string",
"customDirectorySearchAttributeForGroups": "string",
"domain": "string",
"name": "string",
"userBaseSearchDns": [
"string"
],
"useGlobalCatalog": "boolean",
"objectUuidAttribute": "string"
}
domainAdminPassword
userObjectQuery
groupBaseSearchDn
certificate
description
type
subdomains
password
bindUserObjectQuery
alias
customDirectorySearchAttribute
new
groupObjectQuery
domainAdminUsername
trustAll
url
membershipAttribute
userNameDn
groupBaseSearchDns
distinguishedNameAttribute
userBaseSearchDn
customDirectorySearchAttributeForGroups
domain
name
userBaseSearchDns
useGlobalCatalog
objectUuidAttribute
{
"groupType": "string",
"emailAddress": "string",
"fqdn": "string",
"domain": "string",
"name": "string",
"description": "string",
"principalId": {
"domain": "string",
"name": "string"
},
"netbios": "string"
}
groupType
emailAddress
fqdn
domain
name
description
netbios
{
"groupId": "string",
"exists": "boolean"
}
groupId
exists
Wraps a value such that values of different types can be treated generically.
Equivalent of java.util.Map
{
"entries": [
{
"key": "string"
}
]
}
{
"subtenants": [
{
"subtenantRoles": [
{
"name": "string",
"id": "string"
}
],
"name": "string",
"id": "string"
}
],
"principals": [
{
"domain": "string",
"name": "string"
}
],
"currentUserPrincipal": {
"domain": "string",
"name": "string"
},
"tenant": "string"
}
tenant
{
"principalRef": {
"domain": "string",
"name": "string"
},
"displayName": "string",
"systemRoles": [
{
"assignedPermissions": [
{
"name": "string",
"description": "string",
"id": "string",
"prereqAdminPermissions": [
"Permission Object"
],
"status": "string"
}
],
"name": "string",
"description": "string",
"id": "string",
"status": "string"
}
],
"tenantRoles": [
{
"assignedPermissions": [
{
"name": "string",
"description": "string",
"id": "string",
"prereqAdminPermissions": [
"Permission Object"
],
"status": "string"
}
],
"name": "string",
"description": "string",
"id": "string",
"status": "string"
}
],
"id": "string",
"scopes": [
{
"scopeType": {
"name": "string",
"description": "string",
"id": "string",
"prereqAdminPermissions": [
{
"name": "string",
"description": "string",
"id": "string",
"prereqAdminPermissions": [
"Permission Object"
],
"status": "string"
}
],
"status": "string"
},
"name": "string",
"description": "string",
"id": "string",
"tenant": "string",
"status": "string"
}
],
"tenant": "string"
}
displayName
id
tenant
{
"name": "string",
"principalId": {
"domain": "string",
"name": "string"
},
"principalType": "string"
}
name
principalType
{
"domain": "string",
"name": "string"
}
domain
name
{
"signingCertificate": "string",
"name": "string",
"serviceId": "string"
}
signingCertificate
name
serviceId
{
"subtenantRoles": [
{
"name": "string",
"id": "string"
}
],
"name": "string",
"id": "string"
}
name
id
{
"name": "string",
"id": "string"
}
name
id
{
"solutionName": "string",
"certificate": "string",
"description": "string"
}
solutionName
certificate
description
{
"subtenantRoles": [
{
"name": "string",
"principalId": [
"string"
],
"id": "string",
"scopeRoleRef": "string"
}
],
"name": "string",
"description": "string",
"id": "string",
"tenant": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}
name
description
id
tenant
{
"name": "string",
"principalId": [
"string"
],
"id": "string",
"scopeRoleRef": "string"
}
name
principalId
id
scopeRoleRef
{
"principal": "string",
"requestLifetime": "integer",
"validity": "integer",
"signingCert": "string",
"tenant": "string"
}
principal
requestLifetime
validity
signingCert
tenant
A literal defining period of time. This period is represented some integral number of a specified timeUnit.e.g. 6 days.
{
"unit": "string",
"amount": "integer"
}
The unit of measure for the time span. e.g: days.
The amount for the time span.
{
"expires": "string",
"id": "string",
"tenant": "string"
}
expires
id
tenant
{
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"password": "string",
"tenantName": "string",
"name": "string",
"description": "string",
"disabled": "boolean",
"principalId": {
"domain": "string",
"name": "string"
},
"locked": "boolean"
}
firstName
lastName
emailAddress
password
tenantName
name
description
disabled
locked
{
"authoritiesContext": {
"scopeAuthorities": [
{
"scope": "string",
"authorities": [
"string"
]
}
],
"authorities": [
"string"
]
},
"suite": "boolean",
"solution": "boolean",
"samlToken": "string",
"membershipContext": {
"subtenants": [
{
"subtenantRoles": [
{
"name": "string",
"id": "string"
}
],
"name": "string",
"id": "string"
}
],
"principals": [
{
"domain": "string",
"name": "string"
}
],
"currentUserPrincipal": {
"domain": "string",
"name": "string"
},
"tenant": "string"
}
}
suite
solution
samlToken
{
"groups": [
{
"groupType": "string",
"emailAddress": "string",
"fqdn": "string",
"domain": "string",
"name": "string",
"description": "string",
"principalId": {
"domain": "string",
"name": "string"
},
"netbios": "string"
}
],
"parentGroup": {
"groupType": "string",
"emailAddress": "string",
"fqdn": "string",
"domain": "string",
"name": "string",
"description": "string",
"principalId": {
"domain": "string",
"name": "string"
},
"netbios": "string"
},
"users": [
{
"firstName": "string",
"lastName": "string",
"emailAddress": "string",
"password": "string",
"tenantName": "string",
"name": "string",
"description": "string",
"disabled": "boolean",
"principalId": {
"domain": "string",
"name": "string"
},
"locked": "boolean"
}
]
}