apm aaa oauth-provider

apm aaa oauth-provider(1)     BIG-IP TMSH Manual     apm aaa oauth-provider(1)



NAME
       oauth-provider - Manages an OAuth Provider.

MODULE
       apm aaa

SYNTAX
       Configure the oauth-provider component within the aaa module using the
       syntax shown in the following sections.

   CREATE/MODIFY
	create oauth-provider [name]
	modify oauth-provider [name]
	  options:
	   app-service [[string] | none]
	   authentication-uri [[string] | none]
	   description [[string] | none]
	   token-uri [[string] | none]
	   token-validation-scope-uri [[string] | none]
	   type [custom | f5 | facebook | google | ping]

	edit oauth-provider[ [ [name] | [glob] | [regex] ] ... ]
	  options:
	    all-properties
	    non-default-properties

   DISPLAY
	list oauth-provider
	list oauth-provider [ [ [name] | [glob] | [regex] ] ... ]
	  options:
	    all-properties
	    app-service
	    non-default-properties
	    one-line
	    partition

   DELETE
	delete oauth-provider [name]

DESCRIPTION
       You can use the oauth-provider component to manage an OAuth Provider.
       The OAuth Provider specifies endpoint URIs to retrieve token, refresh
       token, validate token, get a list of scopes associated with token and
       redirect user to obtain authorization_code.

EXAMPLES
       create oauth-provider f5Provider { authentication-uri
       https://local.f5.com/f5-oauth2/v1/authorize description "OAuth provider
       defines F5 AS" token-uri https://local.f5.com/f5-oauth2/v1/token token-
       validation-scope-uri https://local.f5.com/f5-oauth2/v1/validate type f5
       }
	    Creates the OAuth Provider named f5Provider of type f5, defines
	    all endpoint URIs to the local Authorization Server.

       delete oauth-provider f5Provider
	    Deletes the OAuth Provider named f5Provider from the system.

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.

       authentication-uri
	    The endpoint URI that is used to redirect user for authentication
	    in order to get authorization_code.  This endpoint is used by
	    OAuth Client agent, when grant type is configured to Authorization
	    Code.

       description
	    Specifies a description for the component. The default is none.

       partition
	    Displays the partition within which the component resides. The
	    default is Common.

       token-uri
	    The endpoint URI that is used to retrieve an access_token.	This
	    endpoint is used by OAuth Client agent.

       token-validation-scope-uri
	    The endpoint URI that is used by OAuth Scope agent, in order to
	    retrieve a list of scopes associated with an access_token.	The
	    same URI is used to validate an access_token by OAuth Client
	    agent.

       type The type of the provider.

	    custom The provider is using a custom Authorization Server.
	    f5 The provider is using an F5 Authorization Server.
	    facebook The provider is Facebook Authorization Server.
	    google The provider is Google Authorization Server.
	    ping The provider is Ping Identity Authorization Server.
		 Default value for provider type is f5.

SEE ALSO
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 2011-2013, 2015-2016. All rights
       reserved.



BIG-IP				  2017-01-20	     apm aaa oauth-provider(1)