Start Upload OAuth Logo #

🔑 Need JWT Authorization

Description #

Start upload oauth logo

Only oauth owner can request.

Method And Path #

POST /v2/developer/oauth/logo/upload/start

Request #

Header #

{
    "authorization": string;
    "x-request-id": string;
    "x-session-id": string;
}

Body #

{
    "oauthUUID": string;
    "fileName": string;
    "fileSize": string;
}

oauthUUID #

OAuth Application UUID

• format: uuid-v4

fileName #

Logo file name

• maxLength: 128
• minLength: 3
• format: oauth-logo-suffix

fileSize #

Logo file size

• minimum: 1
• maximum: size

Response #

Success #

HTTP Status Code: 200

{
    status: Status.Success;
    data: {
        fileUUID: string;
        ossDomain: string;
        ossFilePath: string;
        policy: string;
        signature: string;
    }
}

Extends Type: Status

fileUUID #

UUID of the current document

ossDomain #

OSS domain

ossFilePath #

OSS file path

e.g. /test/x.png

policy #

OSS policy

Ref: Policy

signature #

OSS signature

Ref: Policy

Failed #

HTTP Status Code: 200

{
    status: Status.Failed,
    code: ErrorCode
}

Extends Type: Status, ErrorCode