Help Center/ CodeArts Pipeline/ API Reference/ API/ Endpoint Management/ Obtaining the OAuth2 Authentication URL
Updated on 2025-09-08 GMT+08:00

Obtaining the OAuth2 Authentication URL

Function

This API is used to obtain the OAuth2 authentication URL.

Calling Method

For details, see Calling APIs.

URI

GET /v1/serviceconnection/oauth/authorization_url

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

module_id

Yes

String

Definition:

Module ID.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

redirect_uri

No

String

Definition:

Redirect URI.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

error

ErrorInfo object

Definition:

Error message.

Value range:

N/A

result

Object

Definition:

Error result.

Value range:

N/A

status

String

Definition:

Status value.

Value range:

N/A

Table 3 ErrorInfo

Parameter

Type

Description

code

String

Definition:

Error code.

Value range:

N/A

message

String

Definition:

Error message.

Value range:

N/A

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.