Delinea CharacterSets API
Character Sets used in password requirements
OpenAPI Specification
openapi: 3.0.0
info:
title: Secret Server Rest Activations CharacterSets 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: CharacterSets
description: Character Sets used in password requirements
paths:
/v1/character-sets:
get:
tags:
- CharacterSets
summary: Search Character Sets
description: Search, filter, sort, and page character sets
operationId: CharacterSetsService_SearchCharacterSets
parameters:
- name: filter.status
in: query
description: Status
required: false
schema:
type: string
- name: skip
in: query
description: Number of records to skip before taking results
required: false
schema:
type: integer
format: int32
- name: sortBy[0].direction
in: query
description: Sort direction
required: false
schema:
type: string
- name: sortBy[0].name
in: query
description: Sort field name
required: false
schema:
type: string
- name: sortBy[0].priority
in: query
description: Priority index. Sorts with lower values are executed earlier
required: false
schema:
type: integer
format: int32
- name: take
in: query
description: Maximum number of records to include in results
required: false
schema:
type: integer
format: int32
responses:
'200':
description: Character Set Collection
content:
application/json:
schema:
$ref: '#/components/schemas/PagingOfCharacterSetSummary'
'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
post:
tags:
- CharacterSets
summary: Create Character Set
description: Create character set
operationId: CharacterSetsService_Create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CharacterSetCreateArgs'
description: args
responses:
'200':
description: Character Set
content:
application/json:
schema:
$ref: '#/components/schemas/CharacterSetModel'
'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/character-sets/{id}:
get:
tags:
- CharacterSets
summary: Get Character Set
description: Get character set
operationId: CharacterSetsService_Get
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: Character Set
content:
application/json:
schema:
$ref: '#/components/schemas/CharacterSetModel'
'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
patch:
tags:
- CharacterSets
summary: Patch Character Set
description: Patch character set
operationId: CharacterSetsService_Patch
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CharacterSetPatchArgs'
description: args
responses:
'200':
description: Character Set
content:
application/json:
schema:
$ref: '#/components/schemas/CharacterSetModel'
'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/character-sets/{id}/audit:
get:
tags:
- CharacterSets
summary: Characterset Audits
description: Get all of the audits for a character set
operationId: CharacterSetsService_GetSiteAudits
parameters:
- name: id
in: path
description: id
required: true
schema:
type: integer
format: int32
- name: isExporting
in: query
description: isExporting
required: false
schema:
type: boolean
- name: skip
in: query
description: Number of records to skip before taking results
required: false
schema:
type: integer
format: int32
- name: sortBy[0].direction
in: query
description: Sort direction
required: false
schema:
type: string
- name: sortBy[0].name
in: query
description: Sort field name
required: false
schema:
type: string
- name: sortBy[0].priority
in: query
description: Priority index. Sorts with lower values are executed earlier
required: false
schema:
type: integer
format: int32
- name: take
in: query
description: Maximum number of records to include in results
required: false
schema:
type: integer
format: int32
responses:
'200':
description: Paged List of Audits
content:
application/json:
schema:
$ref: '#/components/schemas/PagingOfCharacterSetAuditSummary'
'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:
Sort:
description: Sort options. Multiple sort options can be provided in the query string.
required:
- name
- direction
properties:
direction:
$ref: '#/components/schemas/SortDirection'
name:
description: Sort field name
type: string
priority:
description: Priority index. Sorts with lower values are executed earlier
type: integer
format: int32
type: object
CharacterSetPatchArgs:
description: Character Set Patch Args
properties:
data:
$ref: '#/components/schemas/CharacterSetPatchModel'
type: object
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
CharacterSetPatchModel:
description: Character Set Patch Model
properties:
abbreviation:
$ref: '#/components/schemas/UpdateFieldValueOfString'
active:
$ref: '#/components/schemas/UpdateFieldValueOfBoolean'
description:
$ref: '#/components/schemas/UpdateFieldValueOfString'
name:
$ref: '#/components/schemas/UpdateFieldValueOfString'
value:
$ref: '#/components/schemas/UpdateFieldValueOfString'
type: object
UpdateFieldValueOfBoolean:
description: Active
properties:
dirty:
description: Dirty
type: boolean
value:
description: Value
type: boolean
type: object
SortDirection:
description: Sort direction
properties: {}
type: string
enum:
- None
- Asc
- Desc
CharacterSetModel:
description: Character Set that is used in password requirements
properties:
abbreviation:
description: Abbreviated view of the character set
type: string
active:
description: Is this character set active
type: boolean
characterSetId:
description: Sequence ID for character set
type: integer
format: int32
description:
description: Description
type: string
isStandard:
description: Is this a standard character set
type: boolean
name:
description: Name
type: string
value:
description: The actual characters in the character set
type: string
type: object
CharacterSetCreateModel:
description: Character Set Create Model
properties:
abbreviation:
description: Abbreviated view of the character set
type: string
active:
description: Is this character set active
type: boolean
nullable: true
description:
description: Description
type: string
name:
description: Name
type: string
value:
description: The actual characters in the character set
type: string
type: object
Severity:
description: Error severity level
properties: {}
type: string
enum:
- None
- Retry
- Warn
- Critical
- Fatal
PagingOfCharacterSetSummary:
description: Specify paging and sorting options for querying records and returning results
properties:
batchCount:
description: Number of result batches available with current query options
type: integer
format: int32
currentPage:
description: Index of current result page
type: integer
format: int32
hasNext:
description: Whether there are any results in additional pages
type: boolean
hasPrev:
description: Whether there are any results in previous pages
type: boolean
nextSkip:
description: Correct value of 'skip' for the next page of results
type: integer
format: int32
pageCount:
description: Number of result pages available with current query options
type: integer
format: int32
prevSkip:
description: Correct value of 'skip' for the previous page of results
type: integer
format: int32
records:
description: Query results
items:
$ref: '#/components/schemas/CharacterSetSummary'
type: array
severity:
$ref: '#/components/schemas/Severity'
skip:
description: Number of records to skip before taking results
type: integer
format: int32
sortBy:
description: List of sort properties
items:
$ref: '#/components/schemas/Sort'
type: array
success:
description: Whether the query executed successfully
type: boolean
take:
description: Maximum number of records to include in results
type: integer
format: int32
total:
description: Total number of results available
type: integer
format: int32
type: object
CharacterSetSummary:
description: Character Set that is used in password requirements
properties:
abbreviation:
description: Abbreviated view of the character set
type: string
active:
description: Is this character set active
type: boolean
characterSetId:
description: Sequence ID for character set
type: integer
format: int32
description:
description: Description
type: string
isStandard:
description: Is this a standard character set
type: boolean
name:
description: Name
type: string
value:
description: The actual characters in the character set
type: string
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
PagingOfCharacterSetAuditSummary:
description: Specify paging and sorting options for querying records and returning results
properties:
batchCount:
description: Number of result batches available with current query options
type: integer
format: int32
currentPage:
description: Index of current result page
type: integer
format: int32
hasNext:
description: Whether there are any results in additional pages
type: boolean
hasPrev:
description: Whether there are any results in previous pages
type: boolean
nextSkip:
description: Correct value of 'skip' for the next page of results
type: integer
format: int32
pageCount:
description: Number of result pages available with current query options
type: integer
format: int32
prevSkip:
description: Correct value of 'skip' for the previous page of results
type: integer
format: int32
records:
description: Query results
items:
$ref: '#/components/schemas/CharacterSetAuditSummary'
type: array
severity:
$ref: '#/components/schemas/Severity'
skip:
description: Number of records to skip before taking results
type: integer
format: int32
sortBy:
description: List of sort properties
items:
$ref: '#/components/schemas/Sort'
type: array
success:
description: Whether the query executed successfully
type: boolean
take:
description: Maximum number of records to include in results
type: integer
format: int32
total:
description: Total number of results available
type: integer
format: int32
type: object
UpdateFieldValueOfString:
description: Description
properties:
dirty:
description: Dirty
type: boolean
value:
description: Value
type: string
type: object
AuthenticationFailedResponse:
description: Response object for authentication failures
required:
- message
properties:
message:
description: Error message
type: string
type: object
CharacterSetAuditSummary:
description: Query results
properties:
action:
description: Action
type: string
characterSetAuditId:
description: CharacterSetAuditId
type: integer
format: int32
characterSetId:
description: CharacterSetId
type: integer
format: int32
dateRecorded:
description: DateRecorded
type: string
format: date-time
displayName:
description: DisplayName
type: string
notes:
description: Notes
type: string
userId:
description: UserId
type: integer
format: int32
userName:
description: UserName
type: string
type: object
CharacterSetCreateArgs:
description: Character Set Create Args
properties:
data:
$ref: '#/components/schemas/CharacterSetCreateModel'
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