Permission Set 이름 체크
    • PDF

    Permission Set 이름 체크

    • PDF

    기사 요약

    Classic/VPC 환경에서 이용 가능합니다.

    Permission Set 이름의 유효성 및 중복 여부를 체크합니다.

    요청

    요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

    메서드URI
    GET/api/v1/permission-sets/check-permission-set-name

    요청 헤더

    Ncloud Single Sign-On API에서 공통으로 사용하는 헤더에 대한 정보는 Ncloud Single Sign-On 요청 헤더를 참조해 주십시오.

    요청 쿼리 파라미터

    요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

    필드타입필수 여부설명
    permissionSetNameStringRequiredPermission Set 이름
    • 영문자, 숫자, 특수문자 '-', '_'를 조합하여 2~30자로 입력
    • 문자열의 시작은 영문자 또는 숫자로 구성

    요청 예시

    요청 예시는 다음과 같습니다.

    curl --location --request GET 'https://sso.apigw.gov-ntruss.com/api/v1/permission-sets/check-permission-set-name?permissionSetName=permissionset000' \
    --header 'x-ncp-apigw-timestamp: {Timestamp}' \
    --header 'x-ncp-iam-access-key: {Access Key}' \
    --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
    

    응답

    응답 형식을 설명합니다.

    응답 바디

    응답 바디에 대한 설명은 다음과 같습니다.

    필드타입필수 여부설명
    nameString-Permission Set 이름
    successBoolean-Permission Set 이름 체크 결과
    • true | false
      • true: 사용 가능 이름
      • false: 사용 불가능 이름
    messageString-사용 불가능 이유
    • successfalse인 경우, 표시

    응답 상태 코드

    Ncloud Single Sign-On API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud Single Sign-On 응답 상태 코드를 참조해 주십시오.

    응답 예시

    응답 예시는 다음과 같습니다.

    체크 결과 사용 가능 이름인 경우

    체크 결과 사용 가능 이름인 경우의 응답 예시는 다음과 같습니다.

    {
        "name": "permissionset000",
        "success": true
    }
    

    체크 결과 사용 불가능 이름인 경우

    체크 결과 사용 불가능 이름인 경우의 응답 예시는 다음과 같습니다.

    • Permission Set 이름이 이미 존재하는 경우

      {
          "name": "permissionset000",
          "success": false,
          "message": "Permission set 이름이 이미 있습니다."
      }
      
    • Permission Set 이름이 유효하지 않은 경우

      {
          "success": false,
          "message": "최소 2글자 이상, 최대 30글자 까지 입력할 수 있습니다."
      }
      

    이 문서가 도움이 되었습니까?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.