Management API application integrations - SSO
Site (site)
Attributes of site
| name | type | quantifier | access |
|---|---|---|---|
| description | string | multi-value | |
| string | multi-value | ||
| name | string | required | create+read |
Links from site
| link name | link type | access | example |
|---|---|---|---|
| method | /site/Site/Site/$link/method/method.1 | ||
| site | read-only | /site/Site/Site/$link/site/Site | |
| managedBy | group | /site/Site/Site/$link/managedBy/group/Site/group1 | |
| one | application | read-only | /site/Site/Site/$link/one/application/Site/application1 |
| one | group | read-only | /site/Site/Site/$link/one/group/Site/group1 |
| one | outboundMappingPolicy | read-only | /site/Site/Site/$link/one/outboundMappingPolicy/Site/outboundMappingPolicy1 |
| one | policy | read-only | /site/Site/Site/$link/one/policy/Site/policy1 |
| one | refreshTokenPolicy | read-only | /site/Site/Site/$link/one/refreshTokenPolicy/Site/refreshTokenPolicy1 |
| one | site | read-only | /site/Site/Site/$link/one/site/Site |
| one | user | read-only | /site/Site/Site/$link/one/user/Site/user1 |
| sub | application | read-only | /site/Site/Site/$link/sub/application/Site/application1 |
| sub | group | read-only | /site/Site/Site/$link/sub/group/Site/group1 |
| sub | outboundMappingPolicy | read-only | /site/Site/Site/$link/sub/outboundMappingPolicy/Site/outboundMappingPolicy1 |
| sub | policy | read-only | /site/Site/Site/$link/sub/policy/Site/policy1 |
| sub | refreshTokenPolicy | read-only | /site/Site/Site/$link/sub/refreshTokenPolicy/Site/refreshTokenPolicy1 |
| sub | site | read-only | /site/Site/Site/$link/sub/site/Site |
| sub | user | read-only | /site/Site/Site/$link/sub/user/Site/user1 |
Application (application)
Attributes of application
| name | type | quantifier | access |
|---|---|---|---|
| applicationType | string | read | |
| configuration | string | multi-value | |
| description | string | multi-value | |
| enabled | boolean | ||
| entityID | string | read | |
| string | multi-value | ||
| name | string | required | create+read |
| platform | string | ||
| template | string | ||
| ticketValidityTime | number | multi-value | |
| url | string |
Links from application
| link name | link type | access | example |
|---|---|---|---|
| method | /application/Site/application1/$link/method/method.1 | ||
| outboundMappingPolicy | /application/Site/application1/$link/outboundMappingPolicy/Site/outboundMappingPolicy1 | ||
| policy | /application/Site/application1/$link/policy/Site/policy1 | ||
| refreshTokenPolicy | /application/Site/application1/$link/refreshTokenPolicy/Site/refreshTokenPolicy1 | ||
| site | read-only | /application/Site/application1/$link/site/Site | |
| allowedTo | group | /application/Site/application1/$link/allowedTo/group/Site/group1 |
Group (group)
Attributes of group
| name | type | quantifier | access |
|---|---|---|---|
| condition | string | multi-value | |
| description | string | multi-value | |
| memberURL | string | multi-value | |
| name | string | required | create+read |
Links from group
| link name | link type | access | example |
|---|---|---|---|
| method | /group/Site/group1/$link/method/method.1 | ||
| policy | many-to-many | /group/Site/group1/$link/policy/Site/policy1 | |
| policyItem | /group/Site/group1/$link/policyItem/Site/policy1/policyItem1 | ||
| site | read-only | /group/Site/group1/$link/site/Site | |
| accessTo | application | /group/Site/group1/$link/accessTo/application/Site/application1 | |
| manages | site | /group/Site/group1/$link/manages/site/Site | |
| member | group | /group/Site/group1/$link/member/group/Site/group1 | |
| member | user | /group/Site/group1/$link/member/user/Site/user1 | |
| memberOf | group | /group/Site/group1/$link/memberOf/group/Site/group1 |
Outbound User Mapping Policy (outboundMappingPolicy)
Attributes of outboundMappingPolicy
| name | type | quantifier | access |
|---|---|---|---|
| name | string | required | create+read |
| nameIDFormat | string | required | create+read |
| nameValue | string | multi-value | |
| platform | string |
Links from outboundMappingPolicy
| link name | link type | access | example |
|---|---|---|---|
| application | /outboundMappingPolicy/Site/outboundMappingPolicy1/$link/application/Site/application1 | ||
| outboundUserMapping | read-only | /outboundMappingPolicy/Site/outboundMappingPolicy1/$link/outboundUserMapping/Site/outboundMappingPolicy1/outboundUserMapping1 | |
| site | read-only | /outboundMappingPolicy/Site/outboundMappingPolicy1/$link/site/Site | |
| user | many-to-many | /outboundMappingPolicy/Site/outboundMappingPolicy1/$link/user/Site/user1 |
Outbound User Mapping (outboundUserMapping)
Attributes of outboundUserMapping
| name | type | quantifier | access |
|---|---|---|---|
| name | string | create+read | |
| user | reference | required | create+update |
| username | string | required |
Links from outboundUserMapping
| link name | link type | access | example |
|---|---|---|---|
| outboundMappingPolicy | read-only | /outboundUserMapping/Site/outboundMappingPolicy1/outboundUserMapping1/$link/outboundMappingPolicy/Site/outboundMappingPolicy1 | |
| user | /outboundUserMapping/Site/outboundMappingPolicy1/outboundUserMapping1/$link/user/Site/user1 |
Authorization Policy (policy)
Attributes of policy
| name | type | quantifier | access |
|---|---|---|---|
| configuration | string | multi-value | |
| description | string | multi-value | |
| name | string | required | create+read |
| platform | string | ||
| required | string | multi-value | |
| singleValue | string | multi-value |
Links from policy
| link name | link type | access | example |
|---|---|---|---|
| application | /policy/Site/policy1/$link/application/Site/application1 | ||
| group | many-to-many | /policy/Site/policy1/$link/group/Site/group1 | |
| policyItem | read-only | /policy/Site/policy1/$link/policyItem/Site/policy1/policyItem1 | |
| site | read-only | /policy/Site/policy1/$link/site/Site |
Authorization Entry (policyItem)
Attributes of policyItem
| name | type | quantifier | access |
|---|---|---|---|
| attributeName | string | required | |
| attributeValue | string | required | |
| group | reference | required | create+update |
| name | string | create+read | |
| nameValue | string | multi-value |
Links from policyItem
| link name | link type | access | example |
|---|---|---|---|
| group | /policyItem/Site/policy1/policyItem1/$link/group/Site/group1 | ||
| policy | read-only | /policyItem/Site/policy1/policyItem1/$link/policy/Site/policy1 |
Supported values of nameValue in policyItem
| name | value description | example |
|---|---|---|
| scope | A value to use in the scope of the policyItem | nameValue=scope email |
Refresh Token Policy (refreshTokenPolicy)
Attributes of refreshTokenPolicy
| name | type | quantifier | access |
|---|---|---|---|
| configuration | string | multi-value | |
| description | string | multi-value | |
| name | string | required | create+read |
| platform | string |
Links from refreshTokenPolicy
| link name | link type | access | example |
|---|---|---|---|
| application | /refreshTokenPolicy/Site/refreshTokenPolicy1/$link/application/Site/application1 | ||
| site | read-only | /refreshTokenPolicy/Site/refreshTokenPolicy1/$link/site/Site |
User (user)
Attributes of user
| name | type | quantifier | access |
|---|---|---|---|
| description | string | multi-value | |
| enabled | boolean | ||
| givenName | string | multi-value | |
| string | multi-value | ||
| mobile | string | multi-value | |
| name | string | required | create+read |
| organization | string | multi-value | |
| surname | string | multi-value, required | |
| uid | string | multi-value |
Links from user
| link name | link type | access | example |
|---|---|---|---|
| method | /user/Site/user1/$link/method/method.1 | ||
| outboundMappingPolicy | many-to-many | /user/Site/user1/$link/outboundMappingPolicy/Site/outboundMappingPolicy1 | |
| outboundUserMapping | /user/Site/user1/$link/outboundUserMapping/Site/outboundMappingPolicy1/outboundUserMapping1 | ||
| site | read-only | /user/Site/user1/$link/site/Site | |
| memberOf | group | /user/Site/user1/$link/memberOf/group/Site/group1 |