New-ADClaimType

適用対象: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

New-ADClaimType

Creates a new claim type in Active Directory.

構文

Parameter Set: SourceAttribute
New-ADClaimType [-DisplayName] <String> -SourceAttribute <String> [-AppliesToClasses <String[]> ] [-AuthType <ADAuthType> {Negotiate | Basic} ] [-Credential <PSCredential> ] [-Description <String> ] [-Enabled <Boolean> ] [-ID <String> ] [-Instance <ADClaimType> ] [-IsSingleValued <Boolean> ] [-OtherAttributes <Hashtable> ] [-PassThru] [-ProtectedFromAccidentalDeletion <Boolean> ] [-RestrictValues <Boolean> ] [-Server <String> ] [-SuggestedValues <ADSuggestedValueEntry[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SourceOID
New-ADClaimType [-DisplayName] <String> -SourceOID <String> [-AppliesToClasses <String[]> ] [-AuthType <ADAuthType> {Negotiate | Basic} ] [-Credential <PSCredential> ] [-Description <String> ] [-Enabled <Boolean> ] [-ID <String> ] [-Instance <ADClaimType> ] [-IsSingleValued <Boolean> ] [-OtherAttributes <Hashtable> ] [-PassThru] [-ProtectedFromAccidentalDeletion <Boolean> ] [-RestrictValues <Boolean> ] [-Server <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SourceTransformPolicy
New-ADClaimType [-DisplayName] <String> -SourceTransformPolicy -ValueType <ADClaimValueType> {Invalid | Int64 | UInt64 | String | FQBN | SID | Boolean | OctetString} [-AppliesToClasses <String[]> ] [-AuthType <ADAuthType> {Negotiate | Basic} ] [-Credential <PSCredential> ] [-Description <String> ] [-Enabled <Boolean> ] [-ID <String> ] [-Instance <ADClaimType> ] [-IsSingleValued <Boolean> ] [-OtherAttributes <Hashtable> ] [-PassThru] [-ProtectedFromAccidentalDeletion <Boolean> ] [-RestrictValues <Boolean> ] [-Server <String> ] [-SuggestedValues <ADSuggestedValueEntry[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

詳細説明

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

パラメーター

-AppliesToClasses<String[]>

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

エイリアス

なし

必須?

false

位置は?

named

既定値

Depending on SourceAttribute / SourceOID, the value is set to User / Computer respectively

パイプライン入力を許可する

True (ByPropertyName)

ワイルドカード文字を許可する

false

-AuthType<ADAuthType>

Specifies the authentication method to use. このパラメーターに対して使用できる値:

-- 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.

エイリアス

なし

必須?

false

位置は?

named

既定値

Microsoft.ActiveDirectory.Management.AuthType.Negotiate

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-Credential<PSCredential>

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 module for Windows 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.

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

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-Description<String>

Specifies a description of the object. This parameter sets the value of the Description property for the object. The Lightweight Directory Access Protocol (LDAP) display name (ldapDisplayName) for this property is description.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

True (ByPropertyName)

ワイルドカード文字を許可する

false

-DisplayName<String>

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 the Get-ADClaimType cmdlet to retrieve the Employee Type claim type.

エイリアス

なし

必須?

true

位置は?

1

既定値

なし

パイプライン入力を許可する

True (ByPropertyName)

ワイルドカード文字を許可する

false

-Enabled<Boolean>

Specifies whether the claim type is enabled.

エイリアス

なし

必須?

false

位置は?

named

既定値

True

パイプライン入力を許可する

True (ByPropertyName)

ワイルドカード文字を許可する

false

-ID<String>

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:

-- The ID must have a maximum of 37 characters.
-- The ID must have at least one slash (/).
-- The ID must have at least one colon before the first slash.
-- The ID must not have the slash as the last character.
-- The ID must contain valid file characters only.

An example is ad://ext/BusinessImpact.

エイリアス

なし

必須?

false

位置は?

named

既定値

Auto-generated

パイプライン入力を許可する

True (ByPropertyName)

ワイルドカード文字を許可する

false

-Instance<ADClaimType>

Specifies an instance of a 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.

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.

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.

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

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-IsSingleValued<Boolean>

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

エイリアス

なし

必須?

false

位置は?

named

既定値

True

パイプライン入力を許可する

True (ByPropertyName)

ワイルドカード文字を許可する

false

-OtherAttributes<Hashtable>

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;...}

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-PassThru

作業中の項目を表すオブジェクトを返します。既定では、このコマンドレットによる出力はありません。

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-ProtectedFromAccidentalDeletion<Boolean>

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. このパラメーターに対して使用できる値:

-- $False or 0
-- $True or 1

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

True (ByPropertyName)

ワイルドカード文字を許可する

false

-RestrictValues<Boolean>

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

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

エイリアス

なし

必須?

false

位置は?

named

既定値

True

パイプライン入力を許可する

True (ByPropertyName)

ワイルドカード文字を許可する

false

-Server<String>

Specifies the Active Directory ドメイン サービス 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 ドメイン サービス or Active Directory snapshot instance.

Specify the Active Directory ドメイン サービス instance in one of the following ways:

Domain name values:

-- Fully qualified domain name
-- NetBIOS name

Directory server values:

-- Fully qualified directory server name
-- NetBIOS name
-- Fully qualified directory server name and port

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

-- By using the Server value from objects passed through the pipeline
-- By using the server information associated with the Active Directory ドメイン サービス Windows PowerShell provider drive, when the cmdlet runs in that drive
-- By using the domain of the computer running Windows PowerShell

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-SourceAttribute<String>

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, 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, except for the following attributes:

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)

エイリアス

なし

必須?

true

位置は?

named

既定値

なし

パイプライン入力を許可する

True (ByPropertyName)

ワイルドカード文字を許可する

false

-SourceOID<String>

Specifies a string that 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.

エイリアス

なし

必須?

true

位置は?

named

既定値

なし

パイプライン入力を許可する

True (ByPropertyName)

ワイルドカード文字を許可する

false

-SourceTransformPolicy

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

エイリアス

なし

必須?

true

位置は?

named

既定値

なし

パイプライン入力を許可する

True (ByPropertyName)

ワイルドカード文字を許可する

false

-SuggestedValues<ADSuggestedValueEntry[]>

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 parameter is set to a value of $True, the application should limit the user to selecting values from this list only.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

True (ByPropertyName)

ワイルドカード文字を許可する

false

-ValueType<ADClaimValueType>

Specifies the value type for this claim type. The following are the valid value types:

-- Int64
-- UInt64
-- String
-- FQBN
-- SID
-- Boolean
-- OctetString

エイリアス

なし

必須?

true

位置は?

named

既定値

なし

パイプライン入力を許可する

True (ByPropertyName)

ワイルドカード文字を許可する

false

-Confirm

コマンドレットを実行する前に、ユーザーに確認を求めます。

必須?

false

位置は?

named

既定値

false

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-WhatIf

コマンドレットを実行するとどのような結果になるかを表示します。コマンドレットは実行されません。

必須?

false

位置は?

named

既定値

false

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

<CommonParameters>

このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。

入力

入力型は、コマンドレットにパイプできるオブジェクトの型です。

  • None or Microsoft.ActiveDirectory.Management.ADClaimType

出力

出力型は、コマンドレットによって生成されるオブジェクトの型です。

  • None or Microsoft.ActiveDirectory.Management.ADClaimType

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

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

Example 1: Create a new user claim type with a display name

This command creates a new user claim type with display name Title that is sourced from the Active Directory attribute title.

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

Example 2: Create a new user claim type with a display name

This example creates a new user claim type with display name Employee Type that is sourced from the Active Directory 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.

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

Example 3: Create a new device claim type with a display name with the source destination

This command creates 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.

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

Example 4: Create a new user claim type with a display name that is sourced from an Active Directory attribute

This command creates a new user claim type with display name Title that is sourced from the Active Directory 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.

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

関連トピック

Get-ADClaimType

Remove-ADClaimType

Set-ADClaimType

AD DS Administration Cmdlets in Windows PowerShell