SUMMARY: NESTED | FIELD | | METHOD
DETAIL: FIELD | METHOD

Class CIM_RemoteIdentity

Used in features: Simple Identity , Role Based
Compatible with the following Intel AMT Releases: 3.2, 4.0, 5.0, 5.1, 6.0, 6.1, 6.2, 7.0, 8.0, 8.1, 9.0, 9.5, 10.0, 11.0 
CIM_ManagedElement
   extended by CIM_Identity
      extended by CIM_RemoteIdentity


class CIM_RemoteIdentity
 extends CIM_Identity


General Information:
An instance of RemoteIdentity is an Identity 
that should be used to provide a persistent representation of a security 
principal for which authoritative information required for mapping to users or 
groups is not otherwise modeled.

Product Specific Usage:
For 
every kerberos user in the system there is an instance of this class. 
There 
are matching instances of CIM_Role and CIM_Privilege (a 1:1:1 structure). 

CIM_RemoteIdentity and CIM_Role are associated by both 
CIM_MemberOfCollection and CIM_ConcreteDependency, and CIM_Role and 
CIM_Privilege by CIM_MemberOfCollection. 



Qualifiers:
-------------
Experimental
Version=2.16.0
UMLPackagePath=CIM::User::Identity









  
  

    Supported Fields 
      Summary

  

     string 
      
    InstanceID Key  
Within the scope of the instantiating Namespace, 
      InstanceID opaquely and uniquely identifies an instance of this class . . 
      .

  

     string 
      
    ElementName 
A 
      user-friendly name for the object . . .

  

     uint8[] 
      
    Name 
Name is an octet 
      string representing an identifier that can be correlated to the 
      authoritative information . . .

  

     uint16 
      
    NameFormat 
An 
      enumeration defining the type and format of Name. * GID: A Unix Group ID, 
      an integer encoded as an octet string . . 
.




  
  

    Methods Summary

  

     
    Create(Instance, 
      ResourceCreated) 
Creates a new instance of this class

  

     
    Get(Instance) 
Gets the 
      representation of the instance

  

     
    Delete() 
Deletes an 
      instance

  

     
    Pull(EnumerationContext, 
      MaxElements) 
Pulls instances of this class, following an 
      Enumerate operation

  

     
    Enumerate() 
      
Enumerates the instances of this class

  

     
    Release(EnumerationContext) 
      
Releases an enumeration context




  
  

    Field 
Detail


InstanceID Key 
public string InstanceID



  
General Information:
Within the scope of the instantiating 
  Namespace, InstanceID opaquely and uniquely identifies an instance of this 
  class. In order to ensure uniqueness within the NameSpace, the value of 
  InstanceID SHOULD be constructed using the following 'preferred' algorithm: 
  
<OrgID>:<LocalID> 
Where <OrgID> and <LocalID> 
  are separated by a colon ':', and where <OrgID> MUST include a 
  copyrighted, trademarked or otherwise unique name that is owned by the 
  business entity creating/defining the InstanceID, or is a registered ID that 
  is assigned to the business entity by a recognized global authority. (This is 
  similar to the <Schema Name>_<Class Name> structure of Schema 
  class names.) In addition, to ensure uniqueness <OrgID> MUST NOT contain 
  a colon (':'). When using this algorithm, the first colon to appear in 
  InstanceID MUST appear between <OrgID> and <LocalID>. 
  
<LocalID> is chosen by the business entity and SHOULD not be re-used 
  to identify different underlying (real-world) elements. If the above 
  'preferred' algorithm is not used, the defining entity MUST assure that the 
  resultant InstanceID is not re-used across any InstanceIDs produced by this or 
  other providers for this instance's NameSpace. 
For DMTF defined instances, 
  the 'preferred' algorithm MUST be used with the <OrgID> set to 
  'CIM'.

Product Specific Usage:
In Intel AMT Release 6.0 and 
  later releases value is 'Intel(r) AMT:RemoteID <userID>' 
  


Qualifiers:
-------------
Key
Override=InstanceID
MaxLen=64


  

  





ElementName 
public string ElementName



  
General Information:
A user-friendly name for the object. This 
  property allows each instance to define a user-friendly name in addition to 
  its key properties, identity data, and description information. 
