ResidentKeyRequirement
    
    
      
    
    
      
      Stay organized with collections
    
    
      
      Save and categorize content based on your preferences.
    
  
  
      
    
  
  
  
  
  
    
  
  
    
    
  
  
  
  
  
    
      An enum that describes the Resident Key (Discoverable Credential) requirements.
      According to WebAuthn, this structure describes the Relying Party's requirements for
      client-side discoverable credentials (formerly known as resident credentials or resident
      keys):
      If the resident key requirement is set to "required", then the Relying Party requires a
      client-side discoverable credential and is prepared to receive an error if it can't be
      created. If the resident key requirement is set to "preferred", the Relying party strongly
      prefers a client-side discoverable credential but will accept a server-side credential. If
      the resident key requirement is set to "discouraged" then a server-side credential is
      preferable, but will accept a client-side discoverable credential.
      See Resident Key
      Requirement Enumeration
     
    
      
        
        
        
          Inherited Constant Summary
          
            From interface android.os.Parcelable
            
              
              
              
                
                  
                    | int | CONTENTS_FILE_DESCRIPTOR |  | 
                  
                    | int | PARCELABLE_WRITE_RETURN_VALUE |  | 
                
               
             
           
        
        
          Inherited Method Summary
          
            From class java.lang.Enum
            
           
          
            From class java.lang.Object
            
              
              
                
                  
                    | Object | 
                        clone()
                       | 
                  
                    | boolean |  | 
                  
                    | void | 
                        finalize()
                       | 
                  
                    | final Class<?> | 
                        getClass()
                       | 
                  
                    | int | 
                        hashCode()
                       | 
                  
                    | final void | 
                        notify()
                       | 
                  
                    | final void | 
                        notifyAll()
                       | 
                  
                    | String | 
                        toString()
                       | 
                  
                    | final void | 
                        wait(long arg0, int arg1)
                       | 
                  
                    | final void | 
                        wait(long arg0)
                       | 
                  
                    | final void | 
                        wait()
                       | 
                
               
             
           
          
            From interface java.lang.constant.Constable
            
              
              
                
                  
                    | abstract Optional<? extends ConstantDesc> | 
                        describeConstable()
                       | 
                
               
             
           
          
            From interface java.lang.Comparable
            
           
          
            From interface android.os.Parcelable
            
              
              
              
                
                  
                    | abstract int | 
                        describeContents()
                       | 
                  
                    | abstract void | 
                        writeToParcel(Parcel  arg0,
                        int arg1)
                       | 
                
               
             
           
        
      
     
    
    
    
    
    
      Enum Values
      
        public static final
        ResidentKeyRequirement RESIDENT_KEY_DISCOURAGED
        
        
       
      
        public static final
        ResidentKeyRequirement RESIDENT_KEY_PREFERRED
        
        
       
      
        public static final
        ResidentKeyRequirement RESIDENT_KEY_REQUIRED
        
        
       
    
    
    
    
    
    
    
    
    
    
   
  
  
 
  
    
    
      
       
    
    
  
  
  Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
  Last updated 2024-10-31 UTC.
  
  
  
    
      [null,null,["Last updated 2024-10-31 UTC."],[],["`ResidentKeyRequirement` is an enum defining preferences for client-side discoverable credentials.  It has three possible values: `RESIDENT_KEY_REQUIRED`, meaning a client-side credential is required; `RESIDENT_KEY_PREFERRED`, where a client-side credential is strongly preferred but a server-side one is acceptable; and `RESIDENT_KEY_DISCOURAGED`, indicating server-side credentials are preferred, but client-side credentials are still accepted. It implements `Parcelable` and includes a nested exception `UnsupportedResidentKeyRequirementException`. An exception will be thrown when an unsupported requirement is encountered.\n"]]