Skip to content
This repository has been archived by the owner on Apr 17, 2024. It is now read-only.

Latest commit

 

History

History
374 lines (251 loc) · 11.1 KB

RacAPI.md

File metadata and controls

374 lines (251 loc) · 11.1 KB
Raw

RacAPI

All URIs are relative to http://localhost/api/v3

Method HTTP request Description
racEndpointsCreate POST /rac/endpoints/
racEndpointsDestroy DELETE /rac/endpoints/{pbm_uuid}/
racEndpointsList GET /rac/endpoints/
racEndpointsPartialUpdate PATCH /rac/endpoints/{pbm_uuid}/
racEndpointsRetrieve GET /rac/endpoints/{pbm_uuid}/
racEndpointsUpdate PUT /rac/endpoints/{pbm_uuid}/
racEndpointsUsedByList GET /rac/endpoints/{pbm_uuid}/used_by/

racEndpointsCreate

    open class func racEndpointsCreate(endpointRequest: EndpointRequest, completion: @escaping (_ data: Endpoint?, _ error: Error?) -> Void)

Endpoint Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let endpointRequest = EndpointRequest(name: "name_example", provider: 123, _protocol: ProtocolEnum(), host: "host_example", settings: "TODO", propertyMappings: [123], authMode: AuthModeEnum(), maximumConnections: 123) // EndpointRequest | 

RacAPI.racEndpointsCreate(endpointRequest: endpointRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
endpointRequest EndpointRequest

Return type

Endpoint

Authorization

authentik

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

racEndpointsDestroy

    open class func racEndpointsDestroy(pbmUuid: UUID, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

Endpoint Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let pbmUuid = 987 // UUID | A UUID string identifying this RAC Endpoint.

RacAPI.racEndpointsDestroy(pbmUuid: pbmUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pbmUuid UUID A UUID string identifying this RAC Endpoint.

Return type

Void (empty response body)

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

racEndpointsList

    open class func racEndpointsList(name: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, provider: Int? = nil, search: String? = nil, superuserFullList: Bool? = nil, completion: @escaping (_ data: PaginatedEndpointList?, _ error: Error?) -> Void)

List accessible endpoints

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let name = "name_example" // String |  (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let page = 987 // Int | A page number within the paginated result set. (optional)
let pageSize = 987 // Int | Number of results to return per page. (optional)
let provider = 987 // Int |  (optional)
let search = "search_example" // String |  (optional)
let superuserFullList = true // Bool |  (optional)

RacAPI.racEndpointsList(name: name, ordering: ordering, page: page, pageSize: pageSize, provider: provider, search: search, superuserFullList: superuserFullList) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
name String [optional]
ordering String Which field to use when ordering the results. [optional]
page Int A page number within the paginated result set. [optional]
pageSize Int Number of results to return per page. [optional]
provider Int [optional]
search String [optional]
superuserFullList Bool [optional]

Return type

PaginatedEndpointList

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

racEndpointsPartialUpdate

    open class func racEndpointsPartialUpdate(pbmUuid: UUID, patchedEndpointRequest: PatchedEndpointRequest? = nil, completion: @escaping (_ data: Endpoint?, _ error: Error?) -> Void)

Endpoint Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let pbmUuid = 987 // UUID | A UUID string identifying this RAC Endpoint.
let patchedEndpointRequest = PatchedEndpointRequest(name: "name_example", provider: 123, _protocol: ProtocolEnum(), host: "host_example", settings: "TODO", propertyMappings: [123], authMode: AuthModeEnum(), maximumConnections: 123) // PatchedEndpointRequest |  (optional)

RacAPI.racEndpointsPartialUpdate(pbmUuid: pbmUuid, patchedEndpointRequest: patchedEndpointRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pbmUuid UUID A UUID string identifying this RAC Endpoint.
patchedEndpointRequest PatchedEndpointRequest [optional]

Return type

Endpoint

Authorization

authentik

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

racEndpointsRetrieve

    open class func racEndpointsRetrieve(pbmUuid: UUID, completion: @escaping (_ data: Endpoint?, _ error: Error?) -> Void)

Endpoint Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let pbmUuid = 987 // UUID | A UUID string identifying this RAC Endpoint.

RacAPI.racEndpointsRetrieve(pbmUuid: pbmUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pbmUuid UUID A UUID string identifying this RAC Endpoint.

Return type

Endpoint

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

racEndpointsUpdate

    open class func racEndpointsUpdate(pbmUuid: UUID, endpointRequest: EndpointRequest, completion: @escaping (_ data: Endpoint?, _ error: Error?) -> Void)

Endpoint Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let pbmUuid = 987 // UUID | A UUID string identifying this RAC Endpoint.
let endpointRequest = EndpointRequest(name: "name_example", provider: 123, _protocol: ProtocolEnum(), host: "host_example", settings: "TODO", propertyMappings: [123], authMode: AuthModeEnum(), maximumConnections: 123) // EndpointRequest | 

RacAPI.racEndpointsUpdate(pbmUuid: pbmUuid, endpointRequest: endpointRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pbmUuid UUID A UUID string identifying this RAC Endpoint.
endpointRequest EndpointRequest

Return type

Endpoint

Authorization

authentik

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

racEndpointsUsedByList

    open class func racEndpointsUsedByList(pbmUuid: UUID, completion: @escaping (_ data: [UsedBy]?, _ error: Error?) -> Void)

Get a list of all objects that use this object

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let pbmUuid = 987 // UUID | A UUID string identifying this RAC Endpoint.

RacAPI.racEndpointsUsedByList(pbmUuid: pbmUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pbmUuid UUID A UUID string identifying this RAC Endpoint.

Return type

[UsedBy]

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]