Applicationリストの照会

Classic/VPC環境で利用できます。

Applicationリストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/api/v1/applications

リクエストヘッダ

Ncloud Single Sign-On APIで共通して使用されるヘッダの詳細は、Ncloud Single Sign-Onのリクエストヘッダをご参照ください。

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`searchColumn`	String	Conditional	検索カラム `applicationId` \| `applicationName` `applicationId`: Application ID `applicationName`: Application名
`searchWord`	String	Optional	検索キーワード検索カラムのオプション(`applicationId`、`applicationName`)と全体または一部が一致しない値を入力した場合、レスポンス時に`items`は空の値の`[]`で表示 `searchColumn`なしでリクエストする場合、全リストを表示
`page`	Integer	Optional	ページ番号 0~N (デフォルト: 0)
`size`	Integer	Optional	ページの出力数 1~N (デフォルト: 20)

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://sso.apigw.ntruss.com/api/v1/applications?searchColumn=applicationName&searchWord=application&page=0&size=20' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`page`	Number	-	ページ番号
`totalPages`	Number	-	ページの総数
`totalItems`	Number	-	レスポンス結果数
`isFirst`	Boolean	-	最初のページかどうか `true` \| `false` `true`: 最初のページ `false`: 最初のページではない
`isLast`	Boolean	-	最後のページかどうか `true` \| `false` `true`: 最後のページ `false`: 最後のページではない
`hasPrevious`	Boolean	-	以前のページは存在するかどうか `true` \| `false` `true`: 存在する `false`: 存在しない
`hasNext`	Boolean	-	次のページは存在するかどうか `true` \| `false` `true`: 存在する `false`: 存在しない
`items`	Array	-	Applicationリスト

`items`

itemsの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`applicationId`	String	-	Application ID
`name`	String	-	Application名
`description`	String	-	Applicationの説明
`applicationUrl`	String	-	Application URL
`applicationType`	String	-	Applicationのタイプ `web` \| `app` `web`: ウェブ `app`: アプリ
`mbrLoginAllow`	String	-	メインアカウントでログインできるかどうか `ALLOW` \| `DENY` `ALLOW`: 許可 `DENY`: 拒否
`createdAt`	String	-	Applicationの作成日時 ISO 8601形式 OAuth 2.0
`updatedAt`	String	-	Applicationの更新日時 ISO 8601形式 OAuth 2.0
`clientId`	String	-	Application Client ID OAuth 2.0
`clientAuthMethod`	String	-	Applicationの認証方法 `client_secret_basic` \| `client_secret_post` \| `none` `client_secret_basic`: Client認証情報を HTTP Basic認証ヘッダで渡す `client_secret_post`: Client IDと Secretを POSTリクエスト本文に含める `none`: 認証しない OAuth 2.0
`redirectUris`	Array	-	Applicationリダイレクト URIリスト OAuth 2.0
`accessType`	String	-	Applicationアクセス方法 `confidential` \| `public` `confidential`: Client IDと Secretで認証してアクセス `public`: Client IDで認証してアクセス OAuth 2.0
`grantTypes`	Array	-	権限付与方法 `authorization_code` \| `refresh_token` \| `implicit` `authorization_code`: 独自作成した Authorization codeで Access Tokenを発行 `refresh_token`: Access Tokenの期限切れ後、再ログインせずに Access Tokenを新規発行 `implicit`: Authorization codeなしで直接 Access Tokenを発行。認証情報を安全に保存するのが困難な Client環境に最適化 OAuth 2.0
`scopes`	Array	-	Applicationのアクセス可能な情報の範囲 `profile` \| `openid` \| `groups` \| `email` `profile`: アカウント区分、ログイン ID、会員の固有 ID、ユーザー名 `openid`: アカウント区分、ログイン ID、会員の固有 ID、ユーザー名 `groups`: アカウント区分、ログイン ID、会員の固有 ID、ユーザー名、グループ `email`: アカウント区分、ログイン ID、会員の固有 ID、ユーザー名、メール OAuth 2.0
`accessTokenValidity`	Number	-	Access Tokenの有効期間(秒) OAuth 2.0
`refreshTokenValidity`	Number	-	Refresh Tokenの有効期間(秒) OAuth 2.0
`protocol`	String	-	Application認証プロトコル `OAUTH2`: OAuth 2.0 (有効値)

レスポンスステータスコード

Ncloud Single Sign-On APIで共通して使用されるレスポンスステータスコードの詳細は、Ncloud Single Sign-Onのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "page" : 0,
    "totalPages" : 1,
    "totalItems" : 1,
    "isFirst" : true,
    "isLast" : true,
    "hasPrevious" : false,
    "hasNext" : false,
    "items" : [
        {
            "applicationId" : "88d2009c-****-****-****-59bf9afd5695",
            "name" : "application000",
            "description" : "aplication000 description",
            "applicationUrl" : "http://****.com",
            "applicationType" : "web",
            "mbrLoginAllow" : "ALLOW",
            "createdAt" : "2025-01-17T05:09:54Z",
            "updatedAt" : "2025-01-17T05:09:54Z",
            "clientId" : "88d2009c-****-****-****-59bf9afd5695",
            "clientAuthMethod" : "client_secret_basic",
            "redirectUris" : [
                "http://****.com"
            ],
            "accessType" : "confidential",
            "grantTypes" : [
                "authorization_code",
                "refresh_token"
            ],
            "scopes" : [
                "profile"
            ],
            "accessTokenValidity" : 43200,
            "refreshTokenValidity" : 2592000,
            "protocol" : "OAUTH2"
        }
    ]
}