Role.md

Role

Properties

Name	Type	Description	Notes
created	datetime	{ "description" : "The UTC DateTime when the object was created.", "verbs":[] }	[optional]
changed_by	str	{ "description" : "ID of the user who last updated the entity.", "verbs":[] }	[optional]
updated	datetime	{ "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }	[optional]
id	str	{ "description" : "", "verbs":["GET"] }	[optional]
organization_id	str	{ "description" : "", "verbs":[""] }	[optional]
name	str	{ "description" : "Friendly name of the role.", "verbs":["GET","POST","PUT"] }	[optional]
description	str	{ "description" : "Friendly description of the role.", "verbs":["GET","POST","PUT"] }	[optional]
revoked	datetime	{ "description" : "If a role is deleted it is set as revoked from this date. Any account in the role will no longer have its permissions.", "verbs":["GET","POST","PUT"] }	[optional]
deleted	bool	{ "default" : "false", "description" : "If a role is deleted any account in the role will no longer have its permissions.", "verbs":["GET","POST","PUT"] }	[optional] [default to False]
default_role	bool	{ "default" : "false", "description" : "If set this role will become the default role for the organization. Any accounts without an explicitly set role will have this applied.", "verbs":["GET","POST","PUT"] }	[optional] [default to False]
default_returned	bool	{ "default" : "false", "description" : "When returning the list of roles for an account, this indicates if the role was returned due to defaulting.", "verbs":["GET","POST","PUT"] }	[optional] [default to False]
permissions	list[BFPermission]	{ "description" : "List of permissions in this role.", "verbs":["GET","POST","PUT"] }	[optional]

[Back to Model list] [Back to API list] [Back to README]