Boomi Platform API Reference (1.0.0) - Getassignableroles

Toggle Pane

• Get assignable roles
  • getRetrieve assignable roles

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

Get assignable roles

Retrieve assignable roles

You can use the Get Assignable Roles operation to retrieve a list of roles that are assignable under an account.

Authorizations:

basicAuth

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

	Array of objects (Role)
Array Description string Description of the role object (Privileges) One or more privileges assigned to the role. accountId string The account ID under which the role exists. id string The ID of the role. name string The name of the role. parentId string The ID of the role from which this role inherits privileges.

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/GetAssignableRoles

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "",
• "Role": [

  • {

    • "@type": "Role",
    • "description": "Boomi Default Administrator role.",
    • "id": "fcb6dd44-0ca8-11e2-a477-1231381987a5",
    • "accountId": "1",
    • "name": "Administrator",
    • "parentId": "fcb6e2d0-0ca8-11e2-a477-1231381987a5"

    },
  • {

    • "@type": "Role",
    • "description": "Boomi Default Production Support User role.",
    • "id": "fcb6e3b6-0ca8-11e2-a477-1231381987a5",
    • "accountId": "1",
    • "name": "Production Support",
    • "parentId": "fcb6e2d0-0ca8-11e2-a477-1231381987a5"

    },
  • {

    • "@type": "Role",
    • "description": "Boomi Default Standard User role.",
    • "id": "fcb6e2d0-0ca8-11e2-a477-1231381987a5",
    • "accountId": "1",
    • "name": "Standard User",
    • "parentId": "fcb6e2d0-0ca8-11e2-a477-1231381987a5"

    },
  • {

    • "@type": "Role",
    • "description": "Boomi Default Basic Support User role.",
    • "id": "fcb6e474-0ca8-11e2-a477-1231381987a5",
    • "accountId": "1",
    • "name": "Support",
    • "parentId": "fcb6e2d0-0ca8-11e2-a477-1231381987a5"

    },
  • {

    • "@type": "Role",
    • "description": "",
    • "id": "01234567-89ab-cdef-0123-456789abcdef",
    • "accountId": "account-123456",
    • "name": "TestRole",
    • "parentId": "fcb6e2d0-0ca8-11e2-a477-1231381987a5"

    },
  • {

    • "@type": "Role",
    • "description": "",
    • "id": "fedcba98-7654-3210-fedc-ba9876543210",
    • "accountId": "account-123456",
    • "name": "Test2",
    • "parentId": "fcb6e2d0-0ca8-11e2-a477-1231381987a5"

    }

  ]

}