Get Domain Policy
GET/policies/domain
Returns the domain policy (this policy is managed by the IAM administrator)
Request​
Header Parameters
The default is always the organization of the requesting user. If you like to get/set a result of another organization include the header. Make sure the user has permission to access the requested data.
Responses​
- 200
- default
A successful response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
policy
object
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
the username has to end with the domain of its organization
defines if the organization's admin changed the policy
defines if organization domains should be validated org count as validated automatically
defines if the SMTP sender address domain should match an existing domain on the instance
{
"policy": {
"details": {
"sequence": "2",
"creationDate": "2024-11-15T21:46:16.390Z",
"changeDate": "2024-11-15T21:46:16.390Z",
"resourceOwner": "69629023906488334"
},
"userLoginMustBeDomain": true,
"isDefault": true,
"validateOrgDomains": true,
"smtpSenderAddressMatchesInstanceDomain": true
}
}
- Schema
- Example (from schema)
Schema
policy
object
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
the username has to end with the domain of its organization
defines if the organization's admin changed the policy
defines if organization domains should be validated org count as validated automatically
defines if the SMTP sender address domain should match an existing domain on the instance
{
"policy": {
"details": {
"sequence": "2",
"creationDate": "2024-11-15T21:46:16.391Z",
"changeDate": "2024-11-15T21:46:16.391Z",
"resourceOwner": "69629023906488334"
},
"userLoginMustBeDomain": true,
"isDefault": true,
"validateOrgDomains": true,
"smtpSenderAddressMatchesInstanceDomain": true
}
}
- Schema
- Example (from schema)
Schema
policy
object
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
the username has to end with the domain of its organization
defines if the organization's admin changed the policy
defines if organization domains should be validated org count as validated automatically
defines if the SMTP sender address domain should match an existing domain on the instance
{
"policy": {
"details": {
"sequence": "2",
"creationDate": "2024-11-15T21:46:16.391Z",
"changeDate": "2024-11-15T21:46:16.391Z",
"resourceOwner": "69629023906488334"
},
"userLoginMustBeDomain": true,
"isDefault": true,
"validateOrgDomains": true,
"smtpSenderAddressMatchesInstanceDomain": true
}
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}