OpenAPI Specification
openapi: 3.0.0
info:
title: Secret Server Rest Activations SdkClientRules 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: SdkClientRules
description: View and maintain SDK Client Rules
paths:
/v1/sdk-client-rules/{id}:
get:
tags:
- SdkClientRules
summary: Get SDK Client Rule
description: Get a single SDK Client rule by ID
operationId: SdkClientRulesService_Get
parameters:
- name: id
in: path
description: SDK Client Rule Id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: SdkClientRuleModel
content:
application/json:
schema:
$ref: '#/components/schemas/SdkClientRuleModel'
'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
put:
tags:
- SdkClientRules
summary: Update SDK Client Rule
description: Update a single SDK Client rule by ID
operationId: SdkClientRulesService_UpdateClientRule
parameters:
- name: id
in: path
description: SDK Client Rule Id
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SdkClientRuleUpdateArgs'
description: SDK Client Rule update options
responses:
'200':
description: SdkClientRuleModel
content:
application/json:
schema:
$ref: '#/components/schemas/SdkClientRuleModel'
'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
delete:
tags:
- SdkClientRules
summary: Delete SDK Client Rule
description: Delete a SDK Client rule by ID
operationId: SdkClientRulesService_Delete
parameters:
- name: id
in: path
description: SDK Client Rule Id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: DeletedModel
content:
application/json:
schema:
$ref: '#/components/schemas/DeletedModel'
'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/sdk-client-rules:
get:
tags:
- SdkClientRules
summary: Search SDK Client Rules
description: Search, filter, sort, and page app SDK Client rules
operationId: SdkClientRulesService_SearchClientRules
parameters:
- name: filter.operator
in: query
description: Operator
required: false
schema:
type: string
- name: filter.searchText
in: query
description: SearchText
required: false
schema:
type: string
- name: filter.userId
in: query
description: UserId
required: false
x-nullable: true
schema:
type: integer
format: int32
- 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: SDK Client Rule search result object
content:
application/json:
schema:
$ref: '#/components/schemas/PagingOfSdkClientRuleSummaryAndSdkClientRuleFilter'
'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:
- SdkClientRules
summary: Create New SDK Client Rule
description: Create a new SDK Client rule
operationId: SdkClientRulesService_CreateClientRule
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SdkClientRuleCreateArgs'
description: SDK Client Rule creation options
responses:
'200':
description: SdkClientRuleModel
content:
application/json:
schema:
$ref: '#/components/schemas/SdkClientRuleModel'
'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/sdk-client-rules/{id}/onboarding-key:
get:
tags:
- SdkClientRules
summary: Get Onboarding Key for SDK Client Rule
description: Get the onboarding key for a single SDK Client rule by ID
operationId: SdkClientRulesService_GetOnboardingKey
parameters:
- name: id
in: path
description: SDK Client Rule Id
required: true
schema:
type: integer
format: int32
responses:
'200':
description: SdkClientRuleModel
content:
application/json:
schema:
description: String
type: string
'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/sdk-client-rules/stub:
get:
tags:
- SdkClientRules
summary: Get SDK Client Rule Stub
description: Return the default values for a new SDK Client rule
operationId: SdkClientRulesService_Stub
responses:
'200':
description: SdkClientRuleModel
content:
application/json:
schema:
$ref: '#/components/schemas/SdkClientRuleModel'
'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
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
PagingOfSdkClientRuleSummaryAndSdkClientRuleFilter:
description: Specify filtering, paging, 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
filter:
$ref: '#/components/schemas/SdkClientRuleFilter'
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/SdkClientRuleSummary'
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
DeletedModel:
description: Information about an object that was deleted
properties:
id:
description: ID of the deleted object
type: integer
format: int32
objectType:
description: Type of the deleted object
type: string
responseCodes:
description: List of response codes from the delete operation
items:
type: string
type: array
type: object
SdkClientRuleUpdateArgs:
description: SdkClientRuleUpdateArgs
required:
- name
properties:
details:
description: Details
type: string
name:
description: Name
type: string
requireOnboardingKey:
description: RequireOnboardingKey
type: boolean
userId:
description: UserId
type: integer
format: int32
nullable: true
type: object
SdkClientRuleSummary:
description: Query results
properties:
details:
description: Details
type: string
id:
description: Id
type: integer
format: int32
name:
description: Name
type: string
requireOnboardingKey:
description: RequireOnboardingKey
type: boolean
userDisplayName:
description: UserDisplayName
type: string
userId:
description: UserId
type: integer
format: int32
nullable: true
type: object
SortDirection:
description: Sort direction
properties: {}
type: string
enum:
- None
- Asc
- Desc
SdkClientRuleFilter:
description: Additional query options
properties:
operator:
$ref: '#/components/schemas/FilterOperator'
searchText:
description: SearchText
type: string
userId:
description: UserId
type: integer
format: int32
nullable: true
type: object
Severity:
description: Error severity level
properties: {}
type: string
enum:
- None
- Retry
- Warn
- Critical
- Fatal
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
FilterOperator:
description: Operator
properties: {}
type: string
enum:
- All
- Include
- Exclude
SdkClientRuleCreateArgs:
description: SdkClientRuleCreateArgs
required:
- name
properties:
details:
description: Details
type: string
name:
description: Name
type: string
requireOnboardingKey:
description: RequireOnboardingKey
type: boolean
userId:
description: UserId
type: integer
format: int32
nullable: true
type: object
AuthenticationFailedResponse:
description: Response object for authentication failures
required:
- message
properties:
message:
description: Error message
type: string
type: object
SdkClientRuleModel:
description: SdkClientRuleModel
properties:
details:
description: Details
type: string
id:
description: Id
type: integer
format: int32
name:
description: Name
type: string
requireOnboardingKey:
description: RequireOnboardingKey
type: boolean
userDisplayName:
description: UserDisplayName
type: string
userId:
description: UserId
type: integer
format: int32
nullable: true
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