Note that 
  the Name property of ManagedSystemElement is also defined as a user-friendly 
  name. But, it is often subclassed to be a Key. It is not reasonable that the 
  same property can convey both identity and a user-friendly name, without 
  inconsistencies. Where Name exists and is not a Key (such as for instances of 
  LogicalDevice), the same information can be present in both the Name and 
  ElementName properties. Note that if there is an associated instance of 
  CIM_EnabledLogicalElementCapabilities, restrictions on this properties may 
  exist as defined in ElementNameMask and MaxElementNameLen properties defined 
  in that class.

Product Specific Usage:
In Intel AMT Release 
  6.0 and later releases value is "Intel(r) AMT Kerberos Security 
  Principal"

Qualifiers:
-------------
MaxLen=44


  

  





Name 
public uint8[] Name



  
General Information:
Name is an octet string representing an 
  identifier that can be correlated to the authoritative information. The type 
  and format are defined by the NameFormat and OtherNameFormat 
  properties.

Product Specific Usage:
The SID of the kerberos 
  user

Qualifiers:
-------------
OctetString
ModelCorrespondence={CIM_RemoteIdentity.NameFormat}
MaxLen=48


  

  





NameFormat 
public uint16 NameFormat



  
General Information:
An enumeration defining the type and format 
  of Name.
* GID: A Unix Group ID, an integer encoded as an octet string. For 
  example, the decimal value 25 results in the octetstring 0x0000000519.
* 
  UID: A Unix User ID, an integer encoded as an octet string. For example, the 
  decimal value 100 results in the octetstring 0x0000000564.
* SID: A Windows 
  Security ID in its native binary format
* DN: An ASN.1-encoded LDAP 
  Distinguished Name
* KID: A Kerberos Remote Identifier, a string encoded as 
  an octet string.

Product Specific Usage:
In Intel AMT Release 
  6.0 and later releases value is "SID" 
  (4)

Qualifiers:
-------------
Values={Other, GID, UID, 
  SID, DN , KID, DMTF Reserved}
ValueMap={1, 2, 3, 4, 5, 6, 
  ..}
ModelCorrespondence={CIM_RemoteIdentity.Name, 
  CIM_RemoteIdentity.OtherNameFormat}


  

  






  
  

    Method 
Detail


Create
public  Create([IN]CIM_RemoteIdentity Instance, [OUT] REF CIM_RemoteIdentity ResourceCreated)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_ADMINISTRATION_REALM

General 
  Information:
Creates a new instance of this class

Product 
  Specific Usage:
The following properties must be included in any 
  representation of CIM_RemoteIdentity: 

InstanceID 

'Name' 
  parameter must be the SID of the kerberos user. 
'NameFormat' parameter 
  must be 'SID' (4). 
All other input parameters are ignored. 
  







Get
public  Get([OUT]CIM_RemoteIdentity Instance)



  
Permission Information:
This method is accessible from any 
  realm

General Information:
Gets the representation of the 
  instance

Product Specific Usage:
Only system with 
  ADMIN_SECURITY_ADMINISTRATION_REALM or the user of this CIM_RemoteIdentity can 
  see the CIM_RemoteIdentity instance. Otherwise - the access is 
denied.





Delete
public  Delete()



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_ADMINISTRATION_REALM

General 
  Information:
Deletes an instance

Product Specific 
  Usage:
Additional Notes: 
1) 'Delete' in Intel AMT Release 6.0 and 
  later releases is permitted only to 
  'ADMIN_SECURITY_ADMINISTRATION_REALM'.





Pull
public  Pull([IN]String EnumerationContext, [IN]String MaxElements)



  
Permission Information:
All users permitted to use method, only 
  instances to whom the user has permissions will be returned

General 
  Information:
Pulls instances of this class, following an Enumerate 
  operation





Enumerate
public  Enumerate()



  
Permission Information:
All users permitted to use 
  method

General Information:
Enumerates the instances of this 
  class





Release
public  Release([IN]String EnumerationContext)



  
Permission Information:
All users permitted to use 
  method

General Information:
Releases an enumeration 
  context






  
  

    SUMMARY: NESTED | FIELD | METHOD
  

  

    DETAIL: FIELD | METHOD



  
  

    
      
Copyright © 2006-2022, Intel 
      Corporation. All rights 
reserved.