apm oauth token-detailsΒΆ

apm oauth token-details(1)    BIG-IP TMSH Manual    apm oauth token-details(1)



NAME
       Token-Details - Displays OAuth token properties and revokes access
       tokens and refresh tokens.

MODULE
       apm oauth token-details

SYNTAX
       Lists the token-details within the oauth module using the syntax shown
       in the following sections.

   DISPLAY
	list token-details
	list token-details [ [ [oauth-id] | [app-name] | [client-id] | [offset] | [db-instance] ] ... ]
	  options:
	    all-properties
	    non-default-properties
	    one-line
	    recursive
	  output only properties:
	    access-token-status [[string] | none]
	    access-token-issued-at [[string] | none]
	    access-token-expires-at [[string] | none]
	    refresh-token-status [[string] | none]
	    refresh-token-issued-at [[string] | none]
	    refresh-token-expires-at [[string] | none]
	    grant-type [[string] | none]
	    user-agent [[string] | none]

	show token-details
	show token-details [ [ [app-name] | [client-id] | [offset] | [db-instance] ] ... ]
	  options:
	    field-fmt
	    recursive

   REVOKE
	revoke token-details  [ [oauth-id client-id ] ]

DESCRIPTION
       You can use the token-details component to manage oauth tokens.

EXAMPLES
       list apm oauth token-details
	    Lists all the token details for the oauth default db instance of
	    oauthdb.

       list apm oauth token-details db-instance test
	    Lists all the token details for the oauth db instance test.

       list apm oauth token-details client-app myapp
	    Lists all the token details for the client app myapp in the
	    default db instance.

       show apm oauth token-details
	    Shows the number of tokens in the oauth default db instance of
	    oauthdb.

       show apm oauth token-details db-instance test
	    Shows the number of tokens in oauth db instance test.

       show apm oauth token-details client-app myapp
	    Shows the number of token for the client app myapp in default db
	    instance.

       revoke apm oauth token-details
       93b225478484f0fa0addc527b2c50001d7e3yyb70c3eda99e56 client-id
       ae8b6cd3708a5805e84ae48369ab0001d7eb70c1325c8d56
	    Revokes the access/refresh token for oauth id
	    93b225478484f0fa0addc527b2c50001d7eb70c3eda99e56 and client id
	    ae8b6cd3708a5805e84ae48369ab0001d7eb70c1325c8d56.

       revoke apm oauth token-details
       93b225478484f0fa0addc527b2c50001d7e3yyb70c3eda99e56 db-instance test
       client-id ae8b6cd3708a5805e84ae48369ab0001d7eb70c1325c8d56
	    Revokes the access/refresh token for oauth id
	    93b225478484f0fa0addc527b2c50001d7eb70c3eda99e56 and client id
	    ae8b6cd3708a5805e84ae48369ab0001d7eb70c1325c8d56 in the db
	    instance test.

OPTIONS
       client-id
	    Specifies the client id for which the token is generated. Must be
	    specified for revoke command.

       app-name
	    Specifies the app name for which the token is generated. This is
	    an optional parameter for list and show commands.

       offset
	    Specifies the number of tokens to skip before beginning to display
	    the remaining tokens.

	    Example: list apm oauth token-details offset 10

	    This will return the tokens from the count of 11 and will skip the
	    first 10.

       db-instance
	    This specifies the db instance. If no value is specified, oauthdb
	    (the default db instance) is used.

       user-id
	    Specifies the user id for which the token is generated.

       oauth-id
	    Specifies oauth id. Displays in the output of the list command.

       access-token-status
	    Specifies the access token status, such as active,inactive,expired
	    and revoked. Displays in the output of the list command. Access
	    token status changes from active to expired only when a token
	    validate request is attempted after the expiry time.

       access-token-issued-at
	    Specifies the access token issued timestamp. The format is "YYYY-
	    MM-DD HH:MM:SS". Displays in the output of the list command.

       access-token-expires-at
	    Specifies the access token expiry timestamp. The format is "YYYY-
	    MM-DD HH:MM:SS". Displays in the output of the list command.

       refresh-token-status
	    Specifies the refresh token status such as active,inactive,expired
	    and revoked. Displays in the output of the list command.

       refresh-token-issued-at
	    Specifies the refresh token issued timestamp. The format is "YYYY-
	    MM-DD HH:MM:SS". Displays in the output of the list command.

       refresh-token-expires-at
	    Specifies the refresh token expiry timestamp. The format is "YYYY-
	    MM-DD HH:MM:SS". Displays in the output of the list command.

       grant-type
	    Specifies the grant type; valid values are ropc, implicit and
	    auth-code. Displays in the output of the list command.

       user-agent
	    Specifies the user agent information for the token. Displays in
	    the output of the list command.

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 2016. All rights reserved.



BIG-IP				  2016-09-23	    apm oauth token-details(1)