Create Role
https://app.fossa.com/api/rolesCreate a new custom role
Request body (required) · application/json
scopeenumrequiredScope of the role
organizationteamnamestringrequiredName of the role
descriptionstringrequiredDescription of the role
permissionsobject[]List of permissions for this role. Each entry must be a permission that exists in the system (see `GET /api/roles/all-permissions`) and is valid for the role's `scope`; otherwise the request is rejected with a `400`.
resourceTypestringrequiredResource type for the permission. Must be a valid `resourceType` returned by `GET /api/roles/all-permissions`, and the `resourceType`/`action` combination must be valid for the role's `scope`.
actionstringrequiredAction for the permission. Must be a valid `action` returned by `GET /api/roles/all-permissions`, and the `resourceType`/`action` combination must be valid for the role's `scope`.
Responses
200Role created successfullyidintegerThe role's unique identifier
organizationIdintegerThe organization's unique identifier
isCustombooleanWhether the role is custom
scopeenumThe role's scope
organizationteamnamestringThe role's name
descriptionstringThe role's description
createdAtstring <date-time>The role's creation date
updatedAtstring <date-time>The role's last update date
permissionsobject[]resourceTypestringThe resource type
actionstringThe action
400Bad RequestuuidstringUnique identifier associated with the error
codeintegerfossa specific error code
messagestringmessage associated with this error
namestringname of the error
httpStatusCodeintegerhttp status code number
403ForbiddenuuidstringUnique identifier associated with the error
codeintegerfossa specific error code
messagestringmessage associated with this error
namestringname of the error
httpStatusCodeintegerhttp status code number
409ConflictuuidstringUnique identifier associated with the error
codeintegerfossa specific error code
messagestringmessage associated with this error
namestringname of the error
httpStatusCodeintegerhttp status code number
500Server ErroruuidstringUnique identifier associated with the error
codeintegerfossa specific error code
messagestringmessage associated with this error
namestringname of the error
httpStatusCodeintegerhttp status code number
Try this endpoint
Build a request and run it against app.fossa.com.
Stored in this browser for 24 hours. Try It uses a docs proxy for CORS and does not store tokens server-side.
POST https://app.fossa.com/api/rolescurl --request POST \ --url 'https://app.fossa.com/api/roles' \ --header 'accept: application/json' \ --header 'authorization: Bearer YOUR_API_TOKEN' \ --header 'content-type: application/json' \ --data '{ "scope": "organization", "name": "Custom Admin Role", "description": "Custom admin role with specific permissions", "permissions": [ { "resourceType": "project_any", "action": "view" }, { "resourceType": "project_any", "action": "edit" } ]}'Real request. Mutating methods can change data.