apm oauth oauth-scope
apm oauth oauth-scope(1) BIG-IP TMSH Manual apm oauth oauth-scope(1)
NAME
oauth-scope - Manages scopes for OAuth Authorization Server.
MODULE
apm oauth
SYNTAX
Configure the oauth-scope component within the oauth module using the following syntax.
CREATE/MODIFY
create oauth-scope [name]
modify oauth-scope [name]
options
app-service [[string] | none]
customization-group [[string] | none]
scope-description [[string] | none]
scope-name [string]
scope-value [[string] | none]
edit oauth-scope [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
DISPLAY
list oauth-scope
list oauth-scope [ [ [name] | [glob] | [regex] ] ... ]
show running-config oauth-scope
show running-config oauth-scope [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
DELETE
delete oauth-scope [name]
DESCRIPTION
You can use the oauth-scope component to create and manage scopes that provide different levels of access
control based on end user's role or any other criteria.
EXAMPLES
create oauth-scope myOAuthScope {
customization-group "company_my_oauth_scope"
scope-description "Group in company"
scope-name "profile"
scope-value "Product Development"
}
Creates a scope named myOAuthScope that uses customization group company_my_oauth_scope to customize scope
information in the OAuth Authorization page. It is configured with profile and Product Development as its
name and value respectively.
list oauth-scope
Displays a list of OAuth Scopes.
delete oauth-scope myOAuthScope
Deletes the OAuth Scope named myOAuthScope.
OPTIONS
app-service
Specifies the name of the application service to which the object belongs. The default value is none.
Note: If the strict-updates option is enabled on the application service that owns the object, you cannot
modify or delete the object. Only the application service can modify or delete the object.
customization-group
Specifies the customization settings for the scope.
[name]
Specifies the name of the OAuth Scope. This setting is required.
partition
Displays the partition within which the component resides.
scope-description
Specifies the description of the scope.
scope-name
Specifies the name of the scope.
scope-value
Specifies the value of the scope. This value can be any string or session variable.
SEE ALSO
apm policy agent oauth-authz, apm oauth oauth-client-app
COPYRIGHT
No part of this program may be reproduced or transmitted in any form or by any means, electronic or
mechanical, including photocopying, recording, or information storage and retrieval systems, for any purpose
other than the purchaser's personal use, without the express written permission of F5 Networks, Inc.
F5 Networks and BIG-IP (c) Copyright 2015-2016. All rights reserved.
BIG-IP 2016-06-30 apm oauth oauth-scope(1)