Your suggested change has been received. Thank you.
Download OpenAPI specification:Download
RITM is a delegated identity management system that allows organisations to securely connect identities through roles and their associated entitlements, while leveraging self-service capabilities.
Introduction to the RITM API
Next to technical API's that are typically used by the RITM platform itself, OneWelcome also provides more functional oriented API's to ease integrations with the customers' applications. This specification is meant to provide information and guidance with respect to the functional RITM API's.
Versions of the API
Our API's are versioned and will remain backwards-compatible for 6 months after the end-of-life for this particular version is announced. Newer versions are expected to be compatible with old versions but both request parameters and response bodies could be subject to changes between versions.
The response body for an API call could contain more information then described in this specification and users of the API should ignore this extra information.
Users with RITM Admin roles and with the correct platform access can create a new group using this API.
code required | string The code corresponding to the group being created. |
name required | string The name of the group. |
structureCode required | string The code corresponding to the structure that the group belongs to. |
groupParent | string If there is a parent, the code of the parent group. |
object | |
Array of objects |
{- "code": "test4",
- "name": "name for test 4",
- "structureCode": "structure-1234567891011",
- "groupParent": "test3",
- "attributes": {
- "vatNumber": 63826383
}, - "roles": [
- {
- "code": "role-673f20jvsklwh",
- "type": "ACCESS"
}, - {
- "code": "role-63nso3bs9ln",
- "type": "ADMIN"
}
]
}
{- "name": "name for test 4",
- "code": "test4",
- "attributes": {
- "vatNumber": 63826383
}, - "roles": [
- {
- "code": "role-673f20jvsklwh",
- "type": "ACCESS"
}, - {
- "code": "role-63nso3bs9ln",
- "type": "ADMIN"
}
]
}