--- title: "Setup new onboarding account." method: POST path: "/api/v1/onboard/setup-account" tags: ["Delegated RA"] --- # Setup new onboarding account. `POST /api/v1/onboard/setup-account` ## Request - Base URL: `https://one.digicert.com/documentmanager` - URL: `https://one.digicert.com/documentmanager/api/v1/onboard/setup-account` - Auth: API key in header `X-API-Key` - TypeScript: (a function with typed inputs; its response is checked against the schema) A partner can use the below API to create a sub-account for their clients. ## Request body - OnboardingAccountRequest - `account_name` string, required: The account name is a combination of a _
PREFIX= Defined by DigiCert and shared with partner. Prefix is one time and will remain the same for all accounts. - `locale` string, required: locale for the account. - `is_delegated` boolean, required: is_delegated will identify if the account is delegated or not. This will be always true. - `admin_user` object, required - `first_name` string, required: First name of account’s client admin. - `last_name` string, required: Last name of account’s client admin. - `email` string, required: Email address of the client admin of the account. This can be a person from partner who will manage all the enterprise accounts. - `user_name` string, required: Last name of account’s client admin. - `phone_number` string, required: Phone number of account’s client admin - `locale` string, required: Locale to be passed in AM to create client admin. - `id` string, required: ID of existing admin user. If we want to make the exisitng admin user of Digicert One as client admin we can pass this ID. - `service_user` object, required - `email` string, required: Email - required to create a service user in DTM. This is an APi user. Partner will use this isuer to call DTM APIs - `organization_details` OrganizationDetails, required - `id` string: Organization ID. - `name` string, required: Legal name of the organization. - `address` string, required: Address line 1 of the organization. - `address2` string, required: Address line 2 of the organization. - `zip` string: Postal code of the organization. - `city` string: City where the organization is located. - `state` string: State where the organization is located. - `country` string, required: Country where the organization is located. - `telephone` string: Organization telephone number. - `organization_contact` CcOrganizationContact, required: Organization’s contact - `first_name` string, required: Authorization representative’s first name - `last_name` string, required: Authorization representative’s last name - `email` string, required: Authorization representative’s email - `job_title` string, required: Authorization representative’s job title - `telephone` string, required: Authorization representative’s telephone - `authorized_representative` CcOrganizationContact[], required: List of authorized representative details - `first_name` string, required: Authorization representative’s first name - `last_name` string, required: Authorization representative’s last name - `email` string, required: Authorization representative’s email - `job_title` string, required: Authorization representative’s job title - `telephone` string, required: Authorization representative’s telephone - `organization_identifier` string: Organization Identifier only required for Partner vetted org. Note- If the certificate type is eseal, This parameter would become mandatory. - `sso_configuration` SsoConfigurationRequest - `authorization_endpoint` string: Authorization Endpoint from the OIDC providers - `token_endpoint` string: Authorisation Token Endpoint from the OIDC providers - `jwks_endpoint` string: Authorisation JWKS Endpoint from the OIDC providers - `client_id` string: Client ID provided by OIDC providers - `client_secret` string: Client Secret provided by OIDC providers - `token_audience` string: Token audience provided by OIDC providers - `token_issuer` string: Token Issuer URL provided by OIDC providers. ## Response `200` OK - OnboardingAccountResponse - `id` string: Organization ID. - `service_user` OnboardingAccountUserDetails - `api_key` string: This is SERVICE_USER_API_KEY to used to user in later API calls. - `id` string: Client admin user ID - `admin_user` OnboardingAccountUserDetails - `api_key` string: This is SERVICE_USER_API_KEY to used to user in later API calls. - `id` string: Client admin user ID - `products` string[]: List of products unique name which can be used to place orders - `account_id` string: DigiCert One Account ID - `organization` OnboardingOrganizationResponse - `id` integer: Organization ID. - `status` string: Organization status. (Possible values- active, inactive) - `display_name` string: Full name of the organization. - `name` string: Legal name of the organization. - `address` string: Address Line 1 of the organization. - `address2` string: Address Line 1 of the organization. - `zip` string: Postal code of the organization. - `city` string: City where the organization is located. - `state` string: State where the organization is located. - `country` string: Country where the organization is located. - `sso_configuration` SsoConfigurationResponse - `callback_url` string: Callback/Redirect URL to be used by OIDC providers - `login_initiation_endpoint` string: Endpoint to be configured in OIDC providers application to initiate login - `logout_endpoint` string: Endpoint to be configured in OIDC providers application to logout ## Other responses - `400`: Bad Request - `401`: Unauthorized - `500`: Internal Server Error --- [API](https://skmtc.dev/digicert/apis/digicert-content-trust-manager.md) - [All operations](https://skmtc.dev/digicert/apis/digicert-content-trust-manager/llms.txt) - [OpenAPI document](https://skmtc.dev/digicert/apis/digicert-content-trust-manager/revisions/8dec322a0e2b?raw)