Oauth2API

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

Method	HTTP request	Description
oauth2AccessTokensDestroy	DELETE /oauth2/access_tokens/{id}/
oauth2AccessTokensList	GET /oauth2/access_tokens/
oauth2AccessTokensRetrieve	GET /oauth2/access_tokens/{id}/
oauth2AccessTokensUsedByList	GET /oauth2/access_tokens/{id}/used_by/
oauth2AuthorizationCodesDestroy	DELETE /oauth2/authorization_codes/{id}/
oauth2AuthorizationCodesList	GET /oauth2/authorization_codes/
oauth2AuthorizationCodesRetrieve	GET /oauth2/authorization_codes/{id}/
oauth2AuthorizationCodesUsedByList	GET /oauth2/authorization_codes/{id}/used_by/
oauth2RefreshTokensDestroy	DELETE /oauth2/refresh_tokens/{id}/
oauth2RefreshTokensList	GET /oauth2/refresh_tokens/
oauth2RefreshTokensRetrieve	GET /oauth2/refresh_tokens/{id}/
oauth2RefreshTokensUsedByList	GET /oauth2/refresh_tokens/{id}/used_by/

oauth2AccessTokensDestroy

    open class func oauth2AccessTokensDestroy(id: Int, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

AccessToken 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 id = 987 // Int | A unique integer value identifying this OAuth2 Access Token.

Oauth2API.oauth2AccessTokensDestroy(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this OAuth2 Access Token.

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]

oauth2AccessTokensList

    open class func oauth2AccessTokensList(ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, provider: Int? = nil, search: String? = nil, user: Int? = nil, completion: @escaping (_ data: PaginatedTokenModelList?, _ error: Error?) -> Void)

AccessToken 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 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 | A search term. (optional)
let user = 987 // Int |  (optional)

Oauth2API.oauth2AccessTokensList(ordering: ordering, page: page, pageSize: pageSize, provider: provider, search: search, user: user) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
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	A search term.	[optional]
user	Int		[optional]

Return type

PaginatedTokenModelList

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]

oauth2AccessTokensRetrieve

    open class func oauth2AccessTokensRetrieve(id: Int, completion: @escaping (_ data: TokenModel?, _ error: Error?) -> Void)

AccessToken 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 id = 987 // Int | A unique integer value identifying this OAuth2 Access Token.

Oauth2API.oauth2AccessTokensRetrieve(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this OAuth2 Access Token.

Return type

TokenModel

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]

oauth2AccessTokensUsedByList

    open class func oauth2AccessTokensUsedByList(id: Int, 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 id = 987 // Int | A unique integer value identifying this OAuth2 Access Token.

Oauth2API.oauth2AccessTokensUsedByList(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this OAuth2 Access Token.

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]

oauth2AuthorizationCodesDestroy

    open class func oauth2AuthorizationCodesDestroy(id: Int, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

AuthorizationCode 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 id = 987 // Int | A unique integer value identifying this Authorization Code.

Oauth2API.oauth2AuthorizationCodesDestroy(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this Authorization Code.

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]

oauth2AuthorizationCodesList

    open class func oauth2AuthorizationCodesList(ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, provider: Int? = nil, search: String? = nil, user: Int? = nil, completion: @escaping (_ data: PaginatedExpiringBaseGrantModelList?, _ error: Error?) -> Void)

AuthorizationCode 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 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 | A search term. (optional)
let user = 987 // Int |  (optional)

Oauth2API.oauth2AuthorizationCodesList(ordering: ordering, page: page, pageSize: pageSize, provider: provider, search: search, user: user) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
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	A search term.	[optional]
user	Int		[optional]

Return type

PaginatedExpiringBaseGrantModelList

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]

oauth2AuthorizationCodesRetrieve

    open class func oauth2AuthorizationCodesRetrieve(id: Int, completion: @escaping (_ data: ExpiringBaseGrantModel?, _ error: Error?) -> Void)

AuthorizationCode 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 id = 987 // Int | A unique integer value identifying this Authorization Code.

Oauth2API.oauth2AuthorizationCodesRetrieve(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this Authorization Code.

Return type

ExpiringBaseGrantModel

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]

oauth2AuthorizationCodesUsedByList

    open class func oauth2AuthorizationCodesUsedByList(id: Int, 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 id = 987 // Int | A unique integer value identifying this Authorization Code.

Oauth2API.oauth2AuthorizationCodesUsedByList(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this Authorization Code.

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]

oauth2RefreshTokensDestroy

    open class func oauth2RefreshTokensDestroy(id: Int, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

RefreshToken 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 id = 987 // Int | A unique integer value identifying this OAuth2 Refresh Token.

Oauth2API.oauth2RefreshTokensDestroy(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this OAuth2 Refresh Token.

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]

oauth2RefreshTokensList

    open class func oauth2RefreshTokensList(ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, provider: Int? = nil, search: String? = nil, user: Int? = nil, completion: @escaping (_ data: PaginatedTokenModelList?, _ error: Error?) -> Void)

RefreshToken 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 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 | A search term. (optional)
let user = 987 // Int |  (optional)

Oauth2API.oauth2RefreshTokensList(ordering: ordering, page: page, pageSize: pageSize, provider: provider, search: search, user: user) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
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	A search term.	[optional]
user	Int		[optional]

Return type

PaginatedTokenModelList

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]

oauth2RefreshTokensRetrieve

    open class func oauth2RefreshTokensRetrieve(id: Int, completion: @escaping (_ data: TokenModel?, _ error: Error?) -> Void)

RefreshToken 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 id = 987 // Int | A unique integer value identifying this OAuth2 Refresh Token.

Oauth2API.oauth2RefreshTokensRetrieve(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this OAuth2 Refresh Token.

Return type

TokenModel

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]

oauth2RefreshTokensUsedByList

    open class func oauth2RefreshTokensUsedByList(id: Int, 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 id = 987 // Int | A unique integer value identifying this OAuth2 Refresh Token.

Oauth2API.oauth2RefreshTokensUsedByList(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this OAuth2 Refresh Token.

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]

Files

Oauth2API.md

Latest commit

History

Oauth2API.md

File metadata and controls

Oauth2API

oauth2AccessTokensDestroy

Example

Parameters

Return type

Authorization

HTTP request headers

oauth2AccessTokensList

Example

Parameters

Return type

Authorization

HTTP request headers

oauth2AccessTokensRetrieve

Example

Parameters

Return type

Authorization

HTTP request headers

oauth2AccessTokensUsedByList

Example

Parameters

Return type

Authorization

HTTP request headers

oauth2AuthorizationCodesDestroy

Example

Parameters

Return type

Authorization

HTTP request headers

oauth2AuthorizationCodesList

Example

Parameters

Return type

Authorization

HTTP request headers

oauth2AuthorizationCodesRetrieve

Example

Parameters

Return type

Authorization

HTTP request headers

oauth2AuthorizationCodesUsedByList

Example

Parameters

Return type

Authorization

HTTP request headers

oauth2RefreshTokensDestroy

Example

Parameters

Return type

Authorization

HTTP request headers

oauth2RefreshTokensList

Example

Parameters

Return type

Authorization

HTTP request headers

oauth2RefreshTokensRetrieve

Example

Parameters

Return type

Authorization

HTTP request headers

oauth2RefreshTokensUsedByList

Example

Parameters

Return type

Authorization

HTTP request headers