Boomi MFT - AFT Management API Reference (v1) - AdminRoles

Toggle Pane

• AdminRoles
  • getRetrieves a list of user roles with optional permission details
  • postCreates a new user role with specified permissions
  • putUpdates an existing user role and its permissions
  • getRetrieves permissions that can be assigned to user roles
  • getRetrieves all available permissions in the system
  • getRetrieves a specific user role by its identifier
  • delDeletes a user role from the system

API docs by Redocly

Download OpenAPI Specification: Download

AdminRoles

Retrieves a list of user roles with optional permission details

Authorizations:

ApiKeyBearer

query Parameters

includePermissions

boolean Default: false Whether to include permission details for each role (default: false)

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

Array

id	integer <int32>
userRoleCode	string or null
userRoleDescription	string or null
isHidden	boolean
deletedDate	string or null <date-time>
permissions	Array of integers or null <int32> [ items <int32 > ]
customerId	integer or null <int32>
isSystemRole	boolean
rank	integer or null <int32>

https://us.thruinc.com/api/AdminRoles

https://uk.thruinc.com/api/AdminRoles

https://eu.thruinc.com/api/AdminRoles

https://au.thruinc.com/api/AdminRoles

Response samples

• 200
• 400

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Creates a new user role with specified permissions

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

User role configuration including name and permissions

id	integer <int32>
userRoleCode	string or null
userRoleDescription	string or null
isHidden	boolean
deletedDate	string or null <date-time>
permissions	Array of integers or null <int32> [ items <int32 > ]
customerId	integer or null <int32>
isSystemRole	boolean
rank	integer or null <int32>

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
userRoleCode	string or null
userRoleDescription	string or null
isHidden	boolean
deletedDate	string or null <date-time>
permissions	Array of integers or null <int32> [ items <int32 > ]
customerId	integer or null <int32>
isSystemRole	boolean
rank	integer or null <int32>

https://us.thruinc.com/api/AdminRoles

https://uk.thruinc.com/api/AdminRoles

https://eu.thruinc.com/api/AdminRoles

https://au.thruinc.com/api/AdminRoles

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "userRoleCode": "string",
• "userRoleDescription": "string",
• "isHidden": true,
• "deletedDate": "2019-08-24T14:15:22Z",
• "permissions": [

  • 0

  ],
• "customerId": 0,
• "isSystemRole": true,
• "rank": 0

}

Response samples

• 200
• 400

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Updates an existing user role and its permissions

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Updated user role configuration

id	integer <int32>
userRoleCode	string or null
userRoleDescription	string or null
isHidden	boolean
deletedDate	string or null <date-time>
permissions	Array of integers or null <int32> [ items <int32 > ]
customerId	integer or null <int32>
isSystemRole	boolean
rank	integer or null <int32>

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
userRoleCode	string or null
userRoleDescription	string or null
isHidden	boolean
deletedDate	string or null <date-time>
permissions	Array of integers or null <int32> [ items <int32 > ]
customerId	integer or null <int32>
isSystemRole	boolean
rank	integer or null <int32>

https://us.thruinc.com/api/AdminRoles

https://uk.thruinc.com/api/AdminRoles

https://eu.thruinc.com/api/AdminRoles

https://au.thruinc.com/api/AdminRoles

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "userRoleCode": "string",
• "userRoleDescription": "string",
• "isHidden": true,
• "deletedDate": "2019-08-24T14:15:22Z",
• "permissions": [

  • 0

  ],
• "customerId": 0,
• "isSystemRole": true,
• "rank": 0

}

Response samples

• 200
• 400

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves permissions that can be assigned to user roles

Authorizations:

ApiKeyBearer

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

Array

id	integer <int32>
description	string or null
isHidden	boolean
deletedDate	string or null <date-time>

https://us.thruinc.com/api/AdminRoles/getAssignablePermissions

https://uk.thruinc.com/api/AdminRoles/getAssignablePermissions

https://eu.thruinc.com/api/AdminRoles/getAssignablePermissions

https://au.thruinc.com/api/AdminRoles/getAssignablePermissions

Response samples

• 200
• 400

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves all available permissions in the system

Authorizations:

ApiKeyBearer

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

Array

id	integer <int32>
description	string or null
isHidden	boolean
deletedDate	string or null <date-time>

https://us.thruinc.com/api/AdminRoles/getAllPermissions

https://uk.thruinc.com/api/AdminRoles/getAllPermissions

https://eu.thruinc.com/api/AdminRoles/getAllPermissions

https://au.thruinc.com/api/AdminRoles/getAllPermissions

Response samples

• 200
• 400

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves a specific user role by its identifier

Authorizations:

ApiKeyBearer

path Parameters

roleId required

integer <int32> Unique identifier of the user role

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
userRoleCode	string or null
userRoleDescription	string or null
isHidden	boolean
deletedDate	string or null <date-time>
permissions	Array of integers or null <int32> [ items <int32 > ]
customerId	integer or null <int32>
isSystemRole	boolean
rank	integer or null <int32>

https://us.thruinc.com/api/AdminRoles/{roleId}

https://uk.thruinc.com/api/AdminRoles/{roleId}

https://eu.thruinc.com/api/AdminRoles/{roleId}

https://au.thruinc.com/api/AdminRoles/{roleId}

Response samples

• 200
• 400

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Deletes a user role from the system

Authorizations:

ApiKeyBearer

path Parameters

roleId required

integer <int32> Unique identifier of the user role to delete

Responses

https://us.thruinc.com/api/AdminRoles/{roleId}

https://uk.thruinc.com/api/AdminRoles/{roleId}

https://eu.thruinc.com/api/AdminRoles/{roleId}

https://au.thruinc.com/api/AdminRoles/{roleId}

Response samples

• 400
• 409

Content type

text/plainapplication/jsontext/jsontext/plain

No sample