Delinea IpAddressRestrictions API

openapi: 3.0.0
info:
  title: Secret Server Rest Activations IpAddressRestrictions 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: IpAddressRestrictions
  description: View and maintain IP Address restrictions
paths:
  /v1/ipaddress-restrictions/{id}:
    get:
      tags:
      - IpAddressRestrictions
      summary: Get IP Address restriction
      description: Get a single IP Address restriction by ID
      operationId: IpAddressRestrictionsService_Get
      parameters:
      - name: id
        in: path
        description: IP Address restriction ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: IP Address restriction object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpAddressRestrictionModel'
        '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:
      - IpAddressRestrictions
      summary: Update IP Address restriction
      description: Update a new IP Address restriction
      operationId: IpAddressRestrictionsService_Update
      parameters:
      - name: id
        in: path
        description: IP Address restriction Id
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IpAddressRestrictionUpdateArgs'
        description: IP Address restriction
      responses:
        '200':
          description: IP Address restriction object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpAddressRestrictionModel'
        '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:
      - IpAddressRestrictions
      summary: Delete IP Address restriction
      description: Delete an IP Address restriction by ID
      operationId: IpAddressRestrictionsService_Delete
      parameters:
      - name: id
        in: path
        description: IP Address restriction Id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Object deletion result
          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/ipaddress-restrictions/{id}/groups/{groupId}:
    get:
      tags:
      - IpAddressRestrictions
      summary: Get Group IP Address restriction
      description: Get a single Group IP Address restriction by restriction and group ID
      operationId: IpAddressRestrictionsService_GetGroup
      parameters:
      - name: groupId
        in: path
        description: Group ID
        required: true
        schema:
          type: integer
          format: int32
      - name: id
        in: path
        description: IP Address restriction ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Group and IP Address restriction object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupIpAddressRestrictionModel'
        '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:
      - IpAddressRestrictions
      summary: Delete Group IP Address restriction
      description: Delete a Group IP Address restriction by ID
      operationId: IpAddressRestrictionsService_DeleteGroupIpRestriction
      parameters:
      - name: groupId
        in: path
        description: Group ID
        required: true
        schema:
          type: integer
          format: int32
      - name: id
        in: path
        description: IP Address restriction Id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Object deletion result
          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/ipaddress-restrictions/{id}/users/{userId}:
    get:
      tags:
      - IpAddressRestrictions
      summary: Get User IP Address restriction
      description: Get a single User IP Address restriction by restriction and user ID
      operationId: IpAddressRestrictionsService_GetUserIpRestriction
      parameters:
      - name: id
        in: path
        description: IP Address restriction ID
        required: true
        schema:
          type: integer
          format: int32
      - name: userId
        in: path
        description: User ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: User and IP Address restriction object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserIpAddressRestrictionModel'
        '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:
      - IpAddressRestrictions
      summary: Delete User IP Address restriction
      description: Delete a User IP Address restriction by ID
      operationId: IpAddressRestrictionsService_DeleteUserIpRestriction
      parameters:
      - name: id
        in: path
        description: IP Address restriction Id
        required: true
        schema:
          type: integer
          format: int32
      - name: userId
        in: path
        description: User ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Object deletion result
          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/ipaddress-restrictions:
    get:
      tags:
      - IpAddressRestrictions
      summary: Search IP Address restrictions
      description: Search, filter, sort, and page IP Address restrictions
      operationId: IpAddressRestrictionsService_Search
      parameters:
      - 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: IP Address restriction search result object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfIpAddressRestrictionSummary'
        '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:
      - IpAddressRestrictions
      summary: Create IP Address restriction
      description: Create a new IP Address restriction
      operationId: IpAddressRestrictionsService_Create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IpAddressRestrictionCreateArgs'
        description: IP Address restriction
      responses:
        '200':
          description: IP Address restriction object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IpAddressRestrictionModel'
        '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/ipaddress-restrictions/{id}/groups:
    get:
      tags:
      - IpAddressRestrictions
      summary: Search groups assigned to an IP Address restriction
      description: Search, filter, sort, and page groups assigned to an IP Address restriction
      operationId: IpAddressRestrictionsService_SearchGroups
      parameters:
      - name: id
        in: path
        description: IP Address restriction ID
        required: 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: Group and IP Address restriction search result object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfGroupIpAddressRestrictionModel'
        '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:
      - IpAddressRestrictions
      summary: Create Group IP Address restriction
      description: Create a new Group IP Address restriction
      operationId: IpAddressRestrictionsService_CreateGroupIpRestriction
      parameters:
      - name: id
        in: path
        description: IP Address restriction ID
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupIpAddressRestrictionCreateArgs'
        description: Group IP Address restriction
      responses:
        '200':
          description: Group IP Address restriction object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupIpAddressRestrictionModel'
        '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/groups/{id}/ipaddress-restrictions:
    get:
      tags:
      - IpAddressRestrictions
      summary: Search IP Address restrictions assigned to a group
      description: Search, filter, sort, and page IP Address restriction assigned to a group
      operationId: IpAddressRestrictionsService_GetAllByGroup
      parameters:
      - name: id
        in: path
        description: Group ID
        required: 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: Group and IP Address restriction search result object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfGroupIpAddressRestrictionModel'
        '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/ipaddress-restrictions/{id}/users:
    get:
      tags:
      - IpAddressRestrictions
      summary: Search users assigned to an IP Address restriction
      description: Search, filter, sort, and page users assigned to an IP Address restriction
      operationId: IpAddressRestrictionsService_SearchUsers
      parameters:
      - name: id
        in: path
        description: IP Address restriction ID
        required: 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: User and IP Address restriction search result object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfUserIpAddressRestrictionModel'
        '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:
      - IpAddressRestrictions
      summary: Create User IP Address restriction
      description: Create a new User IP Address restriction
      operationId: IpAddressRestrictionsService_CreateUserIpRestriction
      parameters:
      - name: id
        in: path
        description: IP Address restriction ID
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserIpAddressRestrictionCreateArgs'
        description: User IP Address restriction
      responses:
        '200':
          description: User IP Address restriction object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserIpAddressRestrictionModel'
        '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/users/{id}/ipaddress-restrictions:
    get:
      tags:
      - IpAddressRestrictions
      summary: Search IP Address restrictions assigned to a user
      description: Search, filter, sort, and page IP Address restriction assigned to a user
      operationId: IpAddressRestrictionsService_GetAllByUser
      parameters:
      - name: id
        in: path
        description: User ID
        required: 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: User and IP Address restriction search result object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagingOfUserIpAddressRestrictionModel'
        '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
    UserIpAddressRestrictionCreateArgs:
      description: UserIpAddressRestrictionCreateArgs
      required:
      - userId
      - ipAddressRestrictionId
      properties:
        ipAddressRestrictionId:
          description: IpAddressRestrictionId
          type: integer
          format: int32
        userId:
          description: UserId
          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
    GroupIpAddressRestrictionModel:
      description: GroupIpAddressRestrictionModel
      properties:
        groupId:
          description: GroupId
          type: integer
          format: int32
        groupName:
          description: GroupName
          type: string
        id:
          description: Id
          type: integer
          format: int32
        ipAddressRestrictionId:
          description: IpAddressRestrictionId
          type: integer
          format: int32
        ipAddressRestrictionName:
          description: IpAddressRestrictionName
          type: string
      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
    SortDirection:
      description: Sort direction
      properties: {}
      type: string
      enum:
      - None
      - Asc
      - Desc
    UserIpAddressRestrictionModel:
      description: UserIpAddressRestrictionModel
      properties:
        id:
          description: Id
          type: integer
          format: int32
        ipAddressRestrictionId:
          description: IpAddressRestrictionId
          type: integer
          format: int32
        ipAddressRestrictionName:
          description: IpAddressRestrictionName
          type: string
        userDisplayName:
          description: UserDisplayName
          type: string
        userId:
          description: UserId
          type: integer
          format: int32
        userName:
          description: UserName
          type: string
      type: object
    AuthenticationFailedResponse:
      description: Response object for authentication failures
      required:
      - message
      properties:
        message:
          description: Error message
          type: string
      type: object
    IpAddressRestrictionCreateArgs:
      description: IpAddressRestrictionCreateArgs
      required:
      - name
      - range
      properties:
        name:
          description: Name
          type: string
        range:
          description: Range
          type: string
      type: object
    Severity:
      description: Error severity level
      properties: {}
      type: string
      enum:
      - None
      - Retry
      - Warn
      - Critical
      - Fatal
    IpAddressRestrictionUpdateArgs:
      description: IpAddressRestrictionUpdateArgs
      properties:
        id:
          description: Id
          type: integer
          format: int32
        name:
          description: Name
          type: string
        range:
          description: Range
          type: string
      type: object
    GroupIpAddressRestrictionCreateArgs:
      description: GroupIpAddressRestrictionCreateArgs
      required:
      - groupId
      - ipAddressRestrictionId
      properties:
        groupId:
          description: GroupId
          type: integer
          format: int32
        ipAddressRestrictionId:
          description: IpAddressRestrictionId
          type: integer
          format: int32
      type: object
    PagingOfGroupIpAddressRestrictionModel:
      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/GroupIpAddressRestrictionModel'
          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
    PagingOfUserIpAddressRestrictionModel:
      description: Specify paging and sorting options for querying records and retu

# --- truncated at 32 KB (37 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/delinea/refs/heads/main/openapi/delinea-ipaddressrestrictions-api-openapi.yml