apm saml attribute-consuming-service

apm saml attribute-consuming-service(1) 	  BIG-IP TMSH Manual	      apm saml attribute-consuming-service(1)

NAME
       attribute-consuming-service - Configure a list of SAML attribute consuming services.

MODULE
       apm saml

SYNTAX
       Configure the attribute-consuming-service component within the saml module using the syntax shown in the
       following sections.

   MODIFY
	create attribute-consuming-service [name]
	modify attribute-consuming-service [name]
	  options:
	    app-service [[string] | none]
	    attributes [add | delete | modify | none | replace-all-with] {
	       name [string] {
		   app-service [[string] | none]
		   attribute-name [string]
		   friendly-name [string]
		   is-required [bool]
		   name-format [string]
	       }
	    }
	    service-description [[string] | none]
	    service-name [[string] | none]

	edit attribute-consuming-service [ [ [name] | [glob] | [regex] ] ... ]
	  options:
	    all-properties
	    non-default-properties

   DISPLAY
	list attribute-consuming-service
	list attribute-consuming-service [ [ [name] | [glob] | [regex] ] ... ]
	show running-config attribute-consuming-service
	show running-config attribute-consuming-service [ [ [name] | [glob] | [regex] ] ... ]
	  options:
	    all-properties
	    app-service
	    non-default-properties
	    one-line
	    partition

   DELETE
	delete attribute-consuming-service [name]

DESCRIPTION
       You can use attribute-consuming-service to create and manage SAML attribute consuming services. Each attribute
       consuming service contains a list of SAML attributes. Each attribute consuming service must contain at least
       one attribute.

EXAMPLES
       create attribute-consuming-service my_attr_consuming_service attributes add { my_attr { attribute-name
       "urn:oid:1.3.6.1.4.1.5923.1.1.1.7" is-required false friendly-name eduPersonEntitlement name-format
       "urn:oasis:names:tc:SAML:2.0:attrname-format:uri"} } service-name "Academic Journals R US" service-description
       "Academic Journals R US"
	    Creates a new attribute consuming service named my_attr_consuming_service with one attribute named
	    my_attr.

       list attribute-consuming-service
	    Displays a list of attribute consuming services.

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.

       attributes
	    Specifies a list of attributes. attribute-name must be unique within an attribute-consuming-service
	    object. friendly-name is a more human-readable form of the attribute name for cases where attribute-name
	    is complex. is-required indicates if the service requires the attribute in order to function at all.
	    name-format is a URI reference representing the classification of the attribute name for purposes of
	    interpreting the name.

       service-description
	    Specifies a description for the attribute consuming service.

       service-name
	    Specifies a unique name for the attribute consuming service.

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

BIG-IP						      2017-05-18	      apm saml attribute-consuming-service(1)