Boomi MFT - AFT Management API Reference (v1) - AdminSsoMapping
Download OpenAPI Specification: Download
For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.
Retrieves all single sign-on (SSO) mapping configurations
Returns list of all SSO attribute mappings configured for identity provider integration.
Authorizations:
Responses
Response Schema:
| id | integer <int32> |
| customerId | integer <int32> |
| attributeName | string or null |
| attributeValue | string or null |
| isDefault | boolean |
| createdBy | string or null |
| createdDate | string or null <date-time> |
| updatedBy | string or null |
| updatedDate | string or null <date-time> |
| deletedBy | string or null |
| deletedDate | string or null <date-time> |
| organizationIds | Array of integers or null <int32> [ items <int32 > ] |
| roleIds | Array of integers or null <int32> [ items <int32 > ] |
Response samples
- 200
- 403
Creates a new single sign-on (SSO) mapping configuration
Establishes new SSO attribute mapping for automatic role and organization assignment during SSO login.
Authorizations:
Request Body schema:
SSO mapping configuration details for identity provider integration
| id | integer <int32> |
| customerId | integer <int32> |
| attributeName | string or null |
| attributeValue | string or null |
| isDefault | boolean |
| createdBy | string or null |
| createdDate | string or null <date-time> |
| updatedBy | string or null |
| updatedDate | string or null <date-time> |
| deletedBy | string or null |
| deletedDate | string or null <date-time> |
| organizationIds | Array of integers or null <int32> [ items <int32 > ] |
| roleIds | Array of integers or null <int32> [ items <int32 > ] |
Responses
Response Schema:
| id | integer <int32> |
| customerId | integer <int32> |
| attributeName | string or null |
| attributeValue | string or null |
| isDefault | boolean |
| createdBy | string or null |
| createdDate | string or null <date-time> |
| updatedBy | string or null |
| updatedDate | string or null <date-time> |
| deletedBy | string or null |
| deletedDate | string or null <date-time> |
| organizationIds | Array of integers or null <int32> [ items <int32 > ] |
| roleIds | Array of integers or null <int32> [ items <int32 > ] |
Request samples
- Payload
{- "id": 0,
- "customerId": 0,
- "attributeName": "string",
- "attributeValue": "string",
- "isDefault": true,
- "createdBy": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "updatedDate": "2019-08-24T14:15:22Z",
- "deletedBy": "string",
- "deletedDate": "2019-08-24T14:15:22Z",
- "organizationIds": [
- 0
], - "roleIds": [
- 0
]
}Response samples
- 200
- 400
- 403
Updates an existing single sign-on (SSO) mapping configuration
Modifies existing SSO mapping configuration including attribute matching and role assignments.
Authorizations:
Request Body schema:
Updated SSO mapping configuration details
| id | integer <int32> |
| customerId | integer <int32> |
| attributeName | string or null |
| attributeValue | string or null |
| isDefault | boolean |
| createdBy | string or null |
| createdDate | string or null <date-time> |
| updatedBy | string or null |
| updatedDate | string or null <date-time> |
| deletedBy | string or null |
| deletedDate | string or null <date-time> |
| organizationIds | Array of integers or null <int32> [ items <int32 > ] |
| roleIds | Array of integers or null <int32> [ items <int32 > ] |
Responses
Response Schema:
| id | integer <int32> |
| customerId | integer <int32> |
| attributeName | string or null |
| attributeValue | string or null |
| isDefault | boolean |
| createdBy | string or null |
| createdDate | string or null <date-time> |
| updatedBy | string or null |
| updatedDate | string or null <date-time> |
| deletedBy | string or null |
| deletedDate | string or null <date-time> |
| organizationIds | Array of integers or null <int32> [ items <int32 > ] |
| roleIds | Array of integers or null <int32> [ items <int32 > ] |
Request samples
- Payload
{- "id": 0,
- "customerId": 0,
- "attributeName": "string",
- "attributeValue": "string",
- "isDefault": true,
- "createdBy": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "updatedDate": "2019-08-24T14:15:22Z",
- "deletedBy": "string",
- "deletedDate": "2019-08-24T14:15:22Z",
- "organizationIds": [
- 0
], - "roleIds": [
- 0
]
}Response samples
- 200
- 400
- 403
Retrieves a specific single sign-on (SSO) mapping configuration
Returns detailed SSO mapping configuration including attribute matching rules and assigned roles.
Authorizations:
path Parameters
| id required | integer <int32> Unique identifier of the SSO mapping |
Responses
Response Schema:
| id | integer <int32> |
| customerId | integer <int32> |
| attributeName | string or null |
| attributeValue | string or null |
| isDefault | boolean |
| createdBy | string or null |
| createdDate | string or null <date-time> |
| updatedBy | string or null |
| updatedDate | string or null <date-time> |
| deletedBy | string or null |
| deletedDate | string or null <date-time> |
| organizationIds | Array of integers or null <int32> [ items <int32 > ] |
| roleIds | Array of integers or null <int32> [ items <int32 > ] |
Response samples
- 200
- 403
- 404
Deletes a single sign-on (SSO) mapping configuration
Removes SSO mapping configuration from the system.
Authorizations:
path Parameters
| id required | integer <int32> Unique identifier of the SSO mapping to delete |
Responses
Response Schema:
| recordsAffected | integer <int32> |
Response samples
- 200
- 403
- 404
Updates multiple single sign-on (SSO) mapping configurations in bulk
Updates multiple SSO mapping configurations in a single operation for efficient bulk management.
Authorizations:
Request Body schema:
List of SSO mapping configurations to update
| id | integer <int32> |
| customerId | integer <int32> |
| attributeName | string or null |
| attributeValue | string or null |
| isDefault | boolean |
| createdBy | string or null |
| createdDate | string or null <date-time> |
| updatedBy | string or null |
| updatedDate | string or null <date-time> |
| deletedBy | string or null |
| deletedDate | string or null <date-time> |
| organizationIds | Array of integers or null <int32> [ items <int32 > ] |
| roleIds | Array of integers or null <int32> [ items <int32 > ] |
Responses
Response Schema:
| id | integer <int32> |
| customerId | integer <int32> |
| attributeName | string or null |
| attributeValue | string or null |
| isDefault | boolean |
| createdBy | string or null |
| createdDate | string or null <date-time> |
| updatedBy | string or null |
| updatedDate | string or null <date-time> |
| deletedBy | string or null |
| deletedDate | string or null <date-time> |
| organizationIds | Array of integers or null <int32> [ items <int32 > ] |
| roleIds | Array of integers or null <int32> [ items <int32 > ] |
Request samples
- Payload
[- {
- "id": 0,
- "customerId": 0,
- "attributeName": "string",
- "attributeValue": "string",
- "isDefault": true,
- "createdBy": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "updatedDate": "2019-08-24T14:15:22Z",
- "deletedBy": "string",
- "deletedDate": "2019-08-24T14:15:22Z",
- "organizationIds": [
- 0
], - "roleIds": [
- 0
]
}
]Response samples
- 200
- 400
- 403