New-ADClaimType

Creates a new claim type in Active Directory.

Syntax

New-ADClaimType
   [-WhatIf]
   [-Confirm]
   [-AppliesToClasses <String[]>]
   [-AuthType <ADAuthType>]
   [-Credential <PSCredential>]
   [-Description <String>]
   [-DisplayName] <String>
   [-Enabled <Boolean>]
   [-ID <String>]
   [-Instance <ADClaimType>]
   [-IsSingleValued <Boolean>]
   [-OtherAttributes <Hashtable>]
   [-PassThru]
   [-ProtectedFromAccidentalDeletion <Boolean>]
   [-RestrictValues <Boolean>]
   [-Server <String>]
   -SourceAttribute <String>
   [-SuggestedValues <ADSuggestedValueEntry[]>]
   [<CommonParameters>]
New-ADClaimType
   [-WhatIf]
   [-Confirm]
   [-AppliesToClasses <String[]>]
   [-AuthType <ADAuthType>]
   [-Credential <PSCredential>]
   [-Description <String>]
   [-DisplayName] <String>
   [-Enabled <Boolean>]
   [-ID <String>]
   [-Instance <ADClaimType>]
   [-IsSingleValued <Boolean>]
   [-OtherAttributes <Hashtable>]
   [-PassThru]
   [-ProtectedFromAccidentalDeletion <Boolean>]
   [-RestrictValues <Boolean>]
   [-Server <String>]
   -SourceOID <String>
   [<CommonParameters>]
New-ADClaimType
   [-WhatIf]
   [-Confirm]
   [-AppliesToClasses <String[]>]
   [-AuthType <ADAuthType>]
   [-Credential <PSCredential>]
   [-Description <String>]
   [-DisplayName] <String>
   [-Enabled <Boolean>]
   [-ID <String>]
   [-Instance <ADClaimType>]
   [-IsSingleValued <Boolean>]
   [-OtherAttributes <Hashtable>]
   [-PassThru]
   [-ProtectedFromAccidentalDeletion <Boolean>]
   [-RestrictValues <Boolean>]
   [-Server <String>]
   [-SourceTransformPolicy]
   [-SuggestedValues <ADSuggestedValueEntry[]>]
   -ValueType <ADClaimValueType>
   [<CommonParameters>]

Description

The New-ADClaimType cmdlet creates a new claim type in Active Directory.

Examples

-------------------------- EXAMPLE 1 --------------------------

C:\PS>New-ADClaimType Title -SourceAttribute title

Description


Create a new user claim type with display name 'Title' that is sourced from the AD attribute 'title'.

-------------------------- EXAMPLE 2 --------------------------

C:\PS>$fullTime = New-Object Microsoft.ActiveDirectory.Management.ADSuggestedValueEntry("FTE", "Full-Time", "Full-time employee");
$intern = New-Object Microsoft.ActiveDirectory.Management.ADSuggestedValueEntry("Intern", "Intern", "Student employee");
$contractor = New-Object Microsoft.ActiveDirectory.Management.ADSuggestedValueEntry("Contractor", "Contractor", "Contract employee");
New-ADClaimType "Employee Type" -SourceAttribute employeeType -SuggestedValues $fullTime,$intern,$contractor

Description


Create a new user claim type with display name 'Employee Type' that is sourced from the AD attribute 'employeeType'. The suggested values are set to 'FTE', 'Intern', and 'Contractor'. Applications using this claim type would allow their users to specify one of the suggested values as this claim type's value.

-------------------------- EXAMPLE 3 --------------------------

C:\PS>New-ADClaimType "Bitlocker Enabled" -SourceOID "1.3.6.1.4.1.311.67.1.1" -Enabled $FALSE

Description


Create a new device claim type with display name 'Bitlocker Enabled' with the source OID '1.3.6.1.4.1.311.67.1.1'. The claim type set to disabled.

-------------------------- EXAMPLE 4 --------------------------

PS C:\>New-ADClaimType Title -SourceAttribute title -ID "ad://ext/title"

Description


Create a new user claim type with display name 'Title' that is sourced from the AD attribute 'title' and ID set to 'ad://ext/title'.

The ID should only be set manually in a multi-forest environment where the same claim type needs to work across forests. By default, New-ADClaimType generates the ID automatically. For claim types to be considered identical across forests, their ID must be the same.

-------------------------- EXAMPLE 5 --------------------------

PS C:\>New-ADClaimType SourceForest -SourceTransformPolicy -ValueType String

Create a new claim type with display name 'SourceForest' that is sourced from the claims transformation policy engine.

Required Parameters

