Oauth2API

All URIs are relative to https://q.trap.jp/api/v3

Method	HTTP request	Description
createClient	POST /clients	OAuth2クライアントを作成
deleteClient	DELETE /clients/{clientId}	OAuth2クライアントを削除
editClient	PATCH /clients/{clientId}	OAuth2クライアント情報を変更
getClient	GET /clients/{clientId}	OAuth2クライアント情報を取得
getClients	GET /clients	OAuth2クライアントのリストを取得
getMyTokens	GET /users/me/tokens	有効トークンのリストを取得
getOAuth2Authorize	GET /oauth2/authorize	OAuth2 認可エンドポイント
postOAuth2Authorize	POST /oauth2/authorize	OAuth2 認可エンドポイント
postOAuth2AuthorizeDecide	POST /oauth2/authorize/decide	OAuth2 認可承諾API
postOAuth2Token	POST /oauth2/token	OAuth2 トークンエンドポイント
revokeClientTokens	DELETE /clients/{clientId}/tokens	OAuthクライアントのトークンを削除
revokeMyToken	DELETE /users/me/tokens/{tokenId}	トークンの認可を取り消す
revokeOAuth2Token	POST /oauth2/revoke	OAuth2 トークン無効化エンドポイント

createClient

    open class func createClient(postClientRequest: PostClientRequest? = nil, completion: @escaping (_ data: OAuth2ClientDetail?, _ error: Error?) -> Void)

OAuth2クライアントを作成

OAuth2クライアントを作成します。

Example

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

let postClientRequest = PostClientRequest(name: "name_example", callbackUrl: "callbackUrl_example", scopes: [OAuth2Scope()], description: "description_example", confidential: false) // PostClientRequest |  (optional)

