API ReferenceManagementProjects
POST
/v1/mgmt/project/import

Import a project utilizing a management key.

This endpoint is used to import a project. The argument of files should be the output of the export project endpoint

You can also exclude items from the export when importing by utilizing the flags below within the exclude array.

The entire project:
  project

Project specific items:
  project.domain
  project.trustedDomains
  project.tokenResponseMethod
  project.selfProvisioning
  project.rotateJwt
  project.cookiepolicy
  project.refreshTokenExpiration
  project.stepupTokenExpiration
  project.sessionTokenExpiration
  project.keySessionTokenExpiration
  project.inviteUrl
  project.inviteEmail
  project.inviteSms
  project.inviteMagicLink
  project.conformanceJwt
  project.inactivity

Auth Methods, Flows, styles, etc:
  magicLink
  enchantedLink
  embeddedLink
  otp
  totp
  sso
  oauth
  webauthn
  password
  styles
  flows
  connectors
  authorization
  attributes
  ssoApps

You can also import secrets for connectors and OAuth Providers using the inputSecrets argument.

See Also

Endpoint Authentication

Use authorization bearer header with the following format:

Authorization: Bearer \<ProjectId:ManagementKey\>

Try it

/v1/mgmt/project/import

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

< Project ID >:< Management Key > as bearer

In: header

Request Body

filesobject

excludesarray<string>

inputSecretsobject

Status codeDescription
200OK
curl -X POST "https://api.descope.com/v1/mgmt/project/import" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <ProjectId:ManagementKey>" \
  -d '{
  "files": {},
  "excludes": [
    "string"
  ],
  "inputSecrets": {
    "connectors": [
      {
        "id": "string",
        "name": "string",
        "type": "string",
        "value": "string"
      }
    ],
    "oauthProviders": [
      {
        "id": "string",
        "name": "string",
        "type": "string",
        "value": "string"
      }
    ]
  }
}'
Was this helpful?

Previous

Export Project

Next

Clone Project