OpenAPI Specification
openapi: 3.0.0
info:
title: Secret Server Rest Activations Install API
description: REST API documentation for Secret Server. This document describes how to use the REST API. All requests require an authentication token; please see the <a href="../OAuth/">authentication document</a> for more information. The <a href="swagger.json">Swagger specification</a> for this API is also available.
termsOfService: https://delinea.com/eula
contact:
name: Support
url: https://delinea.com
version: 11.7.2
servers:
- url: /SecretServer/api
security:
- BearerToken: []
tags:
- name: Install
description: InstallController
paths:
/v1/install/initial-user-settings:
get:
tags:
- Install
summary: Get settings for the initial user
description: Will return initial user settings such as password requirements. Once the initial user is create this will not be available. Internal use.
operationId: InstallService_GetInitialUserSettings
responses:
'200':
description: Initial user create settings
content:
application/json:
schema:
$ref: '#/components/schemas/InitialUserSettingsModel'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'403':
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
deprecated: false
/v1/install/create-initial-user:
post:
tags:
- Install
summary: Create initial user
description: Create the initial user. Internal use.
operationId: InstallService_CreateInitialUser
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateInitialUserArgs'
description: args
responses:
'200':
description: Initial user create state
content:
application/json:
schema:
$ref: '#/components/schemas/CreateInitialUserResponseModel'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
'403':
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
deprecated: false
components:
schemas:
BadRequestResponse:
description: Response object for invalid requests
required:
- message
properties:
message:
description: Error message
type: string
messageDetail:
description: Error message detail
type: string
errorCode:
description: Error message code
type: string
modelState:
description: An object describing validation errors
type: object
type: object
CreateInitialUserResponseModel:
description: CreateInitialUserResponseModel
properties:
success:
description: Success
type: boolean
type: object
CreateInitialUserArgs:
description: CreateInitialUserArgs
properties:
data:
$ref: '#/components/schemas/CreateInitialUserData'
type: object
CreateInitialUserData:
description: Create initial user
properties:
displayName:
description: The full display name for the user
type: string
emailAddress:
description: A valid email address
type: string
password:
description: Password
type: string
userName:
description: The login username or user id used to login
type: string
type: object
InitialUserSettingsModel:
description: InitialUserSettingsModel
properties:
passwordMinLength:
description: PasswordMinLength
type: integer
format: int32
passwordRequireLowercase:
description: PasswordRequireLowercase
type: boolean
passwordRequireNumbers:
description: PasswordRequireNumbers
type: boolean
passwordRequireSymbols:
description: PasswordRequireSymbols
type: boolean
passwordRequireUppercase:
description: PasswordRequireUppercase
type: boolean
type: object
InternalServerErrorResponse:
description: Response object for internal server errors
required:
- message
- exceptionMessage
- exceptionType
- stackTrace
properties:
message:
description: Error message
type: string
exceptionMessage:
description: Error message from exception
type: string
exceptionType:
description: Exception type
type: string
stackTrace:
description: Exception stack trace
type: string
type: object
AuthenticationFailedResponse:
description: Response object for authentication failures
required:
- message
properties:
message:
description: Error message
type: string
type: object
securitySchemes:
BearerToken:
type: apiKey
description: 'Perform a POST request to `/oauth2/token`. It should include three form data parameters - `username`, `password`, and `grant_type`.The `grant_type` parameter should always have the value `password`.The access token returned should be included in the header of subsequent requests, like ''Authorization: Bearer <em>token</em>''. The token remains valid for a time period returned in the ''expires_in'' property (in seconds). For details, see the <a href="../OAuth/">token request documentation</a>.'
name: Authorization
in: header