-DisplayName

Specifies the display name of the claim type, which must be unique. The display name of a claim type can be used as an identity in other Active Directory cmdlets. For example, if the display name of a claim type is "Employee Type", then you can use 'Get-ADClaimType -Identity "Employee Type"' to retrieve the claim type.

Type:String
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-SourceAttribute

Specifies an Active Directory attribute from which this claim type is based, and from which the claim value is obtained. The input must be the distinguished name (DN), Name, or GUID of the attribute definition in the schema.

Acceptable values include attributes of the following schema class objects:

User, InetOrgPerson, Computer, ManagedServiceAccount, GroupManagedServiceAccount, and Auxiliary class objects

Except:

  • Attributes marked as defunct in the schema
  • Blocked attributes such as dBCSPwd, lmPwdHistory, and unicodePwd
  • Attributes that are not replicated
  • Attributes that are not available on read-only domain controllers
  • Attributes with syntaxes not based on the following
  • String Object (DS-DN)
  • String (Unicode)
  • Boolean
  • Integer
  • Large Integer
  • String (OID)
  • String (SD)
Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-SourceOID

Can be used to configure a certificate-based claim type source. For example, use this parameter to create certificate-based claim types when you want to use smartcard logon claims for authorization decisions. The SourceOID parameter uses the string representation of an object identifier (OID) from the issuance policy found in the certificate and on the certificate template when using Active Directory Certificate Services. An example of an OID is "1.3.6.1.4.1.311.47.2.5".

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-SourceTransformPolicy

Indicates that the claim type is sourced from the claims transformation policy engine.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ValueType

Specifies the value type for this claim type. Below is a list of the valid value types:

  • Int64

  • UInt64

  • String

  • FQBN

  • SID

  • Boolean

  • OctetString

Type:ADClaimValueType
Parameter Sets:Invalid, Int64, UInt64, String, FQBN, SID, Boolean, OctetString
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-AppliesToClasses

This parameter is used to specify the security principal classes to which this claim applies. Possible values for this parameter include the following (or any Active Directory type that derives from these base types):

  • User
  • Computer
  • InetOrgPerson
  • msDS-ManagedServiceAccount
  • msDS-GroupManagedServiceAccount
Type:String[]
Position:Named
Default value:Depending on SourceAttribute / SourceOID, the value is set to User / Computer respectively
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-AuthType

Specifies the authentication method to use. Possible values for this parameter include:

Negotiate or 0

Basic or 1

The default authentication method is Negotiate.

A Secure Sockets Layer (SSL) connection is required for the Basic authentication method.

The following example shows how to set this parameter to Basic.

-AuthType Basic

Type:ADAuthType
Parameter Sets:Negotiate, Basic
Position:Named
Default value:Microsoft.ActiveDirectory.Management.AuthType.Negotiate
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-Credential

Specifies the user account credentials to use to perform this task. The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. If the cmdlet is run from such a provider drive, the account associated with the drive is the default.

To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. If you specify a user name for this parameter, the cmdlet prompts for a password.

You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials.

$AdminCredentials = Get-Credential "Domain01\User01"

The following shows how to set the Credential parameter to these credentials.

-Credential $AdminCredentials

If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error.

Type:PSCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Description

Specifies a description of the object. This parameter sets the value of the Description property for the object. The LDAP Display Name (ldapDisplayName) for this property is "description".

The following example shows how to set this parameter to a sample description.

-Description "Description of the object"

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Enabled

Specifies if the claim type is enabled.

Type:Boolean
Position:Named
Default value:True
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ID

Specifies the claim type ID. This is an optional parameter. By default, New-ADClaimType generates the ID automatically.

The ID should only be set manually in a multi-forest environment where the same claim types need to work across forests. For claim types to be considered identical across forests, their ID must be the same.

To specify the ID, the ID string must conform to the following format:

  1. It must have a maximum of 37 characters.

  2. It must have at least one slash (/).

  3. It must have at least one colon before the first slash.

  4. It must not have the slash as the last character.

  5. It must contain valid file characters only.

An example is "ad://ext/BusinessImpact".

Type:String
Position:Named
Default value:Auto-generated
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Instance

Specifies an instance of an claim type object to use as a template for a new claim type object.

You can use an instance of an existing claim type object as a template or you can construct a new claim type object by using the Windows PowerShell command line or by using a script. The following examples show how to use these two methods to create a new claim type object.

Method 1: Use an existing claim type object as a template for a new object. To retrieve an instance of an existing claim type object, use a cmdlet such as Get-ADClaimType. Then provide this object to the Instance parameter of the New-ADClaimType cmdlet to create a new claim type object. You can override property values of the new object by setting the appropriate parameters.

