published on Sunday, Oct 11, 2026 by Descope
published on Sunday, Oct 11, 2026 by Descope
Manages the project-level session migration settings for migrating user sessions from another vendor. This is a singleton resource, and its id is always the project ID.
Create SessionMigration Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SessionMigration(name: string, args: SessionMigrationArgs, opts?: CustomResourceOptions);@overload
def SessionMigration(resource_name: str,
args: SessionMigrationArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SessionMigration(resource_name: str,
opts: Optional[ResourceOptions] = None,
project_id: Optional[str] = None,
api_token: Optional[str] = None,
audience: Optional[str] = None,
client_id: Optional[str] = None,
domain: Optional[str] = None,
issuer: Optional[str] = None,
loginid_matched_attributes: Optional[Sequence[str]] = None,
user_mappings: Optional[Sequence[SessionMigrationUserMappingArgs]] = None,
user_sync_type: Optional[str] = None,
vendor: Optional[str] = None)func NewSessionMigration(ctx *Context, name string, args SessionMigrationArgs, opts ...ResourceOption) (*SessionMigration, error)public SessionMigration(string name, SessionMigrationArgs args, CustomResourceOptions? opts = null)
public SessionMigration(String name, SessionMigrationArgs args)
public SessionMigration(String name, SessionMigrationArgs args, CustomResourceOptions options)
type: descope:SessionMigration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "descope_session_migration" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args SessionMigrationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args SessionMigrationArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args SessionMigrationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SessionMigrationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SessionMigrationArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var sessionMigrationResource = new Descope.SessionMigration("sessionMigrationResource", new()
{
ProjectId = "string",
ApiToken = "string",
Audience = "string",
ClientId = "string",
Domain = "string",
Issuer = "string",
LoginidMatchedAttributes = new[]
{
"string",
},
UserMappings = new[]
{
new Descope.Inputs.SessionMigrationUserMappingArgs
{
DescopeKey = "string",
ExternalKey = "string",
},
},
UserSyncType = "string",
Vendor = "string",
});
example, err := descope.NewSessionMigration(ctx, "sessionMigrationResource", &descope.SessionMigrationArgs{
ProjectId: pulumi.String("string"),
ApiToken: pulumi.String("string"),
Audience: pulumi.String("string"),
ClientId: pulumi.String("string"),
Domain: pulumi.String("string"),
Issuer: pulumi.String("string"),
LoginidMatchedAttributes: pulumi.StringArray{
pulumi.String("string"),
},
UserMappings: descope.SessionMigrationUserMappingArray{
&descope.SessionMigrationUserMappingArgs{
DescopeKey: pulumi.String("string"),
ExternalKey: pulumi.String("string"),
},
},
UserSyncType: pulumi.String("string"),
Vendor: pulumi.String("string"),
})
resource "descope_session_migration" "sessionMigrationResource" {
lifecycle {
create_before_destroy = true
}
project_id = "string"
api_token = "string"
audience = "string"
client_id = "string"
domain = "string"
issuer = "string"
loginid_matched_attributes = ["string"]
user_mappings {
descope_key = "string"
external_key = "string"
}
user_sync_type = "string"
vendor = "string"
}
var sessionMigrationResource = new SessionMigration("sessionMigrationResource", SessionMigrationArgs.builder()
.projectId("string")
.apiToken("string")
.audience("string")
.clientId("string")
.domain("string")
.issuer("string")
.loginidMatchedAttributes("string")
.userMappings(SessionMigrationUserMappingArgs.builder()
.descopeKey("string")
.externalKey("string")
.build())
.userSyncType("string")
.vendor("string")
.build());
session_migration_resource = descope.SessionMigration("sessionMigrationResource",
project_id="string",
api_token="string",
audience="string",
client_id="string",
domain="string",
issuer="string",
loginid_matched_attributes=["string"],
user_mappings=[{
"descope_key": "string",
"external_key": "string",
}],
user_sync_type="string",
vendor="string")
const sessionMigrationResource = new descope.SessionMigration("sessionMigrationResource", {
projectId: "string",
apiToken: "string",
audience: "string",
clientId: "string",
domain: "string",
issuer: "string",
loginidMatchedAttributes: ["string"],
userMappings: [{
descopeKey: "string",
externalKey: "string",
}],
userSyncType: "string",
vendor: "string",
});
type: descope:SessionMigration
properties:
apiToken: string
audience: string
clientId: string
domain: string
issuer: string
loginidMatchedAttributes:
- string
projectId: string
userMappings:
- descopeKey: string
externalKey: string
userSyncType: string
vendor: string
SessionMigration Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The SessionMigration resource accepts the following input properties:
- Project
Id string - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- Api
Token string - The API token for the vendor's management API. Only used with the
oktavendor. This value is write-only and never read back from the server. - Audience string
- An optional audience value from the vendor's authentication configuration. Only used with the
auth0vendor. - Client
Id string - The client ID from the vendor's authentication configuration.
- Domain string
- The domain from the vendor's authentication configuration. Only used with the
auth0vendor. - Issuer string
- The issuer from the vendor's authentication configuration. Only used with the
oktavendor. - Loginid
Matched List<string>Attributes - Which attributes from the vendor's user should be used to match the Descope user's login ID (e.g.
email). - User
Mappings List<Descope.Session Migration User Mapping> - A list of attribute mappings from the external vendor's user to Descope user attributes.
- User
Sync stringType - The type of user synchronization to perform, either
matchOnlyto only match existing users orjitfor just-in-time provisioning. - Vendor string
- The vendor to migrate user sessions from, either
auth0orokta. Session migration is disabled when this isn't set.
- Project
Id string - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- Api
Token string - The API token for the vendor's management API. Only used with the
oktavendor. This value is write-only and never read back from the server. - Audience string
- An optional audience value from the vendor's authentication configuration. Only used with the
auth0vendor. - Client
Id string - The client ID from the vendor's authentication configuration.
- Domain string
- The domain from the vendor's authentication configuration. Only used with the
auth0vendor. - Issuer string
- The issuer from the vendor's authentication configuration. Only used with the
oktavendor. - Loginid
Matched []stringAttributes - Which attributes from the vendor's user should be used to match the Descope user's login ID (e.g.
email). - User
Mappings []SessionMigration User Mapping Args - A list of attribute mappings from the external vendor's user to Descope user attributes.
- User
Sync stringType - The type of user synchronization to perform, either
matchOnlyto only match existing users orjitfor just-in-time provisioning. - Vendor string
- The vendor to migrate user sessions from, either
auth0orokta. Session migration is disabled when this isn't set.
- project_
id string - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- api_
token string - The API token for the vendor's management API. Only used with the
oktavendor. This value is write-only and never read back from the server. - audience string
- An optional audience value from the vendor's authentication configuration. Only used with the
auth0vendor. - client_
id string - The client ID from the vendor's authentication configuration.
- domain string
- The domain from the vendor's authentication configuration. Only used with the
auth0vendor. - issuer string
- The issuer from the vendor's authentication configuration. Only used with the
oktavendor. - loginid_
matched_ list(string)attributes - Which attributes from the vendor's user should be used to match the Descope user's login ID (e.g.
email). - user_
mappings list(object) - A list of attribute mappings from the external vendor's user to Descope user attributes.
- user_
sync_ stringtype - The type of user synchronization to perform, either
matchOnlyto only match existing users orjitfor just-in-time provisioning. - vendor string
- The vendor to migrate user sessions from, either
auth0orokta. Session migration is disabled when this isn't set.
- project
Id String - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- api
Token String - The API token for the vendor's management API. Only used with the
oktavendor. This value is write-only and never read back from the server. - audience String
- An optional audience value from the vendor's authentication configuration. Only used with the
auth0vendor. - client
Id String - The client ID from the vendor's authentication configuration.
- domain String
- The domain from the vendor's authentication configuration. Only used with the
auth0vendor. - issuer String
- The issuer from the vendor's authentication configuration. Only used with the
oktavendor. - loginid
Matched List<String>Attributes - Which attributes from the vendor's user should be used to match the Descope user's login ID (e.g.
email). - user
Mappings List<SessionMigration User Mapping> - A list of attribute mappings from the external vendor's user to Descope user attributes.
- user
Sync StringType - The type of user synchronization to perform, either
matchOnlyto only match existing users orjitfor just-in-time provisioning. - vendor String
- The vendor to migrate user sessions from, either
auth0orokta. Session migration is disabled when this isn't set.
- project
Id string - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- api
Token string - The API token for the vendor's management API. Only used with the
oktavendor. This value is write-only and never read back from the server. - audience string
- An optional audience value from the vendor's authentication configuration. Only used with the
auth0vendor. - client
Id string - The client ID from the vendor's authentication configuration.
- domain string
- The domain from the vendor's authentication configuration. Only used with the
auth0vendor. - issuer string
- The issuer from the vendor's authentication configuration. Only used with the
oktavendor. - loginid
Matched string[]Attributes - Which attributes from the vendor's user should be used to match the Descope user's login ID (e.g.
email). - user
Mappings SessionMigration User Mapping[] - A list of attribute mappings from the external vendor's user to Descope user attributes.
- user
Sync stringType - The type of user synchronization to perform, either
matchOnlyto only match existing users orjitfor just-in-time provisioning. - vendor string
- The vendor to migrate user sessions from, either
auth0orokta. Session migration is disabled when this isn't set.
- project_
id str - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- api_
token str - The API token for the vendor's management API. Only used with the
oktavendor. This value is write-only and never read back from the server. - audience str
- An optional audience value from the vendor's authentication configuration. Only used with the
auth0vendor. - client_
id str - The client ID from the vendor's authentication configuration.
- domain str
- The domain from the vendor's authentication configuration. Only used with the
auth0vendor. - issuer str
- The issuer from the vendor's authentication configuration. Only used with the
oktavendor. - loginid_
matched_ Sequence[str]attributes - Which attributes from the vendor's user should be used to match the Descope user's login ID (e.g.
email). - user_
mappings Sequence[SessionMigration User Mapping Args] - A list of attribute mappings from the external vendor's user to Descope user attributes.
- user_
sync_ strtype - The type of user synchronization to perform, either
matchOnlyto only match existing users orjitfor just-in-time provisioning. - vendor str
- The vendor to migrate user sessions from, either
auth0orokta. Session migration is disabled when this isn't set.
- project
Id String - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- api
Token String - The API token for the vendor's management API. Only used with the
oktavendor. This value is write-only and never read back from the server. - audience String
- An optional audience value from the vendor's authentication configuration. Only used with the
auth0vendor. - client
Id String - The client ID from the vendor's authentication configuration.
- domain String
- The domain from the vendor's authentication configuration. Only used with the
auth0vendor. - issuer String
- The issuer from the vendor's authentication configuration. Only used with the
oktavendor. - loginid
Matched List<String>Attributes - Which attributes from the vendor's user should be used to match the Descope user's login ID (e.g.
email). - user
Mappings List<Property Map> - A list of attribute mappings from the external vendor's user to Descope user attributes.
- user
Sync StringType - The type of user synchronization to perform, either
matchOnlyto only match existing users orjitfor just-in-time provisioning. - vendor String
- The vendor to migrate user sessions from, either
auth0orokta. Session migration is disabled when this isn't set.
Outputs
All input properties are implicitly available as output properties. Additionally, the SessionMigration resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing SessionMigration Resource
Get an existing SessionMigration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: SessionMigrationState, opts?: CustomResourceOptions): SessionMigration@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
api_token: Optional[str] = None,
audience: Optional[str] = None,
client_id: Optional[str] = None,
domain: Optional[str] = None,
issuer: Optional[str] = None,
loginid_matched_attributes: Optional[Sequence[str]] = None,
project_id: Optional[str] = None,
user_mappings: Optional[Sequence[SessionMigrationUserMappingArgs]] = None,
user_sync_type: Optional[str] = None,
vendor: Optional[str] = None) -> SessionMigrationfunc GetSessionMigration(ctx *Context, name string, id IDInput, state *SessionMigrationState, opts ...ResourceOption) (*SessionMigration, error)public static SessionMigration Get(string name, Input<string> id, SessionMigrationState? state, CustomResourceOptions? opts = null)public static SessionMigration get(String name, Output<String> id, SessionMigrationState state, CustomResourceOptions options)resources: existingSessionMigration: type: descope:SessionMigration get: id: ${id}import {
to = descope_session_migration.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- state SessionMigrationState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state SessionMigrationState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- state SessionMigrationState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- state SessionMigrationState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
- Api
Token string - The API token for the vendor's management API. Only used with the
oktavendor. This value is write-only and never read back from the server. - Audience string
- An optional audience value from the vendor's authentication configuration. Only used with the
auth0vendor. - Client
Id string - The client ID from the vendor's authentication configuration.
- Domain string
- The domain from the vendor's authentication configuration. Only used with the
auth0vendor. - Issuer string
- The issuer from the vendor's authentication configuration. Only used with the
oktavendor. - Loginid
Matched List<string>Attributes - Which attributes from the vendor's user should be used to match the Descope user's login ID (e.g.
email). - Project
Id string - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- User
Mappings List<Descope.Session Migration User Mapping> - A list of attribute mappings from the external vendor's user to Descope user attributes.
- User
Sync stringType - The type of user synchronization to perform, either
matchOnlyto only match existing users orjitfor just-in-time provisioning. - Vendor string
- The vendor to migrate user sessions from, either
auth0orokta. Session migration is disabled when this isn't set.
- Api
Token string - The API token for the vendor's management API. Only used with the
oktavendor. This value is write-only and never read back from the server. - Audience string
- An optional audience value from the vendor's authentication configuration. Only used with the
auth0vendor. - Client
Id string - The client ID from the vendor's authentication configuration.
- Domain string
- The domain from the vendor's authentication configuration. Only used with the
auth0vendor. - Issuer string
- The issuer from the vendor's authentication configuration. Only used with the
oktavendor. - Loginid
Matched []stringAttributes - Which attributes from the vendor's user should be used to match the Descope user's login ID (e.g.
email). - Project
Id string - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- User
Mappings []SessionMigration User Mapping Args - A list of attribute mappings from the external vendor's user to Descope user attributes.
- User
Sync stringType - The type of user synchronization to perform, either
matchOnlyto only match existing users orjitfor just-in-time provisioning. - Vendor string
- The vendor to migrate user sessions from, either
auth0orokta. Session migration is disabled when this isn't set.
- api_
token string - The API token for the vendor's management API. Only used with the
oktavendor. This value is write-only and never read back from the server. - audience string
- An optional audience value from the vendor's authentication configuration. Only used with the
auth0vendor. - client_
id string - The client ID from the vendor's authentication configuration.
- domain string
- The domain from the vendor's authentication configuration. Only used with the
auth0vendor. - issuer string
- The issuer from the vendor's authentication configuration. Only used with the
oktavendor. - loginid_
matched_ list(string)attributes - Which attributes from the vendor's user should be used to match the Descope user's login ID (e.g.
email). - project_
id string - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- user_
mappings list(object) - A list of attribute mappings from the external vendor's user to Descope user attributes.
- user_
sync_ stringtype - The type of user synchronization to perform, either
matchOnlyto only match existing users orjitfor just-in-time provisioning. - vendor string
- The vendor to migrate user sessions from, either
auth0orokta. Session migration is disabled when this isn't set.
- api
Token String - The API token for the vendor's management API. Only used with the
oktavendor. This value is write-only and never read back from the server. - audience String
- An optional audience value from the vendor's authentication configuration. Only used with the
auth0vendor. - client
Id String - The client ID from the vendor's authentication configuration.
- domain String
- The domain from the vendor's authentication configuration. Only used with the
auth0vendor. - issuer String
- The issuer from the vendor's authentication configuration. Only used with the
oktavendor. - loginid
Matched List<String>Attributes - Which attributes from the vendor's user should be used to match the Descope user's login ID (e.g.
email). - project
Id String - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- user
Mappings List<SessionMigration User Mapping> - A list of attribute mappings from the external vendor's user to Descope user attributes.
- user
Sync StringType - The type of user synchronization to perform, either
matchOnlyto only match existing users orjitfor just-in-time provisioning. - vendor String
- The vendor to migrate user sessions from, either
auth0orokta. Session migration is disabled when this isn't set.
- api
Token string - The API token for the vendor's management API. Only used with the
oktavendor. This value is write-only and never read back from the server. - audience string
- An optional audience value from the vendor's authentication configuration. Only used with the
auth0vendor. - client
Id string - The client ID from the vendor's authentication configuration.
- domain string
- The domain from the vendor's authentication configuration. Only used with the
auth0vendor. - issuer string
- The issuer from the vendor's authentication configuration. Only used with the
oktavendor. - loginid
Matched string[]Attributes - Which attributes from the vendor's user should be used to match the Descope user's login ID (e.g.
email). - project
Id string - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- user
Mappings SessionMigration User Mapping[] - A list of attribute mappings from the external vendor's user to Descope user attributes.
- user
Sync stringType - The type of user synchronization to perform, either
matchOnlyto only match existing users orjitfor just-in-time provisioning. - vendor string
- The vendor to migrate user sessions from, either
auth0orokta. Session migration is disabled when this isn't set.
- api_
token str - The API token for the vendor's management API. Only used with the
oktavendor. This value is write-only and never read back from the server. - audience str
- An optional audience value from the vendor's authentication configuration. Only used with the
auth0vendor. - client_
id str - The client ID from the vendor's authentication configuration.
- domain str
- The domain from the vendor's authentication configuration. Only used with the
auth0vendor. - issuer str
- The issuer from the vendor's authentication configuration. Only used with the
oktavendor. - loginid_
matched_ Sequence[str]attributes - Which attributes from the vendor's user should be used to match the Descope user's login ID (e.g.
email). - project_
id str - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- user_
mappings Sequence[SessionMigration User Mapping Args] - A list of attribute mappings from the external vendor's user to Descope user attributes.
- user_
sync_ strtype - The type of user synchronization to perform, either
matchOnlyto only match existing users orjitfor just-in-time provisioning. - vendor str
- The vendor to migrate user sessions from, either
auth0orokta. Session migration is disabled when this isn't set.
- api
Token String - The API token for the vendor's management API. Only used with the
oktavendor. This value is write-only and never read back from the server. - audience String
- An optional audience value from the vendor's authentication configuration. Only used with the
auth0vendor. - client
Id String - The client ID from the vendor's authentication configuration.
- domain String
- The domain from the vendor's authentication configuration. Only used with the
auth0vendor. - issuer String
- The issuer from the vendor's authentication configuration. Only used with the
oktavendor. - loginid
Matched List<String>Attributes - Which attributes from the vendor's user should be used to match the Descope user's login ID (e.g.
email). - project
Id String - The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
- user
Mappings List<Property Map> - A list of attribute mappings from the external vendor's user to Descope user attributes.
- user
Sync StringType - The type of user synchronization to perform, either
matchOnlyto only match existing users orjitfor just-in-time provisioning. - vendor String
- The vendor to migrate user sessions from, either
auth0orokta. Session migration is disabled when this isn't set.
Supporting Types
SessionMigrationUserMapping, SessionMigrationUserMappingArgs
- Descope
Key string - The Descope user attribute to map the external key to.
- External
Key string - The attribute key in the external vendor's user object.
- Descope
Key string - The Descope user attribute to map the external key to.
- External
Key string - The attribute key in the external vendor's user object.
- descope_
key string - The Descope user attribute to map the external key to.
- external_
key string - The attribute key in the external vendor's user object.
- descope
Key String - The Descope user attribute to map the external key to.
- external
Key String - The attribute key in the external vendor's user object.
- descope
Key string - The Descope user attribute to map the external key to.
- external
Key string - The attribute key in the external vendor's user object.
- descope_
key str - The Descope user attribute to map the external key to.
- external_
key str - The attribute key in the external vendor's user object.
- descope
Key String - The Descope user attribute to map the external key to.
- external
Key String - The attribute key in the external vendor's user object.
Package Details
- Repository
- descope descope/pulumi-descope
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
descopeTerraform Provider.
published on Sunday, Oct 11, 2026 by Descope