apm oauth oauth-claim
apm oauth oauth-claim(1) BIG-IP TMSH Manual apm oauth oauth-claim(1)
NAME
oauth-claim - Manages claims for OAuth Authorization Server.
MODULE
apm oauth
SYNTAX
Configure the oauth-claim component within the oauth module using the
following syntax.
CREATE/MODIFY
create oauth-claim [name]
modify oauth-claim [name]
options
app-service [[string] | none]
claim-description [[string] | none]
claim-type [boolean | custom | number | string]
claim-name [string]
claim-value [[string] | none]
edit oauth-claim [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
DISPLAY
list oauth-claim
list oauth-claim [ [ [name] | [glob] | [regex] ] ... ]
show running-config oauth-claim
show running-config oauth-claim [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
DELETE
delete oauth-claim [name]
DESCRIPTION
You can use the oauth-claim component to create and manage claims that
provide different levels of access control based on end user's role or
any other criteria.
EXAMPLES
create oauth-claim profileClaim {
claim-description "Employee Profile"
claim-type string
claim-name profile
claim-value https://company.com/username
}
Creates a claim named profileClaim with claim-type set to string,
claim-name set to profile and corresponding value being
https://company.com/username.
list oauth-claim
Displays a list of OAuth Claims.
delete oauth-claim profileClaim
Deletes the OAuth Claim named profileClaim.
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.
[name]
Specifies the name of the OAuth Claim object. This setting is
required.
claim-description
Specifies the description of the claim.
claim-type
Specifies the type of the claim Value.
claim-name
Specifies the name of the claim.
claim-value
Specifies the value of the claim. This value can be any string or
session variable.
SEE ALSO
apm policy agent oauth-authz, apm oauth oauth-client-app apm profile
oauth
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 2017. All rights reserved.
BIG-IP 2018-02-06 apm oauth oauth-claim(1)