// OAuth2クライアントを作成
Oauth2API.createClient(postClientRequest: postClientRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
postClientRequest	PostClientRequest		[optional]

Return type

OAuth2ClientDetail

Authorization

OAuth2, bearerAuth

HTTP request headers

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

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

deleteClient

    open class func deleteClient(clientId: String, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

OAuth2クライアントを削除

指定したOAuth2クライアントを削除します。対象のクライアントの管理権限が必要です。正常に削除された場合、このクライアントに対する認可は全て取り消されます。

Example

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

let clientId = "clientId_example" // String | OAuth2クライアントUUID

// OAuth2クライアントを削除
Oauth2API.deleteClient(clientId: clientId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
clientId	String	OAuth2クライアントUUID

Return type

Void (empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

editClient

    open class func editClient(clientId: String, patchClientRequest: PatchClientRequest? = nil, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

OAuth2クライアント情報を変更

指定したOAuth2クライアントの情報を変更します。対象のクライアントの管理権限が必要です。クライアント開発者UUIDを変更した場合は、変更先ユーザーにクライアント管理権限が移譲され、自分自身は権限を失います。

Example

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

let clientId = "clientId_example" // String | OAuth2クライアントUUID
let patchClientRequest = PatchClientRequest(name: "name_example", description: "description_example", callbackUrl: "callbackUrl_example", developerId: 123, confidential: false) // PatchClientRequest |  (optional)

// OAuth2クライアント情報を変更
Oauth2API.editClient(clientId: clientId, patchClientRequest: patchClientRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
clientId	String	OAuth2クライアントUUID
patchClientRequest	PatchClientRequest		[optional]

Return type

Void (empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

getClient

    open class func getClient(clientId: String, detail: Bool? = nil, completion: @escaping (_ data: GetClient200Response?, _ error: Error?) -> Void)

OAuth2クライアント情報を取得

指定したOAuth2クライアントの情報を取得します。詳細情報の取得には対象のクライアントの管理権限が必要です。

Example

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

let clientId = "clientId_example" // String | OAuth2クライアントUUID
let detail = true // Bool | 詳細情報を含めるかどうか (optional) (default to false)

// OAuth2クライアント情報を取得
Oauth2API.getClient(clientId: clientId, detail: detail) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
clientId	String	OAuth2クライアントUUID
detail	Bool	詳細情報を含めるかどうか	[optional] [default to false]

Return type

GetClient200Response

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

getClients

    open class func getClients(all: Bool? = nil, completion: @escaping (_ data: [OAuth2Client]?, _ error: Error?) -> Void)

OAuth2クライアントのリストを取得

自身が開発者のOAuth2クライアントのリストを取得します。 allがtrueの場合、全開発者の全クライアントのリストを返します。

Example

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

let all = true // Bool | 全てのクライアントを取得するかどうか (optional) (default to false)

// OAuth2クライアントのリストを取得
Oauth2API.getClients(all: all) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
all	Bool	全てのクライアントを取得するかどうか	[optional] [default to false]

Return type

[OAuth2Client]

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

getMyTokens

    open class func getMyTokens(completion: @escaping (_ data: [ActiveOAuth2Token]?, _ error: Error?) -> Void)

有効トークンのリストを取得

有効な自分に発行されたOAuth2トークンのリストを取得します。

Example

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


// 有効トークンのリストを取得
Oauth2API.getMyTokens() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

[ActiveOAuth2Token]

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

getOAuth2Authorize

    open class func getOAuth2Authorize(clientId: String, responseType: OAuth2ResponseType? = nil, redirectUri: String? = nil, scope: String? = nil, state: String? = nil, codeChallenge: String? = nil, codeChallengeMethod: String? = nil, nonce: String? = nil, prompt: OAuth2Prompt? = nil, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

OAuth2 認可エンドポイント

Example

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

let clientId = "clientId_example" // String | 
let responseType = OAuth2ResponseType() // OAuth2ResponseType |  (optional)
let redirectUri = "redirectUri_example" // String |  (optional)
let scope = "scope_example" // String |  (optional)
let state = "state_example" // String |  (optional)
let codeChallenge = "codeChallenge_example" // String |  (optional)
let codeChallengeMethod = "codeChallengeMethod_example" // String |  (optional)
let nonce = "nonce_example" // String |  (optional)
let prompt = OAuth2Prompt() // OAuth2Prompt |  (optional)

// OAuth2 認可エンドポイント
Oauth2API.getOAuth2Authorize(clientId: clientId, responseType: responseType, redirectUri: redirectUri, scope: scope, state: state, codeChallenge: codeChallenge, codeChallengeMethod: codeChallengeMethod, nonce: nonce, prompt: prompt) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Notes
clientId	String
responseType	OAuth2ResponseType	[optional]
redirectUri	String	[optional]
scope	String	[optional]
state	String	[optional]
codeChallenge	String	[optional]
codeChallengeMethod	String	[optional]
nonce	String	[optional]
prompt	OAuth2Prompt	[optional]

Return type

Void (empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

postOAuth2Authorize

    open class func postOAuth2Authorize(clientId: String, responseType: OAuth2ResponseType? = nil, redirectUri: String? = nil, scope: String? = nil, state: String? = nil, codeChallenge: String? = nil, codeChallengeMethod: String? = nil, nonce: String? = nil, prompt: OAuth2Prompt? = nil, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

OAuth2 認可エンドポイント

Example

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

let clientId = "clientId_example" // String | 
let responseType = OAuth2ResponseType() // OAuth2ResponseType |  (optional)
let redirectUri = "redirectUri_example" // String |  (optional)
let scope = "scope_example" // String |  (optional)
let state = "state_example" // String |  (optional)
let codeChallenge = "codeChallenge_example" // String |  (optional)
let codeChallengeMethod = "codeChallengeMethod_example" // String |  (optional)
let nonce = "nonce_example" // String |  (optional)
let prompt = OAuth2Prompt() // OAuth2Prompt |  (optional)

// OAuth2 認可エンドポイント
Oauth2API.postOAuth2Authorize(clientId: clientId, responseType: responseType, redirectUri: redirectUri, scope: scope, state: state, codeChallenge: codeChallenge, codeChallengeMethod: codeChallengeMethod, nonce: nonce, prompt: prompt) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Notes
clientId	String
responseType	OAuth2ResponseType	[optional]
redirectUri	String	[optional]
scope	String	[optional]
state	String	[optional]
codeChallenge	String	[optional]
codeChallengeMethod	String	[optional]
nonce	String	[optional]
prompt	OAuth2Prompt	[optional]

Return type

Void (empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

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

postOAuth2AuthorizeDecide

    open class func postOAuth2AuthorizeDecide(submit: String, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

OAuth2 認可承諾API

OAuth2 認可承諾

Example

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

let submit = "submit_example" // String | 承諾する場合は\\\"approve\\\"

// OAuth2 認可承諾API
Oauth2API.postOAuth2AuthorizeDecide(submit: submit) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
submit	String	承諾する場合は\"approve\"

Return type

Void (empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

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

postOAuth2Token

    open class func postOAuth2Token(grantType: String, code: String? = nil, redirectUri: String? = nil, clientId: String? = nil, codeVerifier: String? = nil, username: String? = nil, password: String? = nil, scope: String? = nil, refreshToken: String? = nil, clientSecret: String? = nil, completion: @escaping (_ data: OAuth2Token?, _ error: Error?) -> Void)

OAuth2 トークンエンドポイント

Example

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

let grantType = "grantType_example" // String | 
let code = "code_example" // String |  (optional)
let redirectUri = "redirectUri_example" // String |  (optional)
let clientId = "clientId_example" // String |  (optional)
let codeVerifier = "codeVerifier_example" // String |  (optional)
let username = "username_example" // String |  (optional)
let password = "password_example" // String |  (optional)
let scope = "scope_example" // String |  (optional)
let refreshToken = "refreshToken_example" // String |  (optional)
let clientSecret = "clientSecret_example" // String |  (optional)

// OAuth2 トークンエンドポイント
Oauth2API.postOAuth2Token(grantType: grantType, code: code, redirectUri: redirectUri, clientId: clientId, codeVerifier: codeVerifier, username: username, password: password, scope: scope, refreshToken: refreshToken, clientSecret: clientSecret) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Notes
grantType	String
code	String	[optional]
redirectUri	String	[optional]
clientId	String	[optional]
codeVerifier	String	[optional]
username	String	[optional]
password	String	[optional]
scope	String	[optional]
refreshToken	String	[optional]
clientSecret	String	[optional]

Return type

OAuth2Token

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

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

revokeClientTokens

    open class func revokeClientTokens(clientId: String, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

OAuthクライアントのトークンを削除

自分が許可している指定したOAuthクライアントのアクセストークンを全てRevokeします。

Example

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

let clientId = "clientId_example" // String | OAuth2クライアントUUID

// OAuthクライアントのトークンを削除
Oauth2API.revokeClientTokens(clientId: clientId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
clientId	String	OAuth2クライアントUUID

Return type

Void (empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

revokeMyToken

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

トークンの認可を取り消す

自分の指定したトークンの認可を取り消します。

Example

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

let tokenId = 987 // UUID | OAuth2トークンUUID

// トークンの認可を取り消す
Oauth2API.revokeMyToken(tokenId: tokenId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
tokenId	UUID	OAuth2トークンUUID

Return type

Void (empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

revokeOAuth2Token

    open class func revokeOAuth2Token(token: String, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

OAuth2 トークン無効化エンドポイント

Example

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

let token = "token_example" // String | 無効化するOAuth2トークンまたはOAuth2リフレッシュトークン

// OAuth2 トークン無効化エンドポイント
Oauth2API.revokeOAuth2Token(token: token) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
token	String	無効化するOAuth2トークンまたはOAuth2リフレッシュトークン

Return type

Void (empty response body)

Authorization

OAuth2, bearerAuth

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

[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

createClient

Example

Parameters

Return type

Authorization

HTTP request headers

deleteClient

Example

Parameters

Return type

Authorization

HTTP request headers

editClient

Example

Parameters

Return type

Authorization

HTTP request headers

getClient

Example

Parameters

Return type

Authorization

HTTP request headers

getClients

Example

Parameters

Return type

Authorization

HTTP request headers

getMyTokens

Example

Parameters

Return type

Authorization

HTTP request headers

getOAuth2Authorize

Example

Parameters

Return type

Authorization

HTTP request headers

postOAuth2Authorize

Example

Parameters

Return type

Authorization

HTTP request headers

postOAuth2AuthorizeDecide

Example

Parameters

Return type

Authorization

HTTP request headers

postOAuth2Token

Example

Parameters

Return type

Authorization

HTTP request headers

revokeClientTokens

Example

Parameters

Return type

Authorization

HTTP request headers

revokeMyToken

Example

Parameters

Return type

Authorization

HTTP request headers

revokeOAuth2Token