APIRef_tm_auth_remote-role_role-info¶

mgmt/tm/auth/remote-role/role-info

Role information configuration

REST Endpoints

Collection URI: /mgmt/tm/auth/remote-role/role-info
Collection Methods: OPTIONS, GET
Resource URI: /mgmt/tm/auth/remote-role/role-info/~resource id
Resource Methods: OPTIONS, GET, PUT, PATCH, DELETE, POST
Resource Natural Key: name

Properties

Name	Type	Required	Access	Description
`attribute`	string	required	read/write	Specifies the name of the group of remotely-authenticated users for whom you are configuring specific access rights to the BIG-IP system. This value is required.
`console`	string	optional	read/write	Enables or disables console access for the specified group of remotely authenticated users. You may specify disabled, tmsh or use variable substitution as describe in the help page. The default value is disabled.
`deny`	string	optional	read/write	Enables or disables remote access for the specified group of remotely authenticated users. The default value is disable.
`description`	string	optional	read/write	User defined description.
`lineOrder`	integer	required	read/write	Specifies the order of the line in the file, /config/bigip/auth/remoterole. The LDAP and Active Directory servers read this file line by line. The order of the information is important; therefore, F5 recommends that you set the first line at 1000. This allows you, in the future, to insert lines before the first line. This value is required.
`role`	string	optional	read/write	Specifies the role that you want to grant to the specified group of remotely authenticated users. The default value is no-access. The available roles and the corresponding number that you use to specify the role are: admin (0), resource-admin (20), user-manager (40), auditor (80), manager (100), application-editor (300), operator (400), firewall-manager (450), fraud-protection-manager (480), certificate-manager (500), irule-manager (510), guest (700), web-application-security-administrator (800), web-application-security-editor (810), acceleration-policy-editor (850) and no-access (900).
`userPartition`	string	optional	read/write	Specifies the user partition to which you are assigning access to the specified group of remotely authenticated users. The default value is Common.

iControl Reference Index

The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.