apm oauth oauth-resource-server
apm oauth oauth-resource-server(1) BIG-IP TMSH Manual apm oauth oauth-resource-server(1)
NAME
oauth-resource-server - Manages resource servers to use with OAuth Authorization Server.
MODULE
apm oauth
SYNTAX
Configure the oauth-resource-server component within the oauth module using the following syntax.
CREATE/MODIFY
create oauth-resource-server [name]
modify oauth-resource-server [name]
options:
app-service [[string] | none]
description [[string] | none]
auth-type [none | secret | certificate]
regenerate-resource-server-secret
resource-server-cert-dn [[string] | none]
edit oauth-resource-server [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
DISPLAY
list oauth-resource-server
list oauth-resource-server [ [ [name] | [glob] | [regex] ] ... ]
show running-config oauth-resource-server
show running-config oauth-resource-server [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
DELETE
delete oauth-resource-server [name]
DESCRIPTION
You can use the oauth-resource-server component to register and manage resource servers that host resources
that will be accessed by the user. Resource servers can accept and respond to protected resource requests
using access tokens.
EXAMPLES
create oauth-resource-server myResourceServer {
resource-server-cert-dn "/C=US/ST=CA/L=SJ/O=Company Name,Inc/OU=Engg/CN=user-name/emailAddress=username@company-domain.com"
}
Creates a resource server named myResourceServer that will use the generated resource server credentials
to send requests to the Authorization server. It uses the default authentication type "certificate".
list oauth-resource-server
Displays a list of registered resource servers.
delete oauth-resource-server myResourceServer
Deletes the OAuth resource server myResourceServer.
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.
auth-type
Specifies the authentication type the resource server will use when it makes requests to the
Authorization Server. The default value is certificate and other possible values are none and secret.
[name]
Specifies the name of the OAuth Resource Server. This setting is required.
description
Specifies the description of the OAuth Resource Server Object.
partition
Displays the partition within which the component resides.
regenerate-resource-server-secret
Indicates a request to regenerate the resource server secret. Do not use other means to modify the
secret.
resource-server-cert-dn
Specifies the distinguished name of the resource server certificate that is used to validate a request
from the resource server when authentication type is set to certificate.
resource-server-id
Specifies the resource server ID that uniquely identifies the resource server. This field will be auto-
generated and should not be specified or modified. Also, this entry cannot be edited after it has been
generated.
resource-server-secret
Specifies the resource server secret that is used to validate a request from the resource server when
authentication type is set to secret. This field will be auto-generated and should not be specified or
modified.
SEE ALSO
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 2015-2016. All rights reserved.
BIG-IP 2016-11-08 apm oauth oauth-resource-server(1)