$objectInstance = Get-ADClaimType -Identity "Employee Type"

New-ADClaimType -Name "Employee Type" -Instance $ObjectInstance

Method 2: Create a new claim type and set the property values by using the Windows PowerShell command line interface. Then pass this object to the Instance parameter of the New-ADClaimType cmdlet to create the new claim type object.

$objectInstance = new-object Microsoft.ActiveDirectory.Management.ADClaimType

$objectInstance.Description = "Employee Type can be full-time, intern or contractor."

New-ADClaimType -Name "Employee Type" -Instance $ObjectInstance

Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be set will raise an error.

Type:ADClaimType
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-IsSingleValued

Specifies whether the claim type is single valued or multi-valued.

Type:Boolean
Position:Named
Default value:True
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-OtherAttributes

Specifies object attribute values for attributes that are not represented by cmdlet parameters. You can set one or more parameters at the same time with this parameter. If an attribute takes more than one value, you can assign multiple values. To identify an attribute, specify the LDAPDisplayName (ldapDisplayName) defined for it in the Active Directory schema.

Syntax:

To specify a single value for an attribute:

-OtherAttributes @{'AttributeLDAPDisplayName'=value}

To specify multiple values for an attribute

-OtherAttributes @{'AttributeLDAPDisplayName'=value1,value2,...}

You can specify values for more than one attribute by using semicolons to separate attributes. The following syntax shows how to set values for multiple attributes:

-OtherAttributes @{'Attribute1LDAPDisplayName'=value; 'Attribute2LDAPDisplayName'=value1,value2;...}

The following examples show how to use this parameter.

To set the value of a custom attribute called favColors that takes a set of Unicode strings, use the following syntax:

-OtherAttributes @{'favColors'="pink","purple"}

To set values for favColors and dateOfBirth simultaneously, use the following syntax:

-OtherAttributes @{'favColors'="pink","purple"; 'dateOfBirth'=" 01/01/1960"}

Type:Hashtable
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PassThru

Returns the new or modified object. By default (i.e. if -PassThru is not specified), this cmdlet does not generate any output.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ProtectedFromAccidentalDeletion

Specifies whether to prevent the object from being deleted. When this property is set to true, you cannot delete the corresponding object without changing the value of the property. Possible values for this parameter include:

$false or 0

$true or 1

The following example shows how to set this parameter to true.

-ProtectedFromAccidentalDeletion $true

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-RestrictValues

This parameter is used to specify whether the claim type may have values outside of the SuggestedValues. If this is set to true, then the claim should only have values specified in the SuggestedValues.

Note that Active Directory does not enforce this restriction. It is up to the applications that use these claims to enforce the restriction.

Type:Boolean
Position:Named
Default value:True
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Server

Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance.

Domain name values:

Fully qualified domain name

Examples: corp.contoso.com

NetBIOS name

Example: CORP

Directory server values:

Fully qualified directory server name

Example: corp-DC12.corp.contoso.com

NetBIOS name

Example: corp-DC12

Fully qualified directory server name and port

Example: corp-DC12.corp.contoso.com:3268

The default value for the Server parameter is determined by one of the following methods in the order that they are listed:

-By using Server value from objects passed through the pipeline.

-By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive.

-By using the domain of the computer running Powershell.

The following example shows how to specify a full qualified domain name as the parameter value.

-Server "corp.contoso.com"

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SuggestedValues

Specifies one or more suggested values for the claim type. An application may choose to present this list of suggested values for the user to choose from. When the RestrictValues switch is set (to a value of True), the application should limit the user to selecting values from this list only.

Example:

$fullTime = New-Object Microsoft.ActiveDirectory.Management.ADSuggestedValueEntry("FTE", "Full-Time",

"Full-time employee");

$intern = New-Object Microsoft.ActiveDirectory.Management.ADSuggestedValueEntry("Intern", "Intern", "Student

employee");

$contractor = New-Object Microsoft.ActiveDirectory.Management.ADSuggestedValueEntry("Contractor", "Contractor",

"Contract employee");

New-ADClaimType "Employee Type" -SourceAttribute employeeType -SuggestedValues $fullTime,$intern,$contractor

Type:ADSuggestedValueEntry[]
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None or Microsoft.ActiveDirectory.Management.ADClaimType

Outputs

None or Microsoft.ActiveDirectory.Management.ADClaimType

Notes

  • This cmdlet does not work with an Active Directory Snapshot.

    This cmdlet does not work with a read-only domain controller.