이 섹션의 다중 페이지 출력 화면임. 여기를 클릭하여 프린트.
Management
- 1: Cloud Control
- 1.1: APIs
- 1.1.1: AddBaselineAssignment
- 1.1.1.1: 1.0
- 1.1.2: CreateAccountFactoryAccount
- 1.1.2.1: 1.0
- 1.1.3: CreateLandingZone
- 1.1.3.1: 1.0
- 1.1.4: DeleteLandingZone
- 1.1.4.1: 1.0
- 1.1.5: DisableGuardrailBindings
- 1.1.5.1: 1.0
- 1.1.6: EnableGuardrailBindings
- 1.1.6.1: 1.0
- 1.1.7: ListBaselineAssignments
- 1.1.7.1: 1.0
- 1.1.8: ListGuardrails
- 1.1.8.1: 1.0
- 1.1.9: ListGuardrailsForTarget
- 1.1.9.1: 1.0
- 1.1.10: ListTargetsForGuardrail
- 1.1.10.1: 1.0
- 1.1.11: ShowGuardrail
- 1.1.11.1: 1.0
- 1.1.12: ShowLandingZone
- 1.1.12.1: 1.0
- 1.1.13: UpdateBaselineAssignment
- 1.1.13.1: 1.0
- 1.2: Models
- 1.2.1: AccountFactoryCreateRequest
- 1.2.2: AccountFactoryCreateResponse
- 1.2.3: AccountsForGuardrail
- 1.2.4: BaselineAssignment
- 1.2.5: BaselineAssignmentAddRequest
- 1.2.6: BaselineAssignmentAddResponse
- 1.2.7: BaselineAssignmentListResponse
- 1.2.8: BaselineAssignmentUpdateRequest
- 1.2.9: Guardrail
- 1.2.10: GuardrailAssignmentDetail
- 1.2.11: GuardrailAssignmentFailCaused
- 1.2.12: GuardrailAssignmentResponse
- 1.2.13: GuardrailBindingOu
- 1.2.14: GuardrailDisableRequest
- 1.2.15: GuardrailEnableRequest
- 1.2.16: GuardrailLinkInfo
- 1.2.17: GuardrailPageResponse
- 1.2.18: GuardrailsForTargetSummary
- 1.2.19: GuardrailShowResponse
- 1.2.20: GuardrailSummary
- 1.2.21: LandingZone
- 1.2.22: LandingZoneCreateRequest
- 1.2.23: LandingZoneCreateResponse
- 1.2.24: LandingZoneShowResponse
- 1.2.25: ListGuardrailsForTargetResponse
- 1.2.26: ListTargetsForGuardrailResponse
- 1.2.27: OrganizationUnitsForGuardrail
- 2: Cloud Monitoring
- 2.1: APIs
- 2.1.1: CreateEventPolicy
- 2.1.1.1: 1.0
- 2.1.2: DeleteEventPolicy
- 2.1.2.1: 1.0
- 2.1.3: ListAccountEvents
- 2.1.3.1: 1.0
- 2.1.4: ListAccountMember
- 2.1.4.1: 1.0
- 2.1.5: ListAccountResources
- 2.1.5.1: 1.0
- 2.1.6: ListAddressBookMembers
- 2.1.6.1: 1.0
- 2.1.7: ListAddressBooks
- 2.1.7.1: 1.0
- 2.1.8: ListEventPolicies
- 2.1.8.1: 1.0
- 2.1.9: ListEventPolicyHistories
- 2.1.9.1: 1.0
- 2.1.10: ListEventPolicyNotification
- 2.1.10.1: 1.0
- 2.1.11: ListMetricPefData
- 2.1.11.1: 1.0
- 2.1.12: ListMetrics
- 2.1.12.1: 1.0
- 2.1.13: ListResourceEvents
- 2.1.13.1: 1.0
- 2.1.14: ListService
- 2.1.14.1: 1.0
- 2.1.15: SetEventPolicy
- 2.1.15.1: 1.0
- 2.1.16: ShowEventNotificationStates
- 2.1.16.1: 1.0
- 2.1.17: ShowEventPolicy
- 2.1.17.1: 1.0
- 2.1.18: ShowResourceEvent
- 2.1.18.1: 1.0
- 2.2: Models
- 2.2.1: AccountProductDto
- 2.2.2: AddrbookAdditionalInfo
- 2.2.3: AlarmAddrBookDto
- 2.2.4: AlarmAddrBookMemberDto
- 2.2.5: EventDetailResponse
- 2.2.6: EventNotificationResponse
- 2.2.7: EventPolicyCreateRequest
- 2.2.8: EventPolicyDetailResponse
- 2.2.9: EventPolicyHistoryResponse
- 2.2.10: EventPolicyInfo
- 2.2.11: EventPolicyInfoEditable
- 2.2.12: EventPolicyResponse
- 2.2.13: EventPolicyStatistics
- 2.2.14: EventPolicyUpdateRequest
- 2.2.15: EventThreshold
- 2.2.16: GroupSummary
- 2.2.17: ListResponseMetricStatisticsDataDtoOpenAPIV2
- 2.2.18: Member
- 2.2.19: MetricDataConditionOpenAPIV2
- 2.2.20: MetricDataSearchCriteriaOpenAPIV2
- 2.2.21: MetricInfoDto
- 2.2.22: MetricStatisticsDataDtoOpenAPIV2
- 2.2.23: MetricSummary
- 2.2.24: NotificationMethod
- 2.2.25: NotificationRecipient
- 2.2.26: NotificationRecipientHistory
- 2.2.27: NotificationResponse
- 2.2.28: NotificationStatus
- 2.2.29: OpenApiEventResponse
- 2.2.30: PageResponseAccountProductDto
- 2.2.31: PageResponseAlarmAddrBookDto
- 2.2.32: PageResponseAlarmAddrBookMemberDto
- 2.2.33: PageResponseEventNotificationResponse
- 2.2.34: PageResponseEventPolicyHistoryResponse
- 2.2.35: PageResponseEventPolicyResponse
- 2.2.36: PageResponseJsonArrayProjectMemberResponseForOpenAPI
- 2.2.37: PageResponseMetricInfoDto
- 2.2.38: PageResponseNotificationResponse
- 2.2.39: PageResponseOpenApiEventResponse
- 2.2.40: PageResponseProductTypeInfoDto
- 2.2.41: ProductInfoAttr
- 2.2.42: ProductList
- 2.2.43: ProductResourceInfo
- 2.2.44: ProductSummary
- 2.2.45: ProductTypeInfoDto
- 2.2.46: ProjectMemberResponseForOpenAPI
- 2.2.47: RangeThreshold
- 2.2.48: SingleThreshold
- 3: IAM
- 3.1: APIs
- 3.1.1: Add a permission into the resource based policy
- 3.1.2: Add a user to a group
- 3.1.3: Assign policies to the group
- 3.1.4: Assign policies to user
- 3.1.5: Attach policies to Role
- 3.1.6: Create a group
- 3.1.7: Create a policy
- 3.1.8: Create a saml provider
- 3.1.9: Create an access key
- 3.1.10: Create IAM user
- 3.1.11: Create role
- 3.1.12: Delete bulk role
- 3.1.13: Delete IAM user
- 3.1.14: Delete IAM users
- 3.1.15: Delete role
- 3.1.16: Delete the policy
- 3.1.17: Delete the resource based policy
- 3.1.18: Delete user policy
- 3.1.19: Detach policies to Role
- 3.1.20: Detach policy to Role
- 3.1.21: Get a Group
- 3.1.22: Get a specific policy binding list
- 3.1.23: Get an access key
- 3.1.24: Get endpoint list
- 3.1.25: Get IAM users
- 3.1.26: Get policy list
- 3.1.27: Get role
- 3.1.28: Get role list
- 3.1.29: Get Role Policy-Binding list
- 3.1.30: Get saml provider information
- 3.1.31: Get service account
- 3.1.32: Get user policy-binding list
- 3.1.33: Group Member list
- 3.1.34: List access keys
- 3.1.35: List Groups
- 3.1.36: List IAM users
- 3.1.37: List saml providers
- 3.1.38: List service accounts
- 3.1.39: Modify a Group
- 3.1.40: Query policy list
- 3.1.41: Remove a permission into the resource based policy
- 3.1.42: Remove a User from a Group
- 3.1.43: Remove policies
- 3.1.44: Remove policy assignment from group
- 3.1.45: Remove saml providers
- 3.1.46: Remove the access key
- 3.1.47: Remove the access keys
- 3.1.48: Remove the Group
- 3.1.49: Send Temporary Access Key OTP
- 3.1.50: Set a permission into the resource based policy
- 3.1.51: Set an access key
- 3.1.52: Set role
- 3.1.53: Set role trust policy
- 3.1.54: Set the policy
- 3.1.55: Set the policy group binding
- 3.1.56: Set the resource based policy
- 3.1.57: Show group policy
- 3.1.58: Show the policy
- 3.1.59: Show the resource based policy
- 3.1.60: Update IAM user
- 3.1.61: Update IAM user password
- 3.1.62: Update saml provider information
- 3.2: Models
- 3.2.1: AccessKey
- 3.2.2: AccessKeyCreateRequest
- 3.2.3: AccessKeyOtpRequest
- 3.2.4: AccessKeyResponse
- 3.2.5: AccessKeyUpdateRequest
- 3.2.6: CreatedGroupMember
- 3.2.7: EndpointsResponse
- 3.2.8: Group
- 3.2.9: GroupCreateRequest
- 3.2.10: GroupMember
- 3.2.11: GroupMemberCreateRequest
- 3.2.12: GroupMemberCreateResponse
- 3.2.13: GroupMemberPageResponse
- 3.2.14: GroupPageResponse
- 3.2.15: GroupPolicyBindingRequest
- 3.2.16: GroupPolicyPageResponse
- 3.2.17: GroupPolicyResponse
- 3.2.18: GroupSetRequest
- 3.2.19: GroupShowResponse
- 3.2.20: IAMCreateUserResponse
- 3.2.21: IamPolicyDocument
- 3.2.22: IAMUserCreateRequest
- 3.2.23: IAMUserDeleteRequest
- 3.2.24: IAMUserDetailResponse
- 3.2.25: IAMUserPasswordUpdateRequest
- 3.2.26: IAMUserResponse
- 3.2.27: IAMUserUpdateRequest
- 3.2.28: ListAccessKeyRemoveRequest
- 3.2.29: ListAccessKeyResponse
- 3.2.30: ListEndpointsResponse
- 3.2.31: ListIAMUserResponse
- 3.2.32: ListPolicyRemoveRequest
- 3.2.33: ListSamlProviderRemoveRequest
- 3.2.34: ListSamlProviderResponse
- 3.2.35: Policy
- 3.2.36: PolicyBindingPageResponse
- 3.2.37: PolicyBindingSetRequest
- 3.2.38: PolicyCreateRequest
- 3.2.39: PolicyDocument
- 3.2.40: PolicyPageResponse
- 3.2.41: PolicyQueryRequest
- 3.2.42: PolicySetRequest
- 3.2.43: PolicyShowResponse
- 3.2.44: PolicyVersion
- 3.2.45: PolicyVersionCreateRequest
- 3.2.46: ResourcePolicySetRequest
- 3.2.47: ResourcePolicyShowResponse
- 3.2.48: ResourcePolicyVersion
- 3.2.49: ResourcePolicyVersionCreateRequest
- 3.2.50: Role
- 3.2.51: RoleBulkDeleteRequest
- 3.2.52: RoleCreateRequest
- 3.2.53: RolePageResponse
- 3.2.54: RolePolicyBindingPageResponse
- 3.2.55: RolePolicyBindingRequest
- 3.2.56: RolePolicyBindingResponse
- 3.2.57: RoleSetRequest
- 3.2.58: RoleShowResponse
- 3.2.59: RoleTrustPolicyPrincipal
- 3.2.60: RoleTrustPolicyRequest
- 3.2.61: RoleTrustPolicyShowResponse
- 3.2.62: SamlProviderCreateRequest
- 3.2.63: SamlProviderCreateResponse
- 3.2.64: SamlProviderDetailResponse
- 3.2.65: SamlProviderResponse
- 3.2.66: SamlProviderUpdateRequestData
- 3.2.67: ServiceAccount
- 3.2.68: ServiceAccountDetail
- 3.2.69: ServiceAccountListResponse
- 3.2.70: ServiceAccountShowResponse
- 3.2.71: Statement
- 3.2.72: StatementCreateRequest
- 3.2.73: StatementResponse
- 3.2.74: UserPolicyPageResponse
- 3.2.75: UserPolicyRequest
- 3.2.76: UserPolicyResponse
- 3.2.77: UserResponse
- 4: ID Center
- 4.1: APIs
- 4.1.1: CreateAccountAssignment
- 4.1.2: CreateBulkGroupUsers
- 4.1.3: CreateGroup
- 4.1.4: CreateInstance
- 4.1.5: CreatePermissionSet
- 4.1.6: CreateUser
- 4.1.7: DeleteAccountAssignment
- 4.1.8: DeleteBulkAccountAssignment
- 4.1.9: DeleteBulkGroups
- 4.1.10: DeleteBulkGroupUsers
- 4.1.11: DeleteBulkUsers
- 4.1.12: DeleteGroup
- 4.1.13: DeleteInstance
- 4.1.14: DeletePermissionSet
- 4.1.15: DeletePermissionSetPolicies
- 4.1.16: DeleteUser
- 4.1.17: ListAccountAssignments
- 4.1.18: ListGroups
- 4.1.19: ListGroupUsers
- 4.1.20: ListInstances
- 4.1.21: ListPermissionSetPolicies
- 4.1.22: ListPermissionSets
- 4.1.23: ListUsers
- 4.1.24: SetGroup
- 4.1.25: SetInstance
- 4.1.26: SetPermissionSet
- 4.1.27: SetPermissionSetPolicies
- 4.1.28: SetUser
- 4.1.29: ShowGroup
- 4.1.30: ShowInstance
- 4.1.31: ShowPermissionSet
- 4.1.32: ShowUser
- 4.2: Models
- 4.2.1: Account
- 4.2.2: AccountAssignment
- 4.2.3: AccountAssignmentDeleteRequest
- 4.2.4: AccountAssignmentsCreateRequest
- 4.2.5: AccountAssignmentsCreateRequestV1Dot2
- 4.2.6: AccountAssignmentsCreateResponse
- 4.2.7: AccountAssignmentsCreateResponseV1Dot2
- 4.2.8: AccountAssignmentsDeleteRequest
- 4.2.9: AccountAssignmentsPageResponse
- 4.2.10: AccountAssignmentSummaryModel
- 4.2.11: AssignmentPermissionSet
- 4.2.12: Group
- 4.2.13: GroupCreateRequest
- 4.2.14: GroupDeleteBulkRequest
- 4.2.15: GroupDetail
- 4.2.16: GroupPageResponse
- 4.2.17: GroupRemoveResponse
- 4.2.18: GroupSetRequest
- 4.2.19: GroupSetResponse
- 4.2.20: GroupShowResponse
- 4.2.21: GroupSummary
- 4.2.22: GroupUser
- 4.2.23: GroupUsersPageResponse
- 4.2.24: GroupUsersRequest
- 4.2.25: Instance
- 4.2.26: InstanceBaseRequest
- 4.2.27: InstanceCreateRequest
- 4.2.28: InstanceDetailAddResourceV1Dot1
- 4.2.29: InstanceDetailV1Dot1
- 4.2.30: InstancePageResponse
- 4.2.31: InstanceSetRequest1Dot1
- 4.2.32: InstanceShowResponseAddResourceV1Dot1
- 4.2.33: InstanceShowResponseV1Dot1
- 4.2.34: LdapConfig
- 4.2.35: LdapConfigCreateRequest
- 4.2.36: ManagedPolicy
- 4.2.37: PermissionSetCreateRequest
- 4.2.38: PermissionSetCreateRequestV1Dot2
- 4.2.39: PermissionSetDetails
- 4.2.40: PermissionSetDetailsPageResponseV1Dot2
- 4.2.41: PermissionSetDetailsV1Dot2
- 4.2.42: PermissionSetInfo
- 4.2.43: PermissionSetInfoV1Dot2
- 4.2.44: PermissionSetPoliciesDeleteRequest
- 4.2.45: PermissionSetPoliciesPageResponse
- 4.2.46: PermissionSetPoliciesPageResponseV1Dot2
- 4.2.47: PermissionSetPoliciesSetRequest
- 4.2.48: PermissionSetPoliciesSetRequestV1Dot2
- 4.2.49: PermissionSets
- 4.2.50: PermissionSetSetRequest
- 4.2.51: PermissionSetsPageResponse
- 4.2.52: Policy
- 4.2.53: PolicyV1Dot2
- 4.2.54: Principal
- 4.2.55: RemoveFailCaused
- 4.2.56: RemoveSuccess
- 4.2.57: ShowPermissionSetAddResource
- 4.2.58: ShowPermissionSetAddResourceV1Dot2
- 4.2.59: User
- 4.2.60: UserCreateRequest
- 4.2.61: UserDeleteBulkRequest
- 4.2.62: UserDetail
- 4.2.63: UserPageResponse
- 4.2.64: UserRemoveResponse
- 4.2.65: UserResponse
- 4.2.66: UserSetRequest
- 5: Logging&Audit
- 5.1: APIs
- 5.1.1: CreateTrail
- 5.1.2: DeleteTrail
- 5.1.3: DownloadLogs
- 5.1.4: ListLogs
- 5.1.5: ListTrails
- 5.1.6: SetTrail
- 5.1.7: ShowLog
- 5.1.8: ShowTrail
- 5.1.9: StartTrail
- 5.1.10: StopTrail
- 5.2: Models
- 5.2.1: Log
- 5.2.2: LogDetails
- 5.2.3: LogDownloadDetailResponse
- 5.2.4: LogDownloadRequest
- 5.2.5: LogDownloadResponse
- 5.2.6: LogListResponse
- 5.2.7: LogShowResponse
- 5.2.8: Trail
- 5.2.9: Trail1dot1
- 5.2.10: TrailCreateRequest
- 5.2.11: TrailCreateRequestV1dot1
- 5.2.12: TrailListResponse
- 5.2.13: TrailListResponseV1dot1
- 5.2.14: TrailSetRequest
- 5.2.15: TrailSetRequestV1dot1
- 5.2.16: TrailShowResponse
- 5.2.17: TrailShowResponseV1dot1
- 6: Network Logging
- 6.1: APIs
- 6.1.1: Create Network Logging Storage
- 6.1.1.1: 1.0
- 6.1.2: Delete Network Logging Storage
- 6.1.2.1: 1.0
- 6.1.3: List Network Logging Configurations
- 6.1.3.1: 1.0
- 6.1.4: List Network Logging Storages
- 6.1.4.1: 1.0
- 6.2: Models
- 7: Organization
- 7.1: APIs
- 7.1.1: AcceptInvitation
- 7.1.2: AttachPolicyBindings
- 7.1.3: CancelInvitations
- 7.1.4: CreateAccount
- 7.1.5: CreateDelegationPolicy
- 7.1.6: CreateInvitation
- 7.1.7: CreateOrganization
- 7.1.8: CreateOrganizationUnit
- 7.1.9: CreateServiceControlPolicy
- 7.1.10: DeclineInvitation
- 7.1.11: DeleteDelegationPolicy
- 7.1.12: DeleteOrganization
- 7.1.13: DeleteOrganizationUnits
- 7.1.14: DeleteServiceControlPolicies
- 7.1.15: LeaveOrganization
- 7.1.16: ListAccountInvitations
- 7.1.17: ListAccounts
- 7.1.18: ListOrganizationInvitations
- 7.1.19: ListOrganizations
- 7.1.20: ListOrganizationUnits
- 7.1.21: ListParents
- 7.1.22: ListPoliciesForTarget
- 7.1.23: ListServiceControlPolicies
- 7.1.24: ListTargetsForPolicy
- 7.1.25: MoveAccount
- 7.1.26: RemoveAccounts
- 7.1.27: RemovePolicyBindings
- 7.1.28: SetDelegationPolicy
- 7.1.29: SetOrganization
- 7.1.30: SetOrganizationUnit
- 7.1.31: SetServiceControlPolicy
- 7.1.32: ShowAccount
- 7.1.33: ShowDelegationPolicy
- 7.1.34: ShowOrganization
- 7.1.35: ShowOrganizationUnit
- 7.1.36: ShowServiceControlPolicy
- 7.2: Models
- 7.2.1: AccountCreateResponse
- 7.2.2: AccountInvitation
- 7.2.3: AccountInvitationResponse
- 7.2.4: AccountMoveResponse
- 7.2.5: AccountPageResponse
- 7.2.6: AccountRemoveResponse
- 7.2.7: AccountShowResponse
- 7.2.8: AccountSummary
- 7.2.9: BindingTarget
- 7.2.10: CombinedUnit
- 7.2.11: CombinedUnitV1dot1
- 7.2.12: ConnectedPolicySummary
- 7.2.13: ControlPolicyAssignmentFailCaused
- 7.2.14: ControlPolicyAssignmentResponse
- 7.2.15: CreateAccountFailCaused
- 7.2.16: CreateAccountSuccess
- 7.2.17: DelegationPolicy
- 7.2.18: DelegationPolicyCreateRequest
- 7.2.19: DelegationPolicyDocument
- 7.2.20: DelegationPolicySetRequest
- 7.2.21: DelegationPolicyShowResponse
- 7.2.22: DelegationPolicyStatement
- 7.2.23: Invitation
- 7.2.24: InvitationAcceptFailCaused
- 7.2.25: InvitationAcceptResponse
- 7.2.26: InvitationAcceptSuccess
- 7.2.27: InvitationCancelRequest
- 7.2.28: InvitationCancelResponse
- 7.2.29: InvitationCreateFailCaused
- 7.2.30: InvitationCreateRequest
- 7.2.31: InvitationCreateResponse
- 7.2.32: InvitationShowResponse
- 7.2.33: ListPoliciesForTargetResponse
- 7.2.34: ListTargetsForPolicyResponse
- 7.2.35: MoveAccountRequest
- 7.2.36: MoveAccountSuccess
- 7.2.37: Organization
- 7.2.38: OrganizationAccountWithPolicy
- 7.2.39: OrganizationCreateRequest
- 7.2.40: OrganizationDeleteFailCaused
- 7.2.41: OrganizationDeleteResponse
- 7.2.42: OrganizationInvitation
- 7.2.43: OrganizationInvitationPageResponse
- 7.2.44: OrganizationLeaveFailCaused
- 7.2.45: OrganizationLeaveResponse
- 7.2.46: OrganizationLeaveSuccess
- 7.2.47: OrganizationPageResponse
- 7.2.48: OrganizationSetRequest
- 7.2.49: OrganizationShowResponse
- 7.2.50: OrganizationSummary
- 7.2.51: OrganizationUnit
- 7.2.52: OrganizationUnitCreateRequest
- 7.2.53: OrganizationUnitCreateResponse
- 7.2.54: OrganizationUnitDeleteFailCaused
- 7.2.55: OrganizationUnitDeleteRequest
- 7.2.56: OrganizationUnitDeleteResponse
- 7.2.57: OrganizationUnitListResponse
- 7.2.58: OrganizationUnitListResponseV1dot1
- 7.2.59: OrganizationUnitParentsResponse
- 7.2.60: OrganizationUnitSetRequest
- 7.2.61: OrganizationUnitShowResponse
- 7.2.62: OrganizationUnitWithPolicy
- 7.2.63: OrganizationUserCreateRequest
- 7.2.64: PoliciesForTargetSummary
- 7.2.65: PolicyAttachRequest
- 7.2.66: PolicyLinkInfo
- 7.2.67: PolicyRemoveRequest
- 7.2.68: RemoveAccountFailCaused
- 7.2.69: RemoveAccountsRequest
- 7.2.70: RemoveAccountSuccess
- 7.2.71: ServiceControlPolicy
- 7.2.72: ServiceControlPolicyCreateRequest
- 7.2.73: ServiceControlPolicyDeleteFailCaused
- 7.2.74: ServiceControlPolicyDeleteRequest
- 7.2.75: ServiceControlPolicyDeleteResponse
- 7.2.76: ServiceControlPolicyDocument
- 7.2.77: ServiceControlPolicyPageResponse
- 7.2.78: ServiceControlPolicySetRequest
- 7.2.79: ServiceControlPolicyShowResponse
- 7.2.80: ServiceControlPolicyStatement
- 7.2.81: ServiceControlPolicySummary
- 7.2.82: TargetsForPolicySummary
- 8: Quota Service
- 8.1: APIs
- 8.1.1: ListAccountQuota
- 8.1.2: ListQuotaRequests
- 8.1.3: ShowAccountQuota
- 8.1.4: ShowQuotaRequest
- 8.2: Models
- 8.2.1: AccountQuota
- 8.2.2: AccountQuota1dot1
- 8.2.3: AccountQuotaListResponse
- 8.2.4: AccountQuotaListResponseV1dot1
- 8.2.5: AccountQuotaShowResponse
- 8.2.6: AccountQuotaShowResponseV1dot1
- 8.2.7: QuotaRequest
- 8.2.8: QuotaRequestDetail
- 8.2.9: QuotaRequestListResponse
- 8.2.10: QuotaRequestShowResponse
- 9: Resource Manager
- 9.1: APIs
- 9.1.1: CreateResourceGroup
- 9.1.1.1: 1.0
- 9.1.2: DeleteComponentsTag
- 9.1.2.1: 1.0
- 9.1.3: DeleteComponentsTags
- 9.1.3.1: 1.0
- 9.1.4: DeleteResourceGroup
- 9.1.4.1: 1.0
- 9.1.5: DeleteResourceGroups
- 9.1.5.1: 1.0
- 9.1.6: DeleteResourceTag
- 9.1.6.1: 1.0
- 9.1.7: DeleteResourceTags
- 9.1.7.1: 1.0
- 9.1.8: DeleteTags
- 9.1.8.1: 1.0
- 9.1.9: ListComponentsTags
- 9.1.9.1: 1.0
- 9.1.10: ListResourceGroupResources
- 9.1.10.1: 1.0
- 9.1.11: ListResourceGroups
- 9.1.11.1: 1.0
- 9.1.12: ListResources
- 9.1.12.1: 1.0
- 9.1.13: ListResourceTags
- 9.1.13.1: 1.0
- 9.1.14: ListTagKeys
- 9.1.14.1: 1.0
- 9.1.15: ListTags
- 9.1.15.1: 1.0
- 9.1.16: ListTagValues
- 9.1.16.1: 1.0
- 9.1.17: SetResourceGroup
- 9.1.17.1: 1.0
- 9.1.18: ShowComponentsTag
- 9.1.18.1: 1.0
- 9.1.19: ShowResource
- 9.1.19.1: 1.0
- 9.1.20: ShowResourceByComponents
- 9.1.20.1: 1.0
- 9.1.21: ShowResourceGroup
- 9.1.21.1: 1.0
- 9.1.22: ShowResourceTag
- 9.1.22.1: 1.0
- 9.1.23: UpdateComponentsTags
- 9.1.23.1: 1.0
- 9.1.24: UpdateComponentsTagValue
- 9.1.24.1: 1.0
- 9.1.25: UpdateResourceTags
- 9.1.25.1: 1.0
- 9.1.26: UpdateResourceTagValue
- 9.1.26.1: 1.0
- 9.1.27: UpdateTags
- 9.1.27.1: 1.0
- 9.2: Models
- 9.2.1: CreateResourceGroup
- 9.2.2: Resource
- 9.2.3: ResourceGroup
- 9.2.4: ResourceGroupCreateRequest
- 9.2.5: ResourceGroupCreateResponse
- 9.2.6: ResourceGroupPageResponse
- 9.2.7: ResourceGroupsDeleteRequest
- 9.2.8: ResourceGroupShowResponse
- 9.2.9: ResourceGroupUpdateRequest
- 9.2.10: ResourcePageResponse
- 9.2.11: ResourceShowResponse
- 9.2.12: SrnKeyValue
- 9.2.13: SrnTag
- 9.2.14: SrnTagList
- 9.2.15: Tag
- 9.2.16: TagBaseResponse
- 9.2.17: TagDeleteRequest
- 9.2.18: TagKeyResponse
- 9.2.19: TagListResponse
- 9.2.20: TagSetRequest
- 9.2.21: TagShowListResponse
- 9.2.22: TagShowResponse
- 9.2.23: TagsSetRequest
- 9.2.24: TagValue
- 9.2.25: TagValueResponse
- 10: ServiceWatch
- 10.1: APIs
- 10.1.1: CreateCustomLogEvents
- 10.1.1.1: 1.1
- 10.1.2: CreateCustomLogStream
- 10.1.2.1: 1.1
- 10.1.3: CreateCustomMetricMetas
- 10.1.3.1: 1.1
- 10.1.4: CreateCustomMetrics
- 10.1.4.1: 1.1
- 10.1.5: CreateDashboard
- 10.1.6: DeleteBulkDashboards
- 10.1.7: DownloadMetricDataImage
- 10.1.8: ListDashboards
- 10.1.9: ListMetricData
- 10.1.10: ListMetricInfos
- 10.1.11: SetDashboard
- 10.1.12: ShowAgentDownloadLink
- 10.1.12.1: 1.1
- 10.1.13: ShowDashboard
- 10.2: Models
- 10.2.1: AgentDownloadLinkResponse
- 10.2.2: AlertPropertiesDTO
- 10.2.3: AlertsObjectDTO
- 10.2.4: AlertSummaryDTO
- 10.2.5: CustomLogAttributeDTO
- 10.2.6: CustomLogEventsCreateRequest
- 10.2.7: CustomLogEventsCreateResponse
- 10.2.8: CustomLogRecordDTO
- 10.2.9: CustomLogResourceDTO
- 10.2.10: CustomLogValueDTO
- 10.2.11: CustomResourceLogDTO
- 10.2.12: CustomScopeLogDTO
- 10.2.13: DashboardAlertWidgetDTO
- 10.2.14: DashboardBulkDeleteRequest
- 10.2.15: DashboardBulkDeleteResponse
- 10.2.16: DashboardCreationRequest
- 10.2.17: DashboardDetailResponse
- 10.2.18: DashboardDetailResponseV1Dot1
- 10.2.19: DashboardDTO
- 10.2.20: DashboardPageResponse
- 10.2.21: DashboardUpdateRequest
- 10.2.22: DimensionDTO
- 10.2.23: IndividualItemDTO
- 10.2.24: LogGroupsLogStreamsCollectCustomRequest
- 10.2.25: LogGroupsLogStreamsCollectCustomResponse
- 10.2.26: MetricAlert
- 10.2.27: MetricAlertDto
- 10.2.28: MetricAlertsDTO
- 10.2.29: MetricCustomMetaRequest
- 10.2.30: MetricCustomMetaResponse
- 10.2.31: MetricCustomRequest
- 10.2.32: MetricDataImageDto
- 10.2.33: MetricDataImageDtoV1Dot1
- 10.2.34: MetricDataImageRequest
- 10.2.35: MetricDataImageRequestV1Dot1
- 10.2.36: MetricDataRequest
- 10.2.37: MetricDataRequestV1Dot1
- 10.2.38: MetricDataResponse
- 10.2.39: MetricDataResponseDto
- 10.2.40: MetricDetailDto
- 10.2.41: MetricDetailDtoV1Dot1
- 10.2.42: MetricDimensionDto
- 10.2.43: MetricDimensionDtoV1Dot1
- 10.2.44: MetricDTO
- 10.2.45: MetricDtoV1Dot1
- 10.2.46: MetricLabelDto
- 10.2.47: MetricLabelNameDto
- 10.2.48: MetricListDto
- 10.2.49: MetricListDtoV1Dot1
- 10.2.50: MetricMetaDto
- 10.2.51: MetricNamespaceDto
- 10.2.52: MetricNamespaceDtoV1Dot1
- 10.2.53: MetricSearchRequest
- 10.2.54: MetricSearchRequestV1Dot1
- 10.2.55: MetricsMetricColumnDto
- 10.2.56: MetricsResponse
- 10.2.57: MetricsResponseV1Dot1
- 10.2.58: OtlpAttributeDto
- 10.2.59: OtlpAttributeValueDto
- 10.2.60: OtlpGaugeDto
- 10.2.61: OtlpMetricDto
- 10.2.62: OtlpNumberDataPointDto
- 10.2.63: OtlpResourceDto
- 10.2.64: OtlpResourceMetricDto
- 10.2.65: OtlpScopeDto
- 10.2.66: OtlpScopeMetricDto
- 10.2.67: OtlpSumDto
- 10.2.68: PropertiesDTO
- 10.2.69: PropertiesDtoV1Dot1
- 10.2.70: SearchOptionNamespaceDto
- 10.2.71: SearchOptionNamespaceDtoV1Dot1
- 10.2.72: TagDTO
- 10.2.73: UnitLogDto
- 10.2.74: WidgetDetailDTO
- 10.2.75: WidgetDetailDtoV1Dot1
- 10.2.76: WidgetDTO
- 11: Support
- 11.1: APIs
- 11.1.1: Get Inquiry List
- 11.1.1.1: 1.0
- 11.1.2: Get Service Request List
- 11.1.2.1: 1.0
- 11.1.3: Show Inquiry
- 11.1.3.1: 1.0
- 11.1.4: Show Service Request
- 11.1.4.1: 1.0
- 11.2: Models
- 11.2.1: FileResponse
- 11.2.2: Inquiry
- 11.2.3: InquiryListResponse
- 11.2.4: InquiryShowResponse
- 11.2.5: ServiceRequest
- 11.2.6: ServiceRequestListResponse
1 - Cloud Control
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.
본 가이드는 CloudControl 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
OpenAPI URL
https://cloudcontrol.{environment}.samsungsdscloud.com
Environment and Region List
| environment | region |
|---|---|
| s | kr-west1 |
| s | kr-east1 |
| g | kr-south1 |
| g | kr-south2 |
| g | kr-south3 |
| e | kr-west1 |
| e | kr-east1 |
1.1 - APIs
1.1.1 - AddBaselineAssignment
1.1.1.1 - 1.0
post /v1/baseline-assignments/{assignment_id}
Description
add a new baseline assignment
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | assignment_id required | 루트/조직 단위/계정 ID Example : ou-b30e9fcc39f84a20bf9e7458e5ec3801 | string | None |
| body | body required | BaselineAssignmentAddRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | BaselineAssignmentAddResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/baseline-assignments/{assignment_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudcontrol 1.0"
Request body
{
"agree_yn": "Y",
"landing_zone_id": "2c8a138f8d78e1fc29a449dbfa8681",
"parent_unit_id": "ou-fc8c29a138d78e24bf1fa86812fc8b",
"resource_type": "OU",
"sso_user_name": "testuser",
"sso_user_real_name": "test user"
}
Example HTTP response
Response 201
{
"job_id": "0a36e0746dbf4908acf0357829701381",
"resource_id": "ou-b30e9fcc39f84a20bf9e7458e5ec3801",
"resource_type": "OU"
}
1.1.2 - CreateAccountFactoryAccount
1.1.2.1 - 1.0
post /v1/accounts
Description
create an account using account factory.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | AccountFactoryCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | AccountFactoryCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/accounts
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudcontrol 1.0"
Request body
{
"email": "myaccount@example.com",
"landing_zone_id": "2c8a138f8d78e1fc29a449dbfa8681",
"name": "foo-account",
"parent_unit_id": "ou-b30e9fcc39f84a20bf9e7458e5ec3801",
"sso_user_email": "user_email@example.com",
"sso_user_name": "John Doe",
"sso_user_real_name": "John Doe"
}
Example HTTP response
Response 201
{
"account_id": "b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0",
"job_id": "0a36e0746dbf4908acf0357829701381"
}
1.1.3 - CreateLandingZone
1.1.3.1 - 1.0
post /v1/landing-zones
Description
Create a landing zone
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | LandingZoneCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | LandingZoneCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/landing-zones
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudcontrol 1.0"
Request body
{
"additional_ou_name": "Sandbox",
"agree_yn": "Y",
"audit_account_name": "AUDIT",
"audit_login_id": "audit@samsung.com",
"basic_ou_name": "Security",
"log_archive_account_name": "LOG_ARCHIVE",
"log_archive_login_id": "log-archive@samsung.com",
"sso_type": "ID_CENTER"
}
Example HTTP response
Response 201
{
"job_id": "0a36e0746dbf4908acf0357829701381",
"landing_zone_id": "2c8a138f8d78e1fc29a449dbfa8681"
}
1.1.4 - DeleteLandingZone
1.1.4.1 - 1.0
delete /v1/landing-zones/{landing_zone_id}
Description
Delete a landing zone
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | landing_zone_id required | 랜딩 존 ID Example : 2c8a138f8d78e1fc29a449dbfa8681 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | LandingZoneCreateResponse |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/landing-zones/{landing_zone_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudcontrol 1.0"
Example HTTP response
Response 200
{
"job_id": "0a36e0746dbf4908acf0357829701381",
"landing_zone_id": "2c8a138f8d78e1fc29a449dbfa8681"
}
1.1.5 - DisableGuardrailBindings
1.1.5.1 - 1.0
delete /v1/guardrail-bindings
Description
disable guardrail bindings
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | GuardrailDisableRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GuardrailAssignmentResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/guardrail-bindings
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudcontrol 1.0"
Request body
{
"guardrail_ids": [
"f98e76d54c32b10a9z8y7x6w5v4u3"
],
"landing_zone_id": "2c8a138f8d78e1fc29a449dbfa8681",
"unit_ids": [
"ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5"
]
}
Example HTTP response
Response 200
{
"failed_ids": [
{
"error_code": "CloudControl.AlreadyEnabledGuardrails",
"failed_caused": "guardrail already enabled",
"guardrail_id": "f98e76d54c32b10a9z8y7x6w5v4u3",
"unit_id": "ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5"
}
],
"success_ids": [
{
"guardrail_id": "f98e76d54c32b10a9z8y7x6w5v4u3",
"unit_id": "ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5"
}
]
}
1.1.6 - EnableGuardrailBindings
1.1.6.1 - 1.0
post /v1/guardrail-bindings
Description
enable guardrail bindings
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | GuardrailEnableRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GuardrailAssignmentResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/guardrail-bindings
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudcontrol 1.0"
Request body
{
"guardrail_ids": [
"f98e76d54c32b10a9z8y7x6w5v4u3"
],
"landing_zone_id": "2c8a138f8d78e1fc29a449dbfa8681",
"unit_ids": [
"ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5"
]
}
Example HTTP response
Response 200
{
"failed_ids": [
{
"error_code": "CloudControl.AlreadyEnabledGuardrails",
"failed_caused": "guardrail already enabled",
"guardrail_id": "f98e76d54c32b10a9z8y7x6w5v4u3",
"unit_id": "ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5"
}
],
"success_ids": [
{
"guardrail_id": "f98e76d54c32b10a9z8y7x6w5v4u3",
"unit_id": "ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5"
}
]
}
1.1.7 - ListBaselineAssignments
1.1.7.1 - 1.0
get /v1/baseline-assignments
Description
get baseline assignment list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | landing_zone_id optional | 랜딩 존 ID Example : 2c8a138f8d78e1fc29a449dbfa8681 | any of [string, null] | None |
| query | resource_type optional | OU/ACCOUNT Example : OU | any of [enum (OU, ACCOUNT), null] | None |
| query | assignment_id optional | 루트/조직 단위/계정 ID Example : ou-b30e9fcc39f84a20bf9e7458e5ec3801 | any of [string, null] | None |
| query | status optional | 상태 Example : REGISTRATION_FAILED | any of [enum (REGISTERED, REGISTRATION_FAILED, REGISTERING), null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BaselineAssignmentListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/baseline-assignments
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudcontrol 1.0"
Example HTTP response
Response 200
{
"baseline_assignments": [
{
"account_assigned_count": 3,
"account_count": 4,
"id": "ou-b30e9fcc39f84a20bf9e7458e5ec3801",
"ou_assigned_count": 5,
"ou_count": 10,
"preventive_guardrail_activated_count": 8,
"sso_user_name": "testuser",
"status": "REGISTERED",
"type": "OU"
}
]
}
1.1.8 - ListGuardrails
1.1.8.1 - 1.0
get /v1/guardrails
Description
get guardrails list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | landing_zone_id optional | 랜딩 존 ID Example : 2c8a138f8d78e1fc29a449dbfa8681 | any of [string, null] | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | name optional | 가드레일명 Example : foo-guardrail | any of [string, null] | None |
| query | exclude_unit_id optional | 연결된(제외) 유닛 ID Example : ou-c29a138f8f1d78e24dbfa8681fc2fc8 | any of [string, null] | None |
| query | guidance optional | 정책 가이드 Example : MANDATORY | any of [string, null] | None |
| query | service_name optional | Organization Example : iam | any of [string, null] | None |
| query | status optional | 적용 상태 Example : ENABLED | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GuardrailPageResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/guardrails
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudcontrol 1.0"
Example HTTP response
Response 200
{
"count": 20,
"guardrails": [
{
"binding_ous": [],
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"description": "This is an example guardrail.",
"guidance": "MANDATORY",
"id": "2c8a138f8d78e1fc29a449dbfa8681",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"name": "foo-guardrail",
"service_name": "iam",
"srn": "srn:dev2:::::cloudcontrol:guardrail/2c8a138f8d78e1fc29a449dbfa8681",
"status": "DISABLED",
"type": "PREVENTIVE"
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
1.1.9 - ListGuardrailsForTarget
1.1.9.1 - 1.0
get /v1/guardrail-bindings/guardrails
Description
list guardrails for target
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | landing_zone_id optional | 랜딩 존 ID Example : 2c8a138f8d78e1fc29a449dbfa8681 | any of [string, null] | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | target_id required | 타겟 ID Example : ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 | string | None |
| query | name optional | 가드레일명 Example : guardrail-example | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ListGuardrailsForTargetResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/guardrail-bindings/guardrails?target_id={target_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudcontrol 1.0"
Example HTTP response
Response 200
{
"count": 20,
"guardrails": [
{
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"guidance": "MANDATORY",
"id": "0a36e0746dbf4908acf0357829701381",
"link_types": {
"directed": [
{
"target_id": "1a2b3c4d5e6f7g8h9i0j1k2l3m4n5",
"target_name": "example-target"
}
],
"inherited": [
{
"target_id": "2a2b3c4d5e6f7g8h9i0j1k2l3m4n5",
"target_name": "root"
}
]
},
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"name": "foo-guardrail",
"service_name": "iam",
"type": "PREVENTIVE"
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
1.1.10 - ListTargetsForGuardrail
1.1.10.1 - 1.0
get /v1/guardrail-bindings/targets
Description
list targets for guardrail
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | landing_zone_id optional | 랜딩 존 ID Example : 2c8a138f8d78e1fc29a449dbfa8681 | any of [string, null] | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | guardrail_id required | 가드레일 ID Example : f98e76d54c32b10a9z8y7x6w5v4u3 | string | None |
| query | target_type required | 타겟유형 Example : ACCOUNT | enum (ACCOUNT, OU) | None |
| query | name optional | 타겟명 Example : ou-test | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ListTargetsForGuardrailResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/guardrail-bindings/targets?guardrail_id={guardrail_id}&target_type={target_type}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudcontrol 1.0"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
],
"targets": [
{
"email": "score@samsung.com",
"id": "b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0",
"name": "score-account",
"parent_unit_id": "ou-fc8c29a138d78e24bf1fa86812fc8b",
"parent_unit_name": "parent-unit-name"
}
]
}
1.1.11 - ShowGuardrail
1.1.11.1 - 1.0
get /v1/guardrails/{guardrail_id}
Description
show a specific guardrail.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | guardrail_id required | 가드레일 ID Example : 2c8a138f8d78e1fc29a449dbfa8681 | string | None |
| query | landing_zone_id optional | 랜딩 존 ID Example : 2c8a138f8d78e1fc29a449dbfa8681 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GuardrailShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/guardrails/{guardrail_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudcontrol 1.0"
Example HTTP response
Response 200
{
"guardrail": {
"binding_ous": [],
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"description": "This is an example guardrail.",
"guidance": "MANDATORY",
"id": "2c8a138f8d78e1fc29a449dbfa8681",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"name": "foo-guardrail",
"service_name": "iam",
"srn": "srn:dev2:::::cloudcontrol:guardrail/2c8a138f8d78e1fc29a449dbfa8681",
"status": "DISABLED",
"type": "PREVENTIVE"
}
}
1.1.12 - ShowLandingZone
1.1.12.1 - 1.0
get /v1/landing-zones/{landing_zone_id}
Description
Show a landing zone
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | landing_zone_id required | 랜딩 존 ID Example : 2c8a138f8d78e1fc29a449dbfa8681 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | LandingZoneShowResponse |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/landing-zones/{landing_zone_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudcontrol 1.0"
Example HTTP response
Response 200
{
"landing_zone": {
"agree_yn": "Y",
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"creator_name": "John Doe na",
"id": "2c8a138f8d78e1fc29a449dbfa8681",
"identity_center_id": "0xnw6g1xh2q5",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"modifier_name": "Alice",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"region": "kr-west1",
"service_name": "Cloud Control",
"srn": "srn:dev2::a8a2f3c2659646ecaaf28fc8f783921a:::cloudcontrol:landingzone/f7a1ef0b17e34a37811cc2fa7a6bd50b",
"sso_type": "ID_CENTER",
"status": "ACTIVE",
"version_id": "1.0"
}
}
1.1.13 - UpdateBaselineAssignment
1.1.13.1 - 1.0
put /v1/baseline-assignments/{assignment_id}
Description
update a specific baseline assignment.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | assignment_id required | 루트/조직 단위/계정 ID Example : ou-b30e9fcc39f84a20bf9e7458e5ec3801 | string | None |
| body | body required | BaselineAssignmentUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | BaselineAssignmentAddResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/baseline-assignments/{assignment_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudcontrol 1.0"
Request body
{
"agree_yn": "Y",
"landing_zone_id": "2c8a138f8d78e1fc29a449dbfa8681"
}
Example HTTP response
Response 200
{
"job_id": "0a36e0746dbf4908acf0357829701381",
"resource_id": "ou-b30e9fcc39f84a20bf9e7458e5ec3801",
"resource_type": "OU"
}
1.2 - Models
1.2.1 - AccountFactoryCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| email optional | 계정 이메일 Example : myaccount@example.com | any of [string, null] | |
| landing_zone_id required | 랜딩 존 ID Example : 2c8a138f8d78e1fc29a449dbfa8681 | string | |
| name required | 계정명 Example : foo-account | string | |
| parent_unit_id required | 상위 조직 단위 ID Example : ou-b30e9fcc39f84a20bf9e7458e5ec3801 | string | |
| sso_user_email optional | ID Center 사용자 이메일 Example : user_email@example.com | any of [string, null] | |
| sso_user_name optional | ID Center 사용자 이름 Example : John Doe | any of [string, null] | |
| sso_user_real_name optional | ID Center 사용자 실명 Example : John Doe | any of [string, null] |
1.2.2 - AccountFactoryCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | 조직 계정 ID Example : b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 | string | |
| job_id required | ID Example : 0a36e0746dbf4908acf0357829701381 | string |
1.2.3 - AccountsForGuardrail
| Name | Description | Schema | Default |
|---|---|---|---|
| email optional | 계정 이메일 Example : score@samsung.com | any of [string, null] | |
| id required | 조직 계정 ID Example : b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 | string | |
| name optional | 계정명 Example : score-account | any of [string, null] | |
| parent_unit_id required | ROOT 또는 부모 조직 단위 ID Example : ou-fc8c29a138d78e24bf1fa86812fc8b | string | |
| parent_unit_name required | ROOT 또는 부모 조직 단위명 Example : parent-unit-name | string |
1.2.4 - BaselineAssignment
| Name | Description | Schema | Default |
|---|---|---|---|
| account_assigned_count optional | 등록된 계정 수 Example : 3 | any of [integer, null] | |
| account_count optional | 전체 계정 수 Example : 4 | any of [integer, null] | |
| id required | 루트/조직 단위/계정 ID Example : ou-b30e9fcc39f84a20bf9e7458e5ec3801 | string | |
| ou_assigned_count optional | 등록된 조직 단위 수 Example : 5 | any of [integer, null] | |
| ou_count optional | 전체 조직 단위 수 Example : 10 | any of [integer, null] | |
| preventive_guardrail_activated_count optional | 활성화된 예방 가드레일 수 Example : 8 | any of [integer, null] | |
| sso_user_name optional | ID Center 사용자명 Example : testuser | any of [string, null] | |
| status optional | 상태 Example : REGISTERED | any of [string, null] | |
| type required | OU/ACCOUNT Example : OU | string |
1.2.5 - BaselineAssignmentAddRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| agree_yn optional | 약관 동의 여부 Example : Y | any of [enum (Y, N), null] | |
| landing_zone_id required | 랜딩 존 ID Example : 2c8a138f8d78e1fc29a449dbfa8681 | string | |
| parent_unit_id optional | ROOT 또는 부모 조직 단위 ID Example : ou-fc8c29a138d78e24bf1fa86812fc8b | any of [string, null] | |
| resource_type required | OU/ACCOUNT Example : OU | enum (ACCOUNT, OU) | |
| sso_user_name optional | ID Center 사용자명 Example : testuser | any of [string, null] | |
| sso_user_real_name optional | ID Center 사용자 실명 Example : test user | any of [string, null] |
1.2.6 - BaselineAssignmentAddResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| job_id required | ID Example : 0a36e0746dbf4908acf0357829701381 | string | |
| resource_id required | 루트/조직 단위/계정 ID Example : ou-b30e9fcc39f84a20bf9e7458e5ec3801 | string | |
| resource_type required | OU/ACCOUNT Example : OU | string |
1.2.7 - BaselineAssignmentListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| baseline_assignments required | array[BaselineAssignment] |
1.2.8 - BaselineAssignmentUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| agree_yn optional | 약관 동의 여부 Example : Y | any of [enum (Y, N), null] | |
| landing_zone_id required | 랜딩 존 ID Example : 2c8a138f8d78e1fc29a449dbfa8681 | string |
1.2.9 - Guardrail
| Name | Description | Schema | Default |
|---|---|---|---|
| binding_ous optional | any of [array[GuardrailBindingOu], array[object], null] | ||
| created_at required | 생성 일시 Example : 2024-12-19 01:09:05.000 | string (date-time) | |
| created_by required | 생성자 Example : c23fb561c689455993874fa5d5ed4a2f | string | |
| description optional | 가드레일 설명 Example : This is an example guardrail. | any of [string, null] | |
| guidance required | 정책 가이드 Example : MANDATORY | string | |
| id required | 가드레일 ID Example : 2c8a138f8d78e1fc29a449dbfa8681 | string | |
| modified_at required | 수정 일시 Example : 2023-10-15 14:30:00 | string (date-time) | |
| modified_by required | 수정자 Example : c23fb561c689455993874fa5d5ed4a2f | string | |
| name required | 가드레일명 Example : foo-guardrail | string | |
| service_name required | Organization Example : iam | string | |
| srn optional | 가드레일 SRN Example : srn:dev2:::::cloudcontrol:guardrail/2c8a138f8d78e1fc29a449dbfa8681 | any of [string, null] | |
| status optional | 적용 상태 Example : DISABLED | string | DISABLED |
| type required | 가드레일 유형 Example : PREVENTIVE | string |
1.2.10 - GuardrailAssignmentDetail
| Name | Description | Schema | Default |
|---|---|---|---|
| guardrail_id required | 가드레일 ID Example : f98e76d54c32b10a9z8y7x6w5v4u3 | string | |
| unit_id required | 타겟 ID Example : ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 | string |
1.2.11 - GuardrailAssignmentFailCaused
| Name | Description | Schema | Default |
|---|---|---|---|
| error_code required | error code Example : CloudControl.AlreadyEnabledGuardrails | string | |
| failed_caused required | 실패 원인 Example : guardrail already enabled | string | |
| guardrail_id required | 가드레일 ID Example : f98e76d54c32b10a9z8y7x6w5v4u3 | string | |
| unit_id required | 타겟 ID Example : ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 | string |
1.2.12 - GuardrailAssignmentResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| failed_ids required | array[GuardrailAssignmentFailCaused] | ||
| success_ids required | 성공 ID | array[GuardrailAssignmentDetail] |
1.2.13 - GuardrailBindingOu
| Name | Description | Schema | Default |
|---|---|---|---|
| id required | 조직 단위 ID Example : ou-c29a138f8f1d78e24dbfa8681fc2fc8 | string | |
| name required | 조직 단위명 Example : score-organization-unit | string |
1.2.14 - GuardrailDisableRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| guardrail_ids required | 가드레일 목록 ID Example : ['f98e76d54c32b10a9z8y7x6w5v4u3'] | array[string] | |
| landing_zone_id optional | 랜딩 존 ID Example : 2c8a138f8d78e1fc29a449dbfa8681 | any of [string, null] | |
| unit_ids required | 타겟 정보 Example : ['ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5'] | array[string] |
1.2.15 - GuardrailEnableRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| guardrail_ids required | 가드레일 목록 ID Example : ['f98e76d54c32b10a9z8y7x6w5v4u3'] | array[string] | |
| landing_zone_id optional | 랜딩 존 ID Example : 2c8a138f8d78e1fc29a449dbfa8681 | any of [string, null] | |
| unit_ids required | 타겟 정보 Example : ['ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5'] | array[string] |
1.2.16 - GuardrailLinkInfo
| Name | Description | Schema | Default |
|---|---|---|---|
| target_id required | 타겟 ID Example : ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 | string | |
| target_name required | 타겟명 Example : ou-test | any of [string, null] |
1.2.17 - GuardrailPageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| guardrails required | array[GuardrailSummary] | ||
| page required | page Example : 0 | integer | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
1.2.18 - GuardrailsForTargetSummary
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | 생성 일시 Example : 2024-12-19 01:09:05.000 | string (date-time) | |
| created_by required | 생성자 Example : c23fb561c689455993874fa5d5ed4a2f | string | |
| guidance required | 정책 가이드 Example : MANDATORY | string | |
| id required | ID Example : 0a36e0746dbf4908acf0357829701381 | string | |
| link_types required | 연결 유형 Example : {'directed': [{'target_id': '1a2b3c4d5e6f7g8h9i0j1k2l3m4n5', 'target_name': 'example-target'}], 'inherited': [{'target_id': '2a2b3c4d5e6f7g8h9i0j1k2l3m4n5', 'target_name': 'root'}]} | object[array[GuardrailLinkInfo]] | |
| modified_at required | 수정 일시 Example : 2023-10-15 14:30:00 | string (date-time) | |
| modified_by required | 수정자 Example : c23fb561c689455993874fa5d5ed4a2f | string | |
| name required | 가드레일명 Example : foo-guardrail | string | |
| service_name required | Organization Example : iam | string | |
| type required | 가드레일 유형 Example : PREVENTIVE | string |
1.2.19 - GuardrailShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| guardrail required | Guardrail |
1.2.20 - GuardrailSummary
| Name | Description | Schema | Default |
|---|---|---|---|
| binding_ous optional | any of [array[GuardrailBindingOu], array[object], null] | ||
| created_at required | 생성 일시 Example : 2024-12-19 01:09:05.000 | string (date-time) | |
| created_by required | 생성자 Example : c23fb561c689455993874fa5d5ed4a2f | string | |
| description optional | 가드레일 설명 Example : This is an example guardrail. | any of [string, null] | |
| guidance required | 정책 가이드 Example : MANDATORY | string | |
| id required | 가드레일 ID Example : 2c8a138f8d78e1fc29a449dbfa8681 | string | |
| modified_at required | 수정 일시 Example : 2023-10-15 14:30:00 | string (date-time) | |
| modified_by required | 수정자 Example : c23fb561c689455993874fa5d5ed4a2f | string | |
| name required | 가드레일명 Example : foo-guardrail | string | |
| service_name required | Organization Example : iam | string | |
| srn optional | 가드레일 SRN Example : srn:dev2:::::cloudcontrol:guardrail/2c8a138f8d78e1fc29a449dbfa8681 | any of [string, null] | |
| status optional | 적용 상태 Example : DISABLED | string | DISABLED |
| type required | 가드레일 유형 Example : PREVENTIVE | string |
1.2.21 - LandingZone
| Name | Description | Schema | Default |
|---|---|---|---|
| agree_yn required | 약관 동의 여부 Example : Y | string | |
| created_at required | 생성 일시 Example : 2024-12-19 01:09:05.000 | string (date-time) | |
| created_by required | 생성자 Example : c23fb561c689455993874fa5d5ed4a2f | string | |
| creator_name optional | 생성자 성, 이름 Example : John Doe na | string | - |
| id required | 랜딩 존 ID Example : 2c8a138f8d78e1fc29a449dbfa8681 | string | |
| identity_center_id optional | Identity Center ID Example : 0xnw6g1xh2q5 | any of [string, null] | |
| modified_at required | 수정 일시 Example : 2023-10-15 14:30:00 | string (date-time) | |
| modified_by required | 수정자 Example : c23fb561c689455993874fa5d5ed4a2f | string | |
| modifier_name optional | 수정자 성, 이름 Example : Alice | string | - |
| organization_id required | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | string | |
| region required | 리전 Example : kr-west1 | string | |
| service_name required | 서비스명 Example : Cloud Control | string | |
| srn required | 랜딩 존 SRN Example : srn:dev2::a8a2f3c2659646ecaaf28fc8f783921a:::cloudcontrol:landingzone/f7a1ef0b17e34a37811cc2fa7a6bd50b | string | |
| sso_type required | Account 액세스 구성 Example : ID_CENTER | string | |
| status required | 상태 Example : ACTIVE | string | |
| version_id required | 랜딩 존 버전 Example : 1.0 | string |
1.2.22 - LandingZoneCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| additional_ou_name required | 추가 조직 단위명 Example : SandboxMinimum length : 1Maximum length : 128 | string | |
| agree_yn required | 약관 동의 여부 Example : Y | enum (Y, N) | |
| audit_account_name required | 감사 계정명 Example : AUDITPattern : ^[a-zA-Z0-9ㄱ-ㅎㅏ-ㅣ가-힣 \+=_\-@\[\]\(\)\.,]*$Minimum length : 3Maximum length : 30 | string | |
| audit_login_id required | 로그인 ID Example : audit@samsung.comMaximum length : 60 | string (email) | |
| basic_ou_name required | 기본 조직 단위명 Example : SecurityMinimum length : 1Maximum length : 128 | string | |
| log_archive_account_name required | 로그 아카이브 계정명 Example : LOG_ARCHIVEPattern : ^[a-zA-Z0-9ㄱ-ㅎㅏ-ㅣ가-힣 \+=_\-@\[\]\(\)\.,]*$Minimum length : 3Maximum length : 30 | string | |
| log_archive_login_id required | 로그인 ID Example : log-archive@samsung.comMaximum length : 60 | string (email) | |
| sso_type required | Account 액세스 구성 Example : ID_CENTER | enum (ID_CENTER, SELF) |
1.2.23 - LandingZoneCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| job_id required | ID Example : 0a36e0746dbf4908acf0357829701381 | string | |
| landing_zone_id required | 랜딩 존 ID Example : 2c8a138f8d78e1fc29a449dbfa8681 | string |
1.2.24 - LandingZoneShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| landing_zone required | LandingZone |
1.2.25 - ListGuardrailsForTargetResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| guardrails required | array[GuardrailsForTargetSummary] | ||
| page required | page Example : 0 | integer | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
1.2.26 - ListTargetsForGuardrailResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] | |
| targets required | any of [array[AccountsForGuardrail], array[OrganizationUnitsForGuardrail]] |
1.2.27 - OrganizationUnitsForGuardrail
| Name | Description | Schema | Default |
|---|---|---|---|
| id required | 조직 단위 ID Example : ou-c29a138f8f1d78e24dbfa8681fc2fc8 | string | |
| name required | 조직 단위명 Example : score-organization-unit | string | |
| parent_unit_id optional | ROOT 또는 부모 조직 단위 ID Example : ou-fc8c29a138d78e24bf1fa86812fc8b | any of [string, null] | |
| parent_unit_name optional | ROOT 또는 부모 조직 단위명 Example : parent-unit-name | any of [string, null] |
2 - Cloud Monitoring
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.
본 가이드는 MONITORING 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | DEPRECATED | 20260223 |
OpenAPI URL
https://cloudmonitoring.{region}.{environment}.samsungsdscloud.com
Environment and Region List
| environment | region |
|---|---|
| s | kr-west1 |
| s | kr-east1 |
| g | kr-south1 |
| g | kr-south2 |
| g | kr-south3 |
| e | kr-west1 |
| e | kr-east1 |
2.1 - APIs
2.1.1 - CreateEventPolicy
2.1.1.1 - 1.0
post /v1/cloudmonitorings/event/v2/event-policies
Description
Create Event Policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| header | X-ResourceType required | Resource Type Example : | string | None |
| body | body required | EventPolicyCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | EventPolicyDetailResponse |
| 201 | OK(Created) | EventPolicyDetailResponse |
| 400 | Invalid Request | None |
| 401 | Monitoring User Not Found | None |
| 403 | Unauthorized Request | None |
| 404 | Resource Not Found | None |
Example HTTP request
Request path
/v1/cloudmonitorings/event/v2/event-policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudmonitoring 1.0"
Request body
{
"eventPolicyRequest": {
"disableYn": "N",
"eventLevel": "WARNING",
"eventMessagePrefix": "SCP",
"eventOccurTimeZone": "GMT+9",
"eventPolicyStatistics": {
"eventPolicyStatisticsPeriod": 10,
"eventPolicyStatisticsType": "MAX"
},
"eventThreshold": {
"metricFunction": "delta",
"rangeThreshold": {
"maxComparisonOperator": "LT",
"maxValue": 90,
"minComparisonOperator": "GT",
"minValue": 80
},
"singleThreshold": {
"comparisonOperator": "LT",
"value": 10
},
"thresholdType": "RANGE_VALUE"
},
"ftCount": 3,
"isLogMetric": "N",
"metricKey": "system.diskio.read.bytes",
"metricName": "",
"objectDisplayName": "dm0",
"objectName": "dm0",
"objectType": "SCP",
"podObjectDisplayName": "dm0",
"podObjectName": "dm0"
},
"notificationRecipients": [
{
"notificationMethods": [
{
"eventLevel": "FATAL",
"notificationMethod": "",
"sendMethod": [
"MAIL"
]
}
],
"recipientKey": "1347",
"recipientType": "USER"
}
],
"productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp"
}
Example HTTP response
Response 200
{
"asgYn": "",
"attrListStr": "",
"checkAsg": "",
"createBy": "",
"createById": "",
"createdBy": "",
"createdByName": "",
"createdDt": "2026-02-11T06:41:19.229Z",
"disableObject": "N",
"disableYn": "",
"displayEventRule": "SCP",
"eventLevel": "WARNING",
"eventMessagePrefix": "SCP",
"eventOccurTimeZone": "GMT+9",
"eventPolicyId": 7226,
"eventPolicyStatistics": {
"eventPolicyStatisticsPeriod": 10,
"eventPolicyStatisticsType": "MAX"
},
"eventThreshold": {
"metricFunction": "delta",
"rangeThreshold": {
"maxComparisonOperator": "LT",
"maxValue": 90,
"minComparisonOperator": "GT",
"minValue": 80
},
"singleThreshold": {
"comparisonOperator": "LT",
"value": 10
},
"thresholdType": "RANGE_VALUE"
},
"ftCount": 3,
"groupSummary": {
"groupName": "",
"groupResourceId": "",
"groupSq": "",
"productList": [
{
"productName": "",
"productResourceId": "",
"productSq": ""
}
],
"productTypeCode": "",
"productTypeName": ""
},
"isLogMetric": "N",
"metricDescription": "커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%)",
"metricDescriptionEn": "Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%)",
"metricKey": "system.cpu.system.pct",
"metricName": "system.cpu.system.pct",
"metricSummary": {
"isLogMetric": "N",
"isObjectExist": "Y",
"metricDescription": "커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%)",
"metricDescriptionEn": "Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%)",
"metricKey": "system.cpu.system.pct",
"metricName": "system.cpu.system.pct",
"metricSetKey": "system.cpu",
"metricSetName": "CPU",
"metricType": "NUM",
"metricUnit": "bytes",
"productTargetType": "system.core.id 별",
"productTargetTypeEn": "By system.core.id"
},
"metricType": "NUM",
"metricUnit": "%",
"modifiedBy": "",
"modifiedByName": "",
"modifiedDt": "2026-02-11T06:41:19.230Z",
"objectDisplayName": "/tmp",
"objectName": "/tmp",
"objectType": "cluster",
"objectTypeName": "cluster",
"productInfoAttrs": [
{
"attrName": "type",
"attrValue": "test"
}
],
"productName": "adad-002",
"productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp",
"productSq": 7234,
"productSummary": {
"agentState": "Running",
"lbName": "lbName",
"lbSize": "MEDIUM",
"productIpAddress": "192.168.1.2",
"productName": "VM-002",
"productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp",
"productSq": 8703,
"productState": "Running",
"productSubName": "productSubName",
"productSubType": "replicaset",
"productTypeCode": "VM",
"productTypeName": "Virtual Server",
"vpcName": "vpcName"
},
"productTargetType": "system.core.id 별",
"productTargetTypeEn": "By system.core.id",
"startDt": "2021-10-23T18:00:00Z",
"updateBy": "",
"updateById": "",
"userNameList": [
"userName",
"userName"
],
"userNameStr": "",
"userNames": "N"
}
2.1.2 - DeleteEventPolicy
2.1.2.1 - 1.0
delete /v1/cloudmonitorings/event/v2/event-policies/{eventPolicyId}
Description
Delete Event policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | eventPolicyId required | Event policy ID to delete - Event Policy ID can be viewed using @[ListEventPolicies]. Example : 7226 | integer | None |
| header | X-ResourceType required | Resource Type Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | None |
| 204 | OK(No Contents) | None |
| 400 | Invalid Request | None |
| 401 | Monitoring User Not Found | None |
| 403 | Unauthorized Request | None |
| 404 | Resource Not Found | None |
Example HTTP request
Request path
/v1/cloudmonitorings/event/v2/event-policies/{eventPolicyId}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudmonitoring 1.0"
Example HTTP response
Response 200
2.1.3 - ListAccountEvents
2.1.3.1 - 1.0
get /v1/cloudmonitorings/event/v2/accounts/events
Description
Search Account Event List
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | eventState required | Event State Example : ALL | string | None |
| query | queryStartDt required | Query Start Date Example : 2021-10-23T18:00:00.000Z | string | None |
| query | queryEndDt required | Query End Date Example : 2021-10-23T23:59:59.000Z | string | None |
| query | page optional | Page Number (default: 0) Example : 0 | integer | None |
| query | size optional | Page Contents Size (default: 10) Example : 10 | integer | None |
| query | sort optional | Sorting Field List | array[string] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PageResponseOpenApiEventResponse |
| 400 | Invalid Request | None |
Example HTTP request
Request path
/v1/cloudmonitorings/event/v2/accounts/events?eventState={eventState}&queryStartDt={queryStartDt}&queryEndDt={queryEndDt}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudmonitoring 1.0"
Example HTTP response
Response 200
{
"contents": [
{
"durationSecond": 100,
"endDt": "2021-10-23T23:59:59Z",
"eventId": "",
"eventLevel": "FATAL",
"eventMessage": "",
"eventPolicyId": 7240,
"eventState": "ACTIVE",
"metricKey": "system.cpu.system.norm.pct",
"metricName": "system.cpu.system.norm.pct",
"objectDisplayName": "CPU0",
"objectName": "CPU0",
"objectType": "cluster",
"objectTypeName": "cluster",
"productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp",
"productTargetType": "system.core.id 별",
"productTargetTypeEn": "By system.core.id",
"productTypeName": "Virtual Server",
"startDt": "2021-10-23T18:00:00Z"
}
],
"isChanged": "",
"returnCount": "",
"returnPage": "",
"sort": [
""
],
"sortableFields": [
""
],
"totalCount": ""
}
2.1.4 - ListAccountMember
2.1.4.1 - 1.0
get /v1/cloudmonitorings/product/v1/accounts/members
Description
Search members included in an Account.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | page optional | Page Number (default: 0) Example : 0 | integer | None |
| query | size optional | Page Contents Size (default: 10) Example : 10 | integer | None |
| query | sort optional | Sorting Field List | array[string] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PageResponseJsonArrayProjectMemberResponseForOpenAPI |
| 400 | Invalid Request | None |
| 401 | Monitoring User Not Found | None |
| 403 | Unauthorized Request | None |
| 404 | Resource Not Found | None |
Example HTTP request
Request path
/v1/cloudmonitorings/product/v1/accounts/members
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudmonitoring 1.0"
Example HTTP response
Response 200
{
"contents": [
{
"companyName": "삼성SDS",
"createdBy": "469",
"createdByEmail": "soonshin.lee@cloud.com",
"createdByName": "이순신",
"createdDt": "2021-08-06T10:23:41.547Z",
"email": "kdhong@cloud.com",
"lastAccessDt": "2022-11-06T10:23:41.547Z",
"modifiedBy": "469",
"modifiedByEmail": "soonshin.lee@cloud.com",
"modifiedByName": "이순신",
"modifiedDt": "2021-08-06T10:23:41.547Z",
"organizationId": "",
"positionName": "프로",
"userGroupCount": "10",
"userId": "1984",
"userName": "홍길동"
}
],
"returnCount": 10,
"returnPage": 1,
"sort": [
""
],
"sortableFields": [
""
],
"totalCount": 100
}
2.1.5 - ListAccountResources
2.1.5.1 - 1.0
get /v1/cloudmonitorings/product/v2/accounts/products
Description
Search Resource included in an Account.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | page optional | Page Number (default: 0) Example : 0 | integer | None |
| query | size optional | Page Contents Size (default: 10) Example : 10 | integer | None |
| query | sort optional | Sorting Field List | array[string] | None |
| header | X-ResourceType required | Resource Type Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PageResponseAccountProductDto |
| 400 | Invalid Request | None |
| 401 | Monitoring User Not Found | None |
| 403 | Unauthorized Request | None |
| 404 | Resource Not Found | None |
Example HTTP request
Request path
/v1/cloudmonitorings/product/v2/accounts/products
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudmonitoring 1.0"
Example HTTP response
Response 200
{
"contents": [
{
"accountId": "UqXgOSnoqOfKB0_LKO6xId",
"endDt": "9999-12-31T23:59:59.999Z",
"lastEventLevel": "WARNING",
"poolName": "POOL-A8-C1DpGqRdQMlfNXdJxLb",
"productIpAddress": "192.168.245.161",
"productName": "VM-Server-01",
"productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp",
"productState": "Running",
"productTypeCode": "VM",
"productTypeName": "Virtual Server",
"startDt": "2021-10-23T08:30:00Z"
}
],
"isChanged": "",
"returnCount": "",
"returnPage": "",
"sort": [
""
],
"sortableFields": [
""
],
"totalCount": ""
}
2.1.6 - ListAddressBookMembers
2.1.6.1 - 1.0
get /v1/cloudmonitorings/product/v2/addrbooks/{addrbookId}/members
Description
Search address book members
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | addrbookId required | Address book ID - Address book IDs can be obtained from @[ListAddressBooks]. Example : | integer | None |
| query | page optional | Page Number (default: 0) Example : 0 | integer | None |
| query | size optional | Page Contents Size (default: 10) Example : 10 | integer | None |
| query | sort optional | Sorting Field List | array[string] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PageResponseAlarmAddrBookMemberDto |
| 400 | Invalid Request | None |
| 401 | Monitoring User Not Found | None |
| 403 | Unauthorized Request | None |
| 404 | Resource Not Found | None |
Example HTTP request
Request path
/v1/cloudmonitorings/product/v2/addrbooks/{addrbookId}/members
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudmonitoring 1.0"
Example HTTP response
Response 200
{
"contents": [
{
"userEmail": "kdhong@cloud.com",
"userId": "1346",
"userLanguage": "ko",
"userMobileTelNo": "010-0000-0000",
"userName": "홍길동",
"userTimezone": "Asia/Seoul"
}
],
"isChanged": "",
"returnCount": "",
"returnPage": "",
"sort": [
""
],
"sortableFields": [
""
],
"totalCount": ""
}
2.1.7 - ListAddressBooks
2.1.7.1 - 1.0
get /v1/cloudmonitorings/product/v2/users/addrbooks
Description
Search a list of address books created by user.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | page optional | Page Number (default: 0) Example : 0 | integer | None |
| query | size optional | Page Contents Size (default: 10) Example : 10 | integer | None |
| query | sort optional | Sorting Field List | array[string] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PageResponseAlarmAddrBookDto |
| 400 | Invalid Request | None |
| 401 | Monitoring User Not Found | None |
| 403 | Unauthorized Request | None |
| 404 | Resource Not Found | None |
Example HTTP request
Request path
/v1/cloudmonitorings/product/v2/users/addrbooks
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudmonitoring 1.0"
Example HTTP response
Response 200
{
"contents": [
{
"addrBookName": "contact name",
"addrbookId": "74",
"createdBy": "1984",
"createdByName": "김삼성",
"createdDt": "2021-10-23T22:00:00Z",
"memberCount": 10
}
],
"isChanged": "",
"returnCount": "",
"returnPage": "",
"sort": [
""
],
"sortableFields": [
""
],
"totalCount": ""
}
2.1.8 - ListEventPolicies
2.1.8.1 - 1.0
get /v1/cloudmonitorings/event/v2/event-policies
Description
Search Event Policies
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | productResourceId required | Product Resource ID - Product Resource ID can be viewed using @[ListAccountResources]. Example : c94607c8-6a15-4e13-84f3-99cb77d478e3 | string | None |
| query | metricKey optional | Metric Key - Metric Key can be viewed using @[ListMetrics]. Example : system.cpu.system.pct | string | None |
| query | page optional | Page Number (default: 0) Example : 0 | integer | None |
| query | size optional | Page Contents Size (default: 10) Example : 10 | integer | None |
| query | sort optional | Sorting Field List | array[string] | None |
| header | X-ResourceType required | Resource Type Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PageResponseEventPolicyResponse |
| 400 | Invalid Request | None |
| 401 | Monitoring User Not Found | None |
| 403 | Unauthorized Request | None |
| 404 | Resource Not Found | None |
Example HTTP request
Request path
/v1/cloudmonitorings/event/v2/event-policies?productResourceId={productResourceId}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudmonitoring 1.0"
Example HTTP response
Response 200
{
"contents": [
{
"checkAsg": "",
"createBy": "",
"createById": "",
"eventLevel": "WARNING",
"eventMessagePrefix": "SCP",
"eventOccurTimeZone": "GMT+9",
"eventPolicyId": 7226,
"eventPolicyStatistics": {
"eventPolicyStatisticsPeriod": 10,
"eventPolicyStatisticsType": "MAX"
},
"eventThreshold": {
"metricFunction": "delta",
"rangeThreshold": {
"maxComparisonOperator": "LT",
"maxValue": 90,
"minComparisonOperator": "GT",
"minValue": 80
},
"singleThreshold": {
"comparisonOperator": "LT",
"value": 10
},
"thresholdType": "RANGE_VALUE"
},
"ftCount": 3,
"isLogMetric": "N",
"metricDescription": "커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%)",
"metricDescriptionEn": "Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%)",
"metricKey": "system.cpu.system.pct",
"metricName": "system.cpu.system.pct",
"objectName": "cpu0",
"productName": "VM-002",
"productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp",
"productSq": 7321,
"productTargetType": "system.core.id 별",
"productTargetTypeEn": "By system.core.id",
"updateBy": "",
"updateById": ""
}
],
"isChanged": "",
"returnCount": "",
"returnPage": "",
"sort": [
""
],
"sortableFields": [
""
],
"totalCount": ""
}
2.1.9 - ListEventPolicyHistories
2.1.9.1 - 1.0
get /v1/cloudmonitorings/event/v2/event-policies/{eventPolicyId}/histories
Description
Search event policy histories
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | eventPolicyId required | Event Policy ID to inquire - Event Policy ID can be viewed using @[ListEventPolicies]. Example : 7226 | integer | None |
| query | queryStartDt required | Query Start Date Example : 2021-10-23T18:00:00.000Z | string | None |
| query | queryEndDt required | Query End Date Example : 2021-10-23T23:59:59.000Z | string | None |
| query | page optional | Page Number (default: 0) Example : 0 | integer | None |
| query | size optional | Page Contents Size (default: 10) Example : 10 | integer | None |
| query | sort optional | Sorting Field List | array[string] | None |
| header | X-ResourceType required | Resource Type Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PageResponseEventPolicyHistoryResponse |
| 400 | Invalid Request | None |
| 401 | Monitoring User Not Found | None |
| 403 | Unauthorized Request | None |
| 404 | Resource Not Found | None |
Example HTTP request
Request path
/v1/cloudmonitorings/event/v2/event-policies/{eventPolicyId}/histories?queryStartDt={queryStartDt}&queryEndDt={queryEndDt}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudmonitoring 1.0"
Example HTTP response
Response 200
{
"contents": [
{
"createBy": "",
"createById": "",
"disableObject": "N",
"disableYn": "N",
"eventLevel": "WARNING",
"eventMessagePrefix": "SCP",
"eventOccurTimeZone": "GMT+9",
"eventPolicyHistoryId": 8759,
"eventPolicyHistoryType": "U",
"eventPolicyId": 7240,
"eventPolicyStatistics": {
"eventPolicyStatisticsPeriod": 10,
"eventPolicyStatisticsType": "MAX"
},
"eventThreshold": {
"metricFunction": "delta",
"rangeThreshold": {
"maxComparisonOperator": "LT",
"maxValue": 90,
"minComparisonOperator": "GT",
"minValue": 80
},
"singleThreshold": {
"comparisonOperator": "LT",
"value": 10
},
"thresholdType": "RANGE_VALUE"
},
"ftCount": 3,
"metricDescription": "커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%)",
"metricDescriptionEn": "Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%)",
"metricKey": "system.cpu.system.pct",
"metricName": "system.cpu.system.pct",
"metricUnit": "%",
"modifiedBy": "",
"modifiedByName": "",
"modifiedDt": "2026-02-11T06:41:19.370Z",
"notificationRecipientHistory": {
"addrbookIds": [
""
],
"userIds": [
""
],
"userNames": [
""
]
},
"objectDisplayName": "cpu0",
"objectName": "cpu0",
"objectType": "cluster",
"productName": "VM-Server-01",
"productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp",
"productTargetType": "system.core.id 별",
"productTargetTypeEn": "By system.core.id",
"updateBy": "",
"updateById": ""
}
],
"isChanged": "",
"returnCount": "",
"returnPage": "",
"sort": [
""
],
"sortableFields": [
""
],
"totalCount": ""
}
2.1.10 - ListEventPolicyNotification
2.1.10.1 - 1.0
get /v1/cloudmonitorings/event/v2/event-policies/{eventPolicyId}/notifications
Description
Search Event Policy Notification
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | page optional | Page Number (default: 0) Example : 0 | integer | None |
| query | size optional | Page Contents Size (default: 10) Example : 10 | integer | None |
| query | sort optional | Sorting Field List | array[string] | None |
| path | eventPolicyId required | Event Policy ID to inquire - Event Policy ID can be viewed using @[ListEventPolicies]. Example : 7226 | integer | None |
| header | X-ResourceType required | Resource Type Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PageResponseNotificationResponse |
| 400 | Invalid Request | None |
| 401 | Monitoring User Not Found | None |
| 403 | Unauthorized Request | None |
| 404 | Resource Not Found | None |
Example HTTP request
Request path
/v1/cloudmonitorings/event/v2/event-policies/{eventPolicyId}/notifications
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudmonitoring 1.0"
Example HTTP response
Response 200
{
"contents": [
{
"addrbookAdditionalInfo": {
"memberCount": 4,
"userAdditionalInfo": [
{
"account_id": "",
"company_name": "",
"dst_offset": "",
"email": "",
"id": "",
"last_login_at": "",
"member_created_at": "",
"password_reuse_count": "",
"timezone": "",
"tz_id": "",
"user_name": "",
"utc_offset": ""
}
]
},
"notificationMethods": [
{
"eventLevel": "FATAL",
"notificationMethod": "",
"sendMethod": [
"MAIL"
]
}
],
"recipientKey": "1984",
"recipientName": "홍길동",
"recipientType": "USER",
"userAdditionalInfo": {
"account_id": "",
"company_name": "",
"dst_offset": "",
"email": "",
"id": "",
"last_login_at": "",
"member_created_at": "",
"password_reuse_count": "",
"timezone": "",
"tz_id": "",
"user_name": "",
"utc_offset": ""
}
}
],
"isChanged": "",
"returnCount": "",
"returnPage": "",
"sort": [
""
],
"sortableFields": [
""
],
"totalCount": ""
}
2.1.11 - ListMetricPefData
2.1.11.1 - 1.0
post /v1/cloudmonitorings/product/v2/metric-data
Description
Search the performance values of the collected metrics. Up to 10 query conditions can be specified, and the maximum query period is 24 hours.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| header | X-ResourceType required | Resource Type Example : | string | None |
| body | body required | MetricDataSearchCriteriaOpenAPIV2 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ListResponseMetricStatisticsDataDtoOpenAPIV2 |
| 201 | OK(Created) | ListResponseMetricStatisticsDataDtoOpenAPIV2 |
| 400 | Invalid Request | None |
| 401 | Monitoring User Not Found | None |
| 403 | Unauthorized Request | None |
| 404 | Resource Not Found | None |
Example HTTP request
Request path
/v1/cloudmonitorings/product/v2/metric-data
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudmonitoring 1.0"
Request body
{
"ignoreInvalid": "Y",
"metricDataConditions": [
{
"metricKey": "system.diskio.read.bytes",
"objectType": "replicaset",
"productResourceInfos": [
{
"objectList": [
"kube-01",
"kube-02"
],
"productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp"
}
],
"statisticsPeriod": 5,
"statisticsTypeList": [
"SUM",
"MIN"
]
}
],
"queryEndDt": "2022-08-07T23:59:00.000Z",
"queryStartDt": "2022-08-07T23:50:00.000Z"
}
Example HTTP response
Response 200
{
"contents": [
{
"metricKey": "system.filesystem.used.bytes",
"metricName": "system.filesystem.used.bytes",
"metricType": "NUM",
"metricUnit": "bytes",
"objectDisplayName": "dm-1",
"objectName": "dm-1",
"objectType": "replicaset",
"perfData": [
{
"time": 1627378200000,
"value": "0.0766"
}
],
"productName": "VM-Server-01",
"productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp",
"statisticsPeriod": 5,
"statisticsType": "SUM"
}
],
"totalCount": ""
}
2.1.12 - ListMetrics
2.1.12.1 - 1.0
get /v1/cloudmonitorings/product/v2/metrics
Description
View the list of metrics provided by Monitoring. You can view the full list of metrics or the list of metrics for each service type.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | productTypeCode optional | Product type code - Product type codes can be obtained using @[ListServiceMonitoring]. If not specified, the entire metric list will be retrieved. Example : VM | string | None |
| query | objectType optional | Object Type - Only available for services that have subtypes, such as when the ‘productTypeCode’ is ‘Kubernetes’ or ‘Load Balancer’. Example : node | string | None |
| query | page optional | Page Number (default: 0) Example : 0 | integer | None |
| query | size optional | Page Contents Size (default: 10) Example : 10 | integer | None |
| query | sort optional | Sorting Field List | array[string] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PageResponseMetricInfoDto |
| 400 | Invalid Request | None |
| 401 | Monitoring User Not Found | None |
| 403 | Unauthorized Request | None |
| 404 | Resource Not Found | None |
Example HTTP request
Request path
/v1/cloudmonitorings/product/v2/metrics
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudmonitoring 1.0"
Example HTTP response
Response 200
{
"contents": [
{
"disableObject": "N",
"displayUnit": "",
"fixedUnit": "sec",
"isLogMetric": "N",
"isObjectExist": "Y",
"metricDescription": "커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%)",
"metricDescriptionEn": "Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%)",
"metricKey": "system.filesystem.used.bytes",
"metricName": "FileSystem",
"metricOrder": 1,
"metricSetKey": "system.filesystem",
"metricSetName": "FileSystem",
"metricType": "NUM",
"metricUnit": "bytes",
"objectKeyName": "system.core.iowait.pct",
"objectType": "N",
"objectTypeNameEng": "N",
"objectTypeNameLoc": "N",
"perfTitle": "File System",
"productTargetType": "system.core.id 별",
"productTargetTypeEn": "By system.core.id",
"productTypeCode": "VM",
"productTypeName": "Virtual Server"
}
],
"isChanged": "",
"returnCount": "",
"returnPage": "",
"sort": [
""
],
"sortableFields": [
""
],
"totalCount": ""
}
2.1.13 - ListResourceEvents
2.1.13.1 - 1.0
get /v1/cloudmonitorings/event/v2/events
Description
Search a list of events that occurred on a product resource.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | productResourceId required | Product Resource ID - Product Resource ID can be viewed using @[ListAccountResources]. Example : INSTANCE-c4Hsd27ttDaLw533X4B6Sp | string | None |
| query | metricKey optional | Metric Key - Metric Key can be viewed using @[ListMetrics]. Example : system.cpu.system.pct | string | None |
| query | eventState required | Event State Example : ALL | string | None |
| query | queryStartDt required | Query Start Date Example : 2021-10-23T18:00:00.000Z | string | None |
| query | queryEndDt required | Query End Date Example : 2021-10-23T23:59:59.000Z | string | None |
| query | page optional | Page Number (default: 0) Example : 0 | integer | None |
| query | size optional | Page Contents Size (default: 10) Example : 10 | integer | None |
| query | sort optional | Sorting Field List | array[string] | None |
| header | X-ResourceType required | Resource Type Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PageResponseOpenApiEventResponse |
| 400 | Invalid Request | None |
| 403 | Unauthorized Request | None |
| 404 | Resource Not Found | None |
Example HTTP request
Request path
/v1/cloudmonitorings/event/v2/events?productResourceId={productResourceId}&eventState={eventState}&queryStartDt={queryStartDt}&queryEndDt={queryEndDt}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudmonitoring 1.0"
Example HTTP response
Response 200
{
"contents": [
{
"durationSecond": 100,
"endDt": "2021-10-23T23:59:59Z",
"eventId": "",
"eventLevel": "FATAL",
"eventMessage": "",
"eventPolicyId": 7240,
"eventState": "ACTIVE",
"metricKey": "system.cpu.system.norm.pct",
"metricName": "system.cpu.system.norm.pct",
"objectDisplayName": "CPU0",
"objectName": "CPU0",
"objectType": "cluster",
"objectTypeName": "cluster",
"productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp",
"productTargetType": "system.core.id 별",
"productTargetTypeEn": "By system.core.id",
"productTypeName": "Virtual Server",
"startDt": "2021-10-23T18:00:00Z"
}
],
"isChanged": "",
"returnCount": "",
"returnPage": "",
"sort": [
""
],
"sortableFields": [
""
],
"totalCount": ""
}
2.1.14 - ListService
2.1.14.1 - 1.0
get /v1/cloudmonitorings/product/v1/product-types
Description
Search a list of product types supported by monitoring.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | productCategoryCode optional | Product type category - If not specified, the entire product type code will be retrieved. Example : Compute | string | None |
| query | page optional | Page Number (default: 0) Example : 0 | integer | None |
| query | size optional | Page Contents Size (default: 10) Example : 10 | integer | None |
| query | sort optional | Sorting Field List | array[string] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PageResponseProductTypeInfoDto |
| 400 | Invalid Request | None |
| 401 | Monitoring User Not Found | None |
| 403 | Unauthorized Request | None |
| 404 | Resource Not Found | None |
Example HTTP request
Request path
/v1/cloudmonitorings/product/v1/product-types
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudmonitoring 1.0"
Example HTTP response
Response 200
{
"contents": [
{
"parentProductTypeName": "Compute",
"productTypeCode": "VM",
"productTypeName": "Virtual Server",
"stateMetricKey": "vsphere.mxvm.runtime.state"
}
],
"isChanged": "",
"returnCount": "",
"returnPage": "",
"sort": [
""
],
"sortableFields": [
""
],
"totalCount": ""
}
2.1.15 - SetEventPolicy
2.1.15.1 - 1.0
put /v1/cloudmonitorings/event/v2/event-policies/{eventPolicyId}
Description
Set Event Policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | eventPolicyId required | Event policy ID to modify - Event Policy ID can be viewed using @[ListEventPolicies]. Example : 7226 | integer | None |
| header | X-ResourceType required | Resource Type Example : | string | None |
| body | body required | EventPolicyUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | EventPolicyDetailResponse |
| 201 | OK(Created) | EventPolicyDetailResponse |
| 400 | Invalid Request | None |
| 401 | Monitoring User Not Found | None |
| 403 | Unauthorized Request | None |
| 404 | Resource Not Found | None |
| 500 | Internal Server Error | None |
Example HTTP request
Request path
/v1/cloudmonitorings/event/v2/event-policies/{eventPolicyId}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudmonitoring 1.0"
Request body
{
"eventPolicyRequest": {
"disableYn": "N",
"eventLevel": "WARNING",
"eventMessagePrefix": "SCP",
"eventOccurTimeZone": "GMT+9",
"eventPolicyStatistics": {
"eventPolicyStatisticsPeriod": 10,
"eventPolicyStatisticsType": "MAX"
},
"eventThreshold": {
"metricFunction": "delta",
"rangeThreshold": {
"maxComparisonOperator": "LT",
"maxValue": 90,
"minComparisonOperator": "GT",
"minValue": 80
},
"singleThreshold": {
"comparisonOperator": "LT",
"value": 10
},
"thresholdType": "RANGE_VALUE"
},
"ftCount": 3,
"objectDisplayName": "cpu0",
"objectName": "cpu0",
"objectType": "cluster",
"podObjectDisplayName": "cpu0",
"podObjectName": "cpu0"
},
"notificationRecipients": [
{
"notificationMethods": [
{
"eventLevel": "FATAL",
"notificationMethod": "",
"sendMethod": [
"MAIL"
]
}
],
"recipientKey": "1347",
"recipientType": "USER"
}
]
}
Example HTTP response
Response 200
{
"asgYn": "",
"attrListStr": "",
"checkAsg": "",
"createBy": "",
"createById": "",
"createdBy": "",
"createdByName": "",
"createdDt": "2026-02-11T06:41:19.229Z",
"disableObject": "N",
"disableYn": "",
"displayEventRule": "SCP",
"eventLevel": "WARNING",
"eventMessagePrefix": "SCP",
"eventOccurTimeZone": "GMT+9",
"eventPolicyId": 7226,
"eventPolicyStatistics": {
"eventPolicyStatisticsPeriod": 10,
"eventPolicyStatisticsType": "MAX"
},
"eventThreshold": {
"metricFunction": "delta",
"rangeThreshold": {
"maxComparisonOperator": "LT",
"maxValue": 90,
"minComparisonOperator": "GT",
"minValue": 80
},
"singleThreshold": {
"comparisonOperator": "LT",
"value": 10
},
"thresholdType": "RANGE_VALUE"
},
"ftCount": 3,
"groupSummary": {
"groupName": "",
"groupResourceId": "",
"groupSq": "",
"productList": [
{
"productName": "",
"productResourceId": "",
"productSq": ""
}
],
"productTypeCode": "",
"productTypeName": ""
},
"isLogMetric": "N",
"metricDescription": "커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%)",
"metricDescriptionEn": "Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%)",
"metricKey": "system.cpu.system.pct",
"metricName": "system.cpu.system.pct",
"metricSummary": {
"isLogMetric": "N",
"isObjectExist": "Y",
"metricDescription": "커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%)",
"metricDescriptionEn": "Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%)",
"metricKey": "system.cpu.system.pct",
"metricName": "system.cpu.system.pct",
"metricSetKey": "system.cpu",
"metricSetName": "CPU",
"metricType": "NUM",
"metricUnit": "bytes",
"productTargetType": "system.core.id 별",
"productTargetTypeEn": "By system.core.id"
},
"metricType": "NUM",
"metricUnit": "%",
"modifiedBy": "",
"modifiedByName": "",
"modifiedDt": "2026-02-11T06:41:19.230Z",
"objectDisplayName": "/tmp",
"objectName": "/tmp",
"objectType": "cluster",
"objectTypeName": "cluster",
"productInfoAttrs": [
{
"attrName": "type",
"attrValue": "test"
}
],
"productName": "adad-002",
"productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp",
"productSq": 7234,
"productSummary": {
"agentState": "Running",
"lbName": "lbName",
"lbSize": "MEDIUM",
"productIpAddress": "192.168.1.2",
"productName": "VM-002",
"productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp",
"productSq": 8703,
"productState": "Running",
"productSubName": "productSubName",
"productSubType": "replicaset",
"productTypeCode": "VM",
"productTypeName": "Virtual Server",
"vpcName": "vpcName"
},
"productTargetType": "system.core.id 별",
"productTargetTypeEn": "By system.core.id",
"startDt": "2021-10-23T18:00:00Z",
"updateBy": "",
"updateById": "",
"userNameList": [
"userName",
"userName"
],
"userNameStr": "",
"userNames": "N"
}
2.1.16 - ShowEventNotificationStates
2.1.16.1 - 1.0
get /v1/cloudmonitorings/event/v2/events/{eventId}/notification-states
Description
Search Event Notification States
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | eventId required | Event ID - Event ID can be viewed using @[ListResourceEvents]. Example : | string | None |
| query | page optional | Page Number (default: 0) Example : 0 | integer | None |
| query | size optional | Page Contents Size (default: 10) Example : 10 | integer | None |
| query | sort optional | Sorting Field List | array[string] | None |
| header | X-ResourceType required | Resource Type Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PageResponseEventNotificationResponse |
| 400 | Invalid Request | None |
| 401 | Monitoring User Not Found | None |
| 403 | Unauthorized Request | None |
| 404 | Resource Not Found | None |
Example HTTP request
Request path
/v1/cloudmonitorings/event/v2/events/{eventId}/notification-states
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudmonitoring 1.0"
Example HTTP response
Response 200
{
"contents": [
{
"notificationStates": [
{
"errorMsg": "SMS Send become Inactive.",
"sendDt": "2021-10-23T18:00:00Z",
"sendMethod": "MAIL",
"sendResult": "SUCCESS"
}
],
"user": "",
"userEmail": "kdhong@cloud.com",
"userId": "1984",
"userMobileTelNo": "010-000-0000",
"userNameNotification": "홍길동"
}
],
"isChanged": "",
"returnCount": "",
"returnPage": "",
"sort": [
""
],
"sortableFields": [
""
],
"totalCount": ""
}
2.1.17 - ShowEventPolicy
2.1.17.1 - 1.0
get /v1/cloudmonitorings/event/v2/event-policies/{eventPolicyId}
Description
Show Event Policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | eventPolicyId required | Event Policy ID to inquire - Event Policy ID can be viewed using @[ListEventPolicies]. Example : 7226 | integer | None |
| header | X-ResourceType required | Resource Type Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | EventPolicyDetailResponse |
| 400 | Invalid Request | None |
| 401 | Monitoring User Not Found | None |
| 403 | Unauthorized Request | None |
| 404 | Resource Not Found | None |
Example HTTP request
Request path
/v1/cloudmonitorings/event/v2/event-policies/{eventPolicyId}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudmonitoring 1.0"
Example HTTP response
Response 200
{
"asgYn": "",
"attrListStr": "",
"checkAsg": "",
"createBy": "",
"createById": "",
"createdBy": "",
"createdByName": "",
"createdDt": "2026-02-11T06:41:19.229Z",
"disableObject": "N",
"disableYn": "",
"displayEventRule": "SCP",
"eventLevel": "WARNING",
"eventMessagePrefix": "SCP",
"eventOccurTimeZone": "GMT+9",
"eventPolicyId": 7226,
"eventPolicyStatistics": {
"eventPolicyStatisticsPeriod": 10,
"eventPolicyStatisticsType": "MAX"
},
"eventThreshold": {
"metricFunction": "delta",
"rangeThreshold": {
"maxComparisonOperator": "LT",
"maxValue": 90,
"minComparisonOperator": "GT",
"minValue": 80
},
"singleThreshold": {
"comparisonOperator": "LT",
"value": 10
},
"thresholdType": "RANGE_VALUE"
},
"ftCount": 3,
"groupSummary": {
"groupName": "",
"groupResourceId": "",
"groupSq": "",
"productList": [
{
"productName": "",
"productResourceId": "",
"productSq": ""
}
],
"productTypeCode": "",
"productTypeName": ""
},
"isLogMetric": "N",
"metricDescription": "커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%)",
"metricDescriptionEn": "Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%)",
"metricKey": "system.cpu.system.pct",
"metricName": "system.cpu.system.pct",
"metricSummary": {
"isLogMetric": "N",
"isObjectExist": "Y",
"metricDescription": "커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%)",
"metricDescriptionEn": "Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%)",
"metricKey": "system.cpu.system.pct",
"metricName": "system.cpu.system.pct",
"metricSetKey": "system.cpu",
"metricSetName": "CPU",
"metricType": "NUM",
"metricUnit": "bytes",
"productTargetType": "system.core.id 별",
"productTargetTypeEn": "By system.core.id"
},
"metricType": "NUM",
"metricUnit": "%",
"modifiedBy": "",
"modifiedByName": "",
"modifiedDt": "2026-02-11T06:41:19.230Z",
"objectDisplayName": "/tmp",
"objectName": "/tmp",
"objectType": "cluster",
"objectTypeName": "cluster",
"productInfoAttrs": [
{
"attrName": "type",
"attrValue": "test"
}
],
"productName": "adad-002",
"productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp",
"productSq": 7234,
"productSummary": {
"agentState": "Running",
"lbName": "lbName",
"lbSize": "MEDIUM",
"productIpAddress": "192.168.1.2",
"productName": "VM-002",
"productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp",
"productSq": 8703,
"productState": "Running",
"productSubName": "productSubName",
"productSubType": "replicaset",
"productTypeCode": "VM",
"productTypeName": "Virtual Server",
"vpcName": "vpcName"
},
"productTargetType": "system.core.id 별",
"productTargetTypeEn": "By system.core.id",
"startDt": "2021-10-23T18:00:00Z",
"updateBy": "",
"updateById": "",
"userNameList": [
"userName",
"userName"
],
"userNameStr": "",
"userNames": "N"
}
2.1.18 - ShowResourceEvent
2.1.18.1 - 1.0
get /v1/cloudmonitorings/event/v2/events/{eventId}
Description
Show Resource Event
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260701 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | eventId required | Event ID - Event ID can be viewed using @[ListResourceEvents]. Example : | string | None |
| header | X-ResourceType required | Resource Type Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | EventDetailResponse |
| 400 | Invalid Request | None |
| 401 | Monitoring User Not Found | None |
| 403 | Unauthorized Request | None |
| 404 | Resource Not Found | None |
Example HTTP request
Request path
/v1/cloudmonitorings/event/v2/events/{eventId}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = cloudmonitoring 1.0"
Example HTTP response
Response 200
{
"durationSecond": 100,
"endDt": "2021-10-23T23:59:59Z",
"eventId": "",
"eventLevel": "FATAL",
"eventMessage": "",
"eventPolicyId": 7240,
"eventPolicySummary": {
"checkAsg": "",
"createBy": "",
"createById": "",
"eventLevel": "WARNING",
"eventMessagePrefix": "SCP",
"eventOccurTimeZone": "GMT+9",
"eventPolicyId": 7226,
"eventPolicyStatistics": {
"eventPolicyStatisticsPeriod": 10,
"eventPolicyStatisticsType": "MAX"
},
"eventThreshold": {
"metricFunction": "delta",
"rangeThreshold": {
"maxComparisonOperator": "LT",
"maxValue": 90,
"minComparisonOperator": "GT",
"minValue": 80
},
"singleThreshold": {
"comparisonOperator": "LT",
"value": 10
},
"thresholdType": "RANGE_VALUE"
},
"ftCount": 3,
"isLogMetric": "N",
"metricDescription": "커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%)",
"metricDescriptionEn": "Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%)",
"metricKey": "system.cpu.system.pct",
"metricName": "system.cpu.system.pct",
"objectName": "cpu0",
"productName": "VM-002",
"productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp",
"productSq": 7321,
"productTargetType": "system.core.id 별",
"productTargetTypeEn": "By system.core.id",
"updateBy": "",
"updateById": ""
},
"eventState": "ACTIVE",
"metricKey": "system.cpu.system.norm.pct",
"metricName": "system.cpu.system.norm.pct",
"metricSummary": {
"isLogMetric": "N",
"isObjectExist": "Y",
"metricDescription": "커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%)",
"metricDescriptionEn": "Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%)",
"metricKey": "system.cpu.system.pct",
"metricName": "system.cpu.system.pct",
"metricSetKey": "system.cpu",
"metricSetName": "CPU",
"metricType": "NUM",
"metricUnit": "bytes",
"productTargetType": "system.core.id 별",
"productTargetTypeEn": "By system.core.id"
},
"objectDisplayName": "CPU0",
"objectName": "CPU0",
"objectType": "cluster",
"objectTypeName": "Cluster",
"productIpAddress": "192.168.1.2",
"productName": "VM-002",
"productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp",
"productSummary": {
"agentState": "Running",
"lbName": "lbName",
"lbSize": "MEDIUM",
"productIpAddress": "192.168.1.2",
"productName": "VM-002",
"productResourceId": "INSTANCE-c4Hsd27ttDaLw533X4B6Sp",
"productSq": 8703,
"productState": "Running",
"productSubName": "productSubName",
"productSubType": "replicaset",
"productTypeCode": "VM",
"productTypeName": "Virtual Server",
"vpcName": "vpcName"
},
"productTypeCode": "VM",
"startDt": "2021-10-23T18:00:00Z"
}
2.2 - Models
2.2.1 - AccountProductDto
| Name | Description | Schema | Default |
|---|---|---|---|
| accountId required | 프로젝트 아이디 Example : UqXgOSnoqOfKB0_LKO6xId | string | |
| endDt optional | 상품 삭제 일시 Example : 9999-12-31T23:59:59.999Z | string (date-time) | |
| lastEventLevel optional | 최종 이벤트 레벨 Example : WARNING | string | |
| poolName optional | 풀 이름 Example : POOL-A8-C1DpGqRdQMlfNXdJxLb | string | |
| productIpAddress optional | 상품 IP주소 Example : 192.168.245.161 | string | |
| productName required | 상품 이름 Example : VM-Server-01 | string | |
| productResourceId required | 상품 리소스 아이디 Example : INSTANCE-c4Hsd27ttDaLw533X4B6Sp | string | |
| productState required | 상품 상태 - 유효한 값 : Running, Down Example : Running | string | |
| productTypeCode required | 상품 유형코드 Example : VM | string | |
| productTypeName required | 상품 유형이름 Example : Virtual Server | string | |
| startDt required | 상품 생성 일시 Example : 2021-10-23T08:30:00Z | string (date-time) |
2.2.2 - AddrbookAdditionalInfo
| Name | Description | Schema | Default |
|---|---|---|---|
| memberCount required | 멤버수 Example : 4 | integer | |
| userAdditionalInfo optional | array[Member] |
2.2.3 - AlarmAddrBookDto
| Name | Description | Schema | Default |
|---|---|---|---|
| addrBookName required | 주소록 이름 Example : contact name | string | |
| addrbookId required | 주소록 아이디 Example : 74 | string | |
| createdBy required | 생성자 아이디 Example : 1984 | string | |
| createdByName required | 생성자 이름 Example : 김삼성 | string | |
| createdDt required | 생성 일시 Example : 2021-10-23T22:00:00Z | string (date-time) | |
| memberCount required | 멤버 수 Example : 10 | integer |
2.2.4 - AlarmAddrBookMemberDto
| Name | Description | Schema | Default |
|---|---|---|---|
| userEmail required | 사용자 이메일 Example : kdhong@cloud.com | string | |
| userId required | 사용자 리소스 아이디 Example : 1346 | string | |
| userLanguage required | 사용자 언어 Example : ko | string | |
| userMobileTelNo optional | 사용자 휴대전화번호 Example : 010-0000-0000 | string | |
| userName required | 사용자 이름 Example : 홍길동 | string | |
| userTimezone required | 사용자 타임존 Example : Asia/Seoul | string |
2.2.5 - EventDetailResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| durationSecond required | 이벤트 지속 시간 - 단위: 초 Example : 100 | integer | |
| endDt optional | 종료일시 Example : 2021-10-23T23:59:59Z | string (date-time) | |
| eventId required | 이벤트 아이디 Example : | string | |
| eventLevel required | 이벤트 레벨 Example : FATAL | string | |
| eventMessage required | 이벤트 메시지 Example : | string | |
| eventPolicyId optional | 이벤트 정책 아이디 Example : 7240 | integer | |
| eventPolicySummary required | EventPolicyResponse | ||
| eventState required | Event State Example : ACTIVE | string | |
| metricKey required | 메트릭 키 Example : system.cpu.system.norm.pct | string | |
| metricName optional | 메트릭 이름 Example : system.cpu.system.norm.pct | string | |
| metricSummary required | MetricSummary | ||
| objectDisplayName optional | 오브젝트 이름 Example : CPU0 | string | |
| objectName optional | 오브젝트 이름 Example : CPU0 | string | |
| objectType optional | 개별항목 유형 Example : cluster | string | |
| objectTypeName optional | 개별항목 유형 이름 Example : Cluster | string | |
| productIpAddress optional | 상품 IP주소 Example : 192.168.1.2 | string | |
| productName optional | 상품 이름 Example : VM-002 | string | |
| productResourceId required | 상품 리소스 아이디 Example : INSTANCE-c4Hsd27ttDaLw533X4B6Sp | string | |
| productSummary required | ProductSummary | ||
| productTypeCode optional | 상품 유형 코드 Example : VM | string | |
| startDt required | 시작일시 Example : 2021-10-23T18:00:00Z | string (date-time) |
2.2.6 - EventNotificationResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| notificationStates required | 이벤트 알림 상태 | array[NotificationStatus] | |
| user optional | Example : | object | |
| userEmail optional | 사용자 이메일 Example : kdhong@cloud.com | string | |
| userId required | 사용자 아이디 Example : 1984 | string | |
| userMobileTelNo optional | 사용자 휴대 전화번호 Example : 010-000-0000 | string | |
| userNameNotification required | 사용자 이름 Example : 홍길동 | string |
2.2.7 - EventPolicyCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| eventPolicyRequest required | EventPolicyInfo | ||
| notificationRecipients optional | 이벤트 알림 수신인 정보 - 알림 대상자 정보는 10개까지 지정할 수 있습니다. | array[NotificationRecipient] | |
| productResourceId required | Product Resource ID - Product Resource ID can be viewed using @[ListAccountResources]. Example : INSTANCE-c4Hsd27ttDaLw533X4B6Sp | string |
2.2.8 - EventPolicyDetailResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| asgYn optional | Example : | string | |
| attrListStr optional | Example : | string | |
| checkAsg optional | Example : | boolean | |
| createBy optional | Example : | object | |
| createById optional | Example : | string | |
| createdBy optional | Example : | string | |
| createdByName optional | Example : | string | |
| createdDt optional | Example : 2026-02-11T06:41:19.229Z | string (date-time) | |
| disableObject optional | swagger.event.eventPolicyResponse.disableObject.value Example : N | string | |
| disableYn optional | Example : | string | |
| displayEventRule optional | swagger.event.eventResponse.displayEventRule.value Example : SCP | string | |
| eventLevel required | 이벤트 레벨 Example : WARNING | string | |
| eventMessagePrefix optional | 이벤트 메시지 접두사 Example : SCP | string | |
| eventOccurTimeZone optional | swagger.event.eventPolicyResponse.eventOccurTimeZone.value Example : GMT+9 | string | |
| eventPolicyId required | 이벤트 정책 아이디 Example : 7226 | integer | |
| eventPolicyStatistics optional | EventPolicyStatistics | ||
| eventThreshold required | EventThreshold | ||
| ftCount required | 결함허용 개수 - 설정한 조건에 맞는 값이 몇 번 반복해서 발생하면 이벤트를 발생시킬지 설정하는 값 Example : 3 | integer | |
| groupSummary optional | GroupSummary | ||
| isLogMetric required | 로그 메트릭 여부 Example : N | string | |
| metricDescription optional | 메트릭 설명 Example : 커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%) | string | |
| metricDescriptionEn optional | 메트릭 설명 Example : Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%) | string | |
| metricKey required | 메트릭 키 Example : system.cpu.system.pct | string | |
| metricName optional | 메트릭 이름 Example : system.cpu.system.pct | string | |
| metricSummary required | MetricSummary | ||
| metricType optional | 메트릭 유형 Example : NUM | string | |
| metricUnit optional | 메트릭 단위 Example : % | string | |
| modifiedBy optional | Example : | string | |
| modifiedByName optional | Example : | string | |
| modifiedDt optional | Example : 2026-02-11T06:41:19.230Z | string (date-time) | |
| objectDisplayName optional | 오브젝트 이름 Example : /tmp | string | |
| objectName optional | 오브젝트 이름 Example : /tmp | string | |
| objectType optional | 개별항목 유형 Example : cluster | string | |
| objectTypeName optional | 개별항목 유형 이름 Example : cluster | string | |
| productInfoAttrs optional | 상품 정보 속성 Example : [{'attrName': 'type', 'attrValue': 'test'}] | array[ProductInfoAttr] | |
| productName optional | 상품 이름 Example : adad-002 | string | |
| productResourceId optional | 상품 리소스 아이디 Example : INSTANCE-c4Hsd27ttDaLw533X4B6Sp | string | |
| productSq optional | 상품 시퀀스 Example : 7234 | integer | |
| productSummary required | ProductSummary | ||
| productTargetType optional | 메트릭 대상 유형 Example : system.core.id 별 | string | |
| productTargetTypeEn optional | 메트릭 대상 유형 Example : By system.core.id | string | |
| startDt optional | 시작일시 Example : 2021-10-23T18:00:00Z | string (date-time) | |
| updateBy optional | Example : | object | |
| updateById optional | Example : | string | |
| userNameList optional | 사용자 이름 Example : ['userName', 'userName'] | array[string] | |
| userNameStr optional | Example : | string | |
| userNames optional | swagger.event.eventPolicyResponse.disableObject.value Example : N | string |
2.2.9 - EventPolicyHistoryResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| createBy optional | Example : | object | |
| createById optional | Example : | string | |
| disableObject optional | swagger.event.eventPolicyResponse.disableObject.value Example : N | string | |
| disableYn optional | swagger.event.eventPolicyResponse.disableObject.value Example : N | string | |
| eventLevel required | 이벤트 레벨 Example : WARNING | string | |
| eventMessagePrefix optional | 이벤트 메시지 접두사 Example : SCP | string | |
| eventOccurTimeZone optional | swagger.event.eventPolicyResponse.eventOccurTimeZone.value Example : GMT+9 | string | |
| eventPolicyHistoryId required | 이벤트 정책 이력 아이디 Example : 8759 | integer | |
| eventPolicyHistoryType required | 이벤트 정책 이력 유형 - C : 등록, U : 수정, D : 삭제 Example : U | string | |
| eventPolicyId optional | 이벤트 정책 아이디 Example : 7240 | integer | |
| eventPolicyStatistics optional | EventPolicyStatistics | ||
| eventThreshold required | EventThreshold | ||
| ftCount required | 결함허용 개수 Example : 3 | integer | |
| metricDescription optional | 메트릭 설명 Example : 커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%) | string | |
| metricDescriptionEn optional | 메트릭 설명 Example : Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%) | string | |
| metricKey required | 메트릭 키 Example : system.cpu.system.pct | string | |
| metricName required | 메트릭 이름 Example : system.cpu.system.pct | string | |
| metricUnit optional | 메트릭 단위 Example : % | string | |
| modifiedBy optional | Example : | string | |
| modifiedByName optional | Example : | string | |
| modifiedDt optional | Example : 2026-02-11T06:41:19.370Z | string (date-time) | |
| notificationRecipientHistory optional | NotificationRecipientHistory | ||
| objectDisplayName optional | 오브젝트 이름 Example : cpu0 | string | |
| objectName optional | 오브젝트 이름 Example : cpu0 | string | |
| objectType optional | 개별항목 유형 Example : cluster | string | |
| productName required | 상품 이름 Example : VM-Server-01 | string | |
| productResourceId required | 상품 리소스 아이디 Example : INSTANCE-c4Hsd27ttDaLw533X4B6Sp | string | |
| productTargetType optional | 메트릭 대상 유형 Example : system.core.id 별 | string | |
| productTargetTypeEn optional | 메트릭 대상 유형 Example : By system.core.id | string | |
| updateBy optional | Example : | object | |
| updateById optional | Example : | string |
2.2.10 - EventPolicyInfo
| Name | Description | Schema | Default |
|---|---|---|---|
| disableYn required | swagger.event.eventPolicyResponse.disableYn.value Example : N | string | |
| eventLevel required | 이벤트 레벨 Example : WARNING | string | |
| eventMessagePrefix optional | 이벤트 메시지 접두사 Example : SCP | string | |
| eventOccurTimeZone optional | swagger.event.eventPolicyResponse.eventOccurTimeZone.value Example : GMT+9 | string | |
| eventPolicyStatistics optional | EventPolicyStatistics | ||
| eventThreshold required | EventThreshold | ||
| ftCount required | 결함허용 개수 - 설정한 조건에 맞는 값이 몇 번 반복해서 발생하면 이벤트를 발생시킬지 설정하는 값 Example : 3 | integer | |
| isLogMetric required | 로그 메트릭 여부 Example : N | string | |
| metricKey required | 메트릭 키 Example : system.diskio.read.bytes | string | |
| metricName optional | Example : | string | |
| objectDisplayName optional | 오브젝트 이름 Example : dm0 | string | |
| objectName optional | 오브젝트 이름 Example : dm0 | string | |
| objectType optional | 개별항목 유형 Example : SCP | string | |
| podObjectDisplayName optional | swagger.event.eventPolicyResponse.podObjectDisplayName.value Example : dm0 | string | |
| podObjectName optional | swagger.event.eventPolicyResponse.podObjectName.value Example : dm0 | string |
2.2.11 - EventPolicyInfoEditable
| Name | Description | Schema | Default |
|---|---|---|---|
| disableYn required | swagger.event.eventPolicyResponse.disableYn.value Example : N | string | |
| eventLevel required | 이벤트 레벨 Example : WARNING | string | |
| eventMessagePrefix optional | 이벤트 메시지 접두사 Example : SCP | string | |
| eventOccurTimeZone optional | swagger.event.eventPolicyResponse.eventOccurTimeZone.value Example : GMT+9 | string | |
| eventPolicyStatistics optional | EventPolicyStatistics | ||
| eventThreshold required | EventThreshold | ||
| ftCount required | 결함허용 개수 - 설정한 조건에 맞는 값이 몇 번 반복해서 발생하면 이벤트를 발생시킬지 설정하는 값 Example : 3 | integer | |
| objectDisplayName optional | 오브젝트 이름 Example : cpu0 | string | |
| objectName optional | 오브젝트 이름 Example : cpu0 | string | |
| objectType optional | 개별항목 유형 Example : cluster | string | |
| podObjectDisplayName optional | swagger.event.eventPolicyResponse.podObjectName.value Example : cpu0 | string | |
| podObjectName optional | swagger.event.eventPolicyResponse.podObjectName.value Example : cpu0 | string |
2.2.12 - EventPolicyResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| checkAsg optional | Example : | boolean | |
| createBy optional | Example : | object | |
| createById optional | Example : | string | |
| eventLevel required | 이벤트 레벨 Example : WARNING | string | |
| eventMessagePrefix optional | 이벤트 메시지 접두사 Example : SCP | string | |
| eventOccurTimeZone optional | swagger.event.eventPolicyResponse.eventOccurTimeZone.value Example : GMT+9 | string | |
| eventPolicyId required | 이벤트 정책 아이디 Example : 7226 | integer | |
| eventPolicyStatistics optional | EventPolicyStatistics | ||
| eventThreshold required | EventThreshold | ||
| ftCount required | 결함허용 개수 - 설정한 조건에 맞는 값이 몇 번 반복해서 발생하면 이벤트를 발생시킬지 설정하는 값 Example : 3 | integer | |
| isLogMetric required | 로그 메트릭 여부 Example : N | string | |
| metricDescription optional | 메트릭 설명 Example : 커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%) | string | |
| metricDescriptionEn optional | 메트릭 설명 Example : Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%) | string | |
| metricKey required | 메트릭 키 Example : system.cpu.system.pct | string | |
| metricName required | 메트릭 이름 Example : system.cpu.system.pct | string | |
| objectName optional | 오브젝트 이름 Example : cpu0 | string | |
| productName required | 상품 이름 Example : VM-002 | string | |
| productResourceId required | 상품 리소스 아이디 Example : INSTANCE-c4Hsd27ttDaLw533X4B6Sp | string | |
| productSq required | 상품 시퀀스 Example : 7321 | integer | |
| productTargetType optional | 메트릭 대상 유형 Example : system.core.id 별 | string | |
| productTargetTypeEn optional | 메트릭 대상 유형 Example : By system.core.id | string | |
| updateBy optional | Example : | object | |
| updateById optional | Example : | string |
2.2.13 - EventPolicyStatistics
| Name | Description | Schema | Default |
|---|---|---|---|
| eventPolicyStatisticsPeriod required | 이벤트 정책 통계 기간 - 단위: 분 Example : 10 | integer | |
| eventPolicyStatisticsType required | 이벤트 정책 통계 유형 Example : MAX | string |
2.2.14 - EventPolicyUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| eventPolicyRequest required | EventPolicyInfoEditable | ||
| notificationRecipients optional | 이벤트 알림 수신인 정보 | array[NotificationRecipient] |
2.2.15 - EventThreshold
| Name | Description | Schema | Default |
|---|---|---|---|
| metricFunction optional | 메트릭 함수 - 유효한 값: [delta] - 이벤트 발생 여부를 판단하기 위해 성능항목의 현재 값을 사용할지, 이전 값과 현재 값의 차이를 사용할지를 지정합니다. - 이전 값과 현재 값의 차이를 사용하고자 할 경우에만 delta로 지정합니다. Example : delta | string | |
| rangeThreshold optional | RangeThreshold | ||
| singleThreshold optional | SingleThreshold | ||
| thresholdType required | 임계치 유형 - 임계치를 범위로 지정할 경우에는 “RANGE_VALUE"를, 임계치를 단일값으로 지정할 경우에는 “SINGLE_VALUE” 지정해야 합니다. Example : RANGE_VALUE | string |
2.2.16 - GroupSummary
| Name | Description | Schema | Default |
|---|---|---|---|
| groupName optional | Example : | string | |
| groupResourceId optional | Example : | string | |
| groupSq optional | Example : | integer | |
| productList optional | array[ProductList] | ||
| productTypeCode optional | Example : | string | |
| productTypeName optional | Example : | string |
2.2.17 - ListResponseMetricStatisticsDataDtoOpenAPIV2
| Name | Description | Schema | Default |
|---|---|---|---|
| contents optional | array[MetricStatisticsDataDtoOpenAPIV2] | ||
| totalCount optional | Example : | integer |
2.2.18 - Member
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id optional | Example : | string | |
| company_name optional | Example : | string | |
| dst_offset optional | Example : | string | |
| email optional | Example : | string | |
| id optional | Example : | string | |
| last_login_at optional | Example : | string | |
| member_created_at optional | Example : | string | |
| password_reuse_count optional | Example : | integer | |
| timezone optional | Example : | string | |
| tz_id optional | Example : | string | |
| user_name optional | Example : | string | |
| utc_offset optional | Example : | string |
2.2.19 - MetricDataConditionOpenAPIV2
| Name | Description | Schema | Default |
|---|---|---|---|
| metricKey required | 메트릭 Example : system.diskio.read.bytes | string | |
| objectType optional | 개별항목 유형 Example : replicaset | string | |
| productResourceInfos required | 상품 리소스 아이디 목록 - 상품 리소스 아이디는 50개까지 지정할 수 있습니다. | array[ProductResourceInfo] | |
| statisticsPeriod optional | 통계 집계 주기 (단위: 분) Example : 5 | integer | |
| statisticsTypeList optional | 통계 유형 - 유효한 값 : MIN, MAX, AVG, SUM Example : ['SUM', 'MIN'] | array[string] |
2.2.20 - MetricDataSearchCriteriaOpenAPIV2
| Name | Description | Schema | Default |
|---|---|---|---|
| ignoreInvalid optional | 유효하지 않은 값 제외 여부 Example : Y | string | |
| metricDataConditions required | 메트릭 데이터 조건 | array[MetricDataConditionOpenAPIV2] | |
| queryEndDt required | 조회 종료 일시 Example : 2022-08-07T23:59:00.000Z | string | |
| queryStartDt required | 조회 시작 일시 Example : 2022-08-07T23:50:00.000Z | string |
2.2.21 - MetricInfoDto
| Name | Description | Schema | Default |
|---|---|---|---|
| disableObject optional | swagger.product.MetricInfoDto.disableObject.value Example : N | string | |
| displayUnit optional | Example : | string | |
| fixedUnit optional | 메트릭 단위 (고정) Example : sec | string | |
| isLogMetric required | 로그 메트릭 여부 Example : N | string | |
| isObjectExist required | 개별항목 성능 존재 여부 Example : Y | string | |
| metricDescription optional | 메트릭 설명 Example : 커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%) | string | |
| metricDescriptionEn optional | 메트릭 설명 Example : Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%) | string | |
| metricKey required | 메트릭 키 Example : system.filesystem.used.bytes | string | |
| metricName required | 메트릭 이름 Example : FileSystem | string | |
| metricOrder optional | 메트릭 순서 Example : 1 | integer | |
| metricSetKey required | swagger.product.MetricInfoDto.metricSetKey.value Example : system.filesystem | string | |
| metricSetName required | 메트릭 세트 이름 Example : FileSystem | string | |
| metricType required | 메트릭 유형 Example : NUM | string | |
| metricUnit optional | 메트릭 단위 Example : bytes | string | |
| objectKeyName required | 오브젝트 키 이름 Example : system.core.iowait.pct | string | |
| objectType optional | swagger.product.MetricInfoDto.disableObject.value Example : N | string | |
| objectTypeNameEng optional | swagger.product.MetricInfoDto.disableObject.value Example : N | string | |
| objectTypeNameLoc optional | swagger.product.MetricInfoDto.disableObject.value Example : N | string | |
| perfTitle required | swagger.product.MetricInfoDto.perfTitle.value Example : File System | string | |
| productTargetType optional | 메트릭 대상 유형 Example : system.core.id 별 | string | |
| productTargetTypeEn optional | 메트릭 대상 유형 Example : By system.core.id | string | |
| productTypeCode required | 상품 유형 코드 Example : VM | string | |
| productTypeName required | 상품 유형 이름 Example : Virtual Server | string |
2.2.22 - MetricStatisticsDataDtoOpenAPIV2
| Name | Description | Schema | Default |
|---|---|---|---|
| metricKey optional | 메트릭 키 Example : system.filesystem.used.bytes | string | |
| metricName optional | 메트릭 이름 Example : system.filesystem.used.bytes | string | |
| metricType optional | 메트릭 유형 Example : NUM | string | |
| metricUnit optional | 메트릭 단위 Example : bytes | string | |
| objectDisplayName optional | 개별항목 출력 이름 Example : dm-1 | string | |
| objectName optional | 개별항목 이름 Example : dm-1 | string | |
| objectType optional | 개별항목 유형 Example : replicaset | string | |
| perfData optional | 성능 데이터 Example : [{'time': 1627378200000, 'value': '0.0766'}] | array[object] | |
| productName optional | 상품의 이름 Example : VM-Server-01 | string | |
| productResourceId optional | 상품 리소스 아이디 Example : INSTANCE-c4Hsd27ttDaLw533X4B6Sp | string | |
| statisticsPeriod required | 통계 집계 주기 (단위: 분) Example : 5 | integer | |
| statisticsType required | 통계 유형 Example : SUM | string |
2.2.23 - MetricSummary
| Name | Description | Schema | Default |
|---|---|---|---|
| isLogMetric required | 로그 메트릭 여부 Example : N | string | |
| isObjectExist required | 오브젝트 존재여부 Example : Y | string | |
| metricDescription optional | 메트릭 설명 Example : 커널에서 사용한 CPU 시간의 백분율 (core 4개 모두를 100%사용하는 경우 : 400%) | string | |
| metricDescriptionEn optional | 메트릭 설명 Example : Percentage of CPU time used in the kernel (if 100% of all 4 cores are used: 400%) | string | |
| metricKey required | 메트릭 키 Example : system.cpu.system.pct | string | |
| metricName required | 메트릭 이름 Example : system.cpu.system.pct | string | |
| metricSetKey required | 메트릭 셋 키 Example : system.cpu | string | |
| metricSetName required | 메트릭 셋 이름 Example : CPU | string | |
| metricType required | 메트릭 유형 Example : NUM | string | |
| metricUnit required | 메트릭 단위 Example : bytes | string | |
| productTargetType optional | 메트릭 대상 유형 Example : system.core.id 별 | string | |
| productTargetTypeEn optional | 메트릭 대상 유형 Example : By system.core.id | string |
2.2.24 - NotificationMethod
| Name | Description | Schema | Default |
|---|---|---|---|
| eventLevel required | 이벤트 레벨 Example : FATAL | string | |
| notificationMethod optional | Example : | string | |
| sendMethod required | 전송 메소드 - 허용 값: MESSENGER, SMS, MAIL Example : ['MAIL'] | array[string] |
2.2.25 - NotificationRecipient
| Name | Description | Schema | Default |
|---|---|---|---|
| notificationMethods required | 알림 메소드 | array[NotificationMethod] | |
| recipientKey required | 수신인 키 - 수신인 키는 @[프로젝트 멤버 조회] 또는 @[사용자의 주소록 목록 조회]를 이용하여 조회합니다. Example : 1347 | string | |
| recipientType required | 수신인 유형 - USER : 사용자, ADDRBOOK : 주소록 Example : USER | string |
2.2.26 - NotificationRecipientHistory
| Name | Description | Schema | Default |
|---|---|---|---|
| addrbookIds optional | 주소록 아이디 | array[integer] | |
| userIds optional | 사용자 아이디 | array[string] | |
| userNames optional | 사용자 이름 | array[string] |
2.2.27 - NotificationResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| addrbookAdditionalInfo optional | AddrbookAdditionalInfo | ||
| notificationMethods required | 알림 메소드 정보 | array[NotificationMethod] | |
| recipientKey required | 수신인 키 - 수신인 키는 @[프로젝트 멤버 조회] 또는 @[사용자의 주소록 목록 조회]를 이용하여 조회합니다. Example : 1984 | string | |
| recipientName required | 수신인 이름 Example : 홍길동 | string | |
| recipientType required | 수신인 유형 - USER : 사용자, ADDRBOOK : 주소록 Example : USER | string | |
| userAdditionalInfo optional | Member |
2.2.28 - NotificationStatus
| Name | Description | Schema | Default |
|---|---|---|---|
| errorMsg optional | swagger.event.notificationStatus.errorMsg.value Example : SMS Send become Inactive. | string | |
| sendDt optional | 전송일시 Example : 2021-10-23T18:00:00Z | string (date-time) | |
| sendMethod optional | 전송 메소드 Example : MAIL | string | |
| sendResult optional | 전송 결과 - SUCCESS : 전송 성공 - FAIL : 전송을 시도했으나 전송 실패 - NOT SEND : 전송 메소드 미설정으로 전송 안함 - FILTERED : 알림 필터링 설정으로 전송 안함 - NO PERMISSION : 권한이 없어 전송 안함 Example : SUCCESS | string |
2.2.29 - OpenApiEventResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| durationSecond required | 이벤트 지속 시간 - 단위: 초 Example : 100 | integer | |
| endDt optional | 종료일시 Example : 2021-10-23T23:59:59Z | string (date-time) | |
| eventId required | 이벤트 아이디 Example : | string | |
| eventLevel required | 이벤트 레벨 Example : FATAL | string | |
| eventMessage required | 이벤트 메시지 Example : | string | |
| eventPolicyId required | 이벤트 정책 아이디 Example : 7240 | integer | |
| eventState required | Event State Example : ACTIVE | string | |
| metricKey required | 메트릭 키 Example : system.cpu.system.norm.pct | string | |
| metricName required | 메트릭 이름 Example : system.cpu.system.norm.pct | string | |
| objectDisplayName optional | 오브젝트 이름 Example : CPU0 | string | |
| objectName optional | 오브젝트 이름 Example : CPU0 | string | |
| objectType optional | 개별항목 유형 Example : cluster | string | |
| objectTypeName optional | 개별항목 유형 이름 Example : cluster | string | |
| productResourceId required | 상품 리소스 아이디 Example : INSTANCE-c4Hsd27ttDaLw533X4B6Sp | string | |
| productTargetType optional | 메트릭 대상 유형 Example : system.core.id 별 | string | |
| productTargetTypeEn optional | 메트릭 대상 유형 Example : By system.core.id | string | |
| productTypeName required | 상품 유형 이름 Example : Virtual Server | string | |
| startDt required | 시작일시 Example : 2021-10-23T18:00:00Z | string (date-time) |
2.2.30 - PageResponseAccountProductDto
| Name | Description | Schema | Default |
|---|---|---|---|
| contents optional | array[AccountProductDto] | ||
| isChanged optional | Example : | boolean | |
| returnCount optional | Example : | integer | |
| returnPage optional | Example : | integer | |
| sort optional | array[string] | ||
| sortableFields optional | array[string] | ||
| totalCount optional | Example : | integer |
2.2.31 - PageResponseAlarmAddrBookDto
| Name | Description | Schema | Default |
|---|---|---|---|
| contents optional | array[AlarmAddrBookDto] | ||
| isChanged optional | Example : | boolean | |
| returnCount optional | Example : | integer | |
| returnPage optional | Example : | integer | |
| sort optional | array[string] | ||
| sortableFields optional | array[string] | ||
| totalCount optional | Example : | integer |
2.2.32 - PageResponseAlarmAddrBookMemberDto
| Name | Description | Schema | Default |
|---|---|---|---|
| contents optional | array[AlarmAddrBookMemberDto] | ||
| isChanged optional | Example : | boolean | |
| returnCount optional | Example : | integer | |
| returnPage optional | Example : | integer | |
| sort optional | array[string] | ||
| sortableFields optional | array[string] | ||
| totalCount optional | Example : | integer |
2.2.33 - PageResponseEventNotificationResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| contents optional | array[EventNotificationResponse] | ||
| isChanged optional | Example : | boolean | |
| returnCount optional | Example : | integer | |
| returnPage optional | Example : | integer | |
| sort optional | array[string] | ||
| sortableFields optional | array[string] | ||
| totalCount optional | Example : | integer |
2.2.34 - PageResponseEventPolicyHistoryResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| contents optional | array[EventPolicyHistoryResponse] | ||
| isChanged optional | Example : | boolean | |
| returnCount optional | Example : | integer | |
| returnPage optional | Example : | integer | |
| sort optional | array[string] | ||
| sortableFields optional | array[string] | ||
| totalCount optional | Example : | integer |
2.2.35 - PageResponseEventPolicyResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| contents optional | array[EventPolicyResponse] | ||
| isChanged optional | Example : | boolean | |
| returnCount optional | Example : | integer | |
| returnPage optional | Example : | integer | |
| sort optional | array[string] | ||
| sortableFields optional | array[string] | ||
| totalCount optional | Example : | integer |
2.2.36 - PageResponseJsonArrayProjectMemberResponseForOpenAPI
| Name | Description | Schema | Default |
|---|---|---|---|
| contents optional | Contents | array[ProjectMemberResponseForOpenAPI] | |
| returnCount optional | Return Count Example : 10 | integer | |
| returnPage optional | Return Page Example : 1 | integer | |
| sort optional | Sorting Field List | array[string] | |
| sortableFields optional | Sortable Field List | array[string] | |
| totalCount optional | Total Count Example : 100 | integer |
2.2.37 - PageResponseMetricInfoDto
| Name | Description | Schema | Default |
|---|---|---|---|
| contents optional | array[MetricInfoDto] | ||
| isChanged optional | Example : | boolean | |
| returnCount optional | Example : | integer | |
| returnPage optional | Example : | integer | |
| sort optional | array[string] | ||
| sortableFields optional | array[string] | ||
| totalCount optional | Example : | integer |
2.2.38 - PageResponseNotificationResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| contents optional | array[NotificationResponse] | ||
| isChanged optional | Example : | boolean | |
| returnCount optional | Example : | integer | |
| returnPage optional | Example : | integer | |
| sort optional | array[string] | ||
| sortableFields optional | array[string] | ||
| totalCount optional | Example : | integer |
2.2.39 - PageResponseOpenApiEventResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| contents optional | array[OpenApiEventResponse] | ||
| isChanged optional | Example : | boolean | |
| returnCount optional | Example : | integer | |
| returnPage optional | Example : | integer | |
| sort optional | array[string] | ||
| sortableFields optional | array[string] | ||
| totalCount optional | Example : | integer |
2.2.40 - PageResponseProductTypeInfoDto
| Name | Description | Schema | Default |
|---|---|---|---|
| contents optional | array[ProductTypeInfoDto] | ||
| isChanged optional | Example : | boolean | |
| returnCount optional | Example : | integer | |
| returnPage optional | Example : | integer | |
| sort optional | array[string] | ||
| sortableFields optional | array[string] | ||
| totalCount optional | Example : | integer |
2.2.41 - ProductInfoAttr
| Name | Description | Schema | Default |
|---|---|---|---|
| attrName optional | Example : | string | |
| attrValue optional | Example : | string |
2.2.42 - ProductList
| Name | Description | Schema | Default |
|---|---|---|---|
| productName optional | Example : | string | |
| productResourceId optional | Example : | string | |
| productSq optional | Example : | integer |
2.2.43 - ProductResourceInfo
| Name | Description | Schema | Default |
|---|---|---|---|
| objectList optional | 개별항목 목록 Example : ['kube-01', 'kube-02'] | array[string] | |
| productResourceId required | 상품 리소스 아이디 Example : INSTANCE-c4Hsd27ttDaLw533X4B6Sp | string |
2.2.44 - ProductSummary
| Name | Description | Schema | Default |
|---|---|---|---|
| agentState required | 상품 상태 Example : Running | string | |
| lbName optional | swagger.event.productSummary.lbName.value Example : lbName | string | |
| lbSize optional | swagger.event.productSummary.lbSize.value Example : MEDIUM | string | |
| productIpAddress optional | 상품 IP주소 Example : 192.168.1.2 | string | |
| productName required | 상품 이름 Example : VM-002 | string | |
| productResourceId required | 상품 리소스 아이디 Example : INSTANCE-c4Hsd27ttDaLw533X4B6Sp | string | |
| productSq optional | 상품 시퀀스 Example : 8703 | integer | |
| productState required | 상품 상태 Example : Running | string | |
| productSubName optional | swagger.event.productSummary.productSubName.value Example : productSubName | string | |
| productSubType optional | swagger.event.productSummary.productSubType.value Example : replicaset | string | |
| productTypeCode required | 상품 유형 코드 Example : VM | string | |
| productTypeName required | 상품 유형 이름 Example : Virtual Server | string | |
| vpcName optional | swagger.event.productSummary.vpcName.value Example : vpcName | string |
2.2.45 - ProductTypeInfoDto
| Name | Description | Schema | Default |
|---|---|---|---|
| parentProductTypeName required | 부모 상품 이름 Example : Compute | string | |
| productTypeCode required | 상품 코드 Example : VM | string | |
| productTypeName required | 상품 이름 Example : Virtual Server | string | |
| stateMetricKey required | 상태 메트릭 키 Example : vsphere.mxvm.runtime.state | string |
2.2.46 - ProjectMemberResponseForOpenAPI
| Name | Description | Schema | Default |
|---|---|---|---|
| companyName optional | swagger.product.ProjectMemberDto.companyName.value Example : 삼성SDS | string | |
| createdBy optional | swagger.product.ProjectMemberDto.createdBy.value Example : 469 | string | |
| createdByEmail optional | swagger.product.ProjectMemberDto.createdByEmail.value Example : soonshin.lee@cloud.com | string | |
| createdByName optional | swagger.product.ProjectMemberDto.createdByName.value Example : 이순신 | string | |
| createdDt optional | swagger.product.ProjectMemberDto.userTimezone.value Example : 2021-08-06T10:23:41.547Z | string | |
| email optional | swagger.product.ProjectMemberDto.userEmail.value Example : kdhong@cloud.com | string | |
| lastAccessDt optional | swagger.product.ProjectMemberDto.lastAccessDt.value Example : 2022-11-06T10:23:41.547Z | string | |
| modifiedBy optional | swagger.product.ProjectMemberDto.modifiedBy.value Example : 469 | string | |
| modifiedByEmail optional | swagger.product.ProjectMemberDto.modifiedByEmail.value Example : soonshin.lee@cloud.com | string | |
| modifiedByName optional | swagger.product.ProjectMemberDto.modifiedByName.value Example : 이순신 | string | |
| modifiedDt optional | swagger.product.ProjectMemberDto.modifiedDt.value Example : 2021-08-06T10:23:41.547Z | string | |
| organizationId optional | swagger.product.ProjectMemberDto.organizationId.value Example : | string | |
| positionName optional | swagger.product.ProjectMemberDto.positionName.value Example : 프로 | string | |
| userGroupCount optional | swagger.product.ProjectMemberDto.userGroupCount.value Example : 10 | string | |
| userId optional | swagger.product.ProjectMemberDto.userId.value Example : 1984 | string | |
| userName optional | swagger.product.ProjectMemberDto.userName.value Example : 홍길동 | string |
2.2.47 - RangeThreshold
| Name | Description | Schema | Default |
|---|---|---|---|
| maxComparisonOperator required | 최대 비교 연산자 Example : LT | string | |
| maxValue required | 최대 값 Example : 90 | object | |
| minComparisonOperator required | 최소 비교 연산자 Example : GT | string | |
| minValue required | 최소 값 Example : 80 | object |
2.2.48 - SingleThreshold
| Name | Description | Schema | Default |
|---|---|---|---|
| comparisonOperator required | 비교 연산자 Example : LT | string | |
| value required | 값 Example : 10 | object |
3 - IAM
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.
본 가이드는 IAM 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | DEPRECATED | 20260223 |
| 1.1 | SUPPORTED | 20260531 |
| 1.2 | CURRENT | - |
OpenAPI URL
https://iam.{environment}.samsungsdscloud.com
Environment and Region List
| environment | region |
|---|---|
| s | kr-west1 |
| s | kr-east1 |
| g | kr-south1 |
| g | kr-south2 |
| g | kr-south3 |
| e | kr-west1 |
| e | kr-east1 |
3.1 - APIs
3.1.1 - Add a permission into the resource based policy
3.1.1.1 - 1.2
post /v1/resource-policies/{srn}/statements
Description
Add a permission into the resource based policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | srn required | 삼성 리소스 자원명 Example : c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= | string | None |
| body | body required | StatementCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | StatementResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/resource-policies/{srn}/statements
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Request body
{
"Action": [
"virtualserver:ShowVirtualServer"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": "*",
"Resource": [
"srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666"
],
"Sid": "Statement1"
}
Example HTTP response
Response 201
{
"Statement": {
"Action": [
"virtualserver:ShowVirtualServer"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"Principal": "*",
"Resource": [
"srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666"
],
"Sid": "Statement1"
}
}
3.1.1.2 - 1.1
post /v1/resource-policies/{srn}/statements
Description
Add a permission into the resource based policy
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | srn required | 삼성 리소스 자원명 Example : c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= | string | None |
| body | body required | StatementCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | StatementResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/resource-policies/{srn}/statements
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Request body
{
"Action": [
"virtualserver:ShowVirtualServer"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": "*",
"Resource": [
"srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666"
],
"Sid": "Statement1"
}
Example HTTP response
Response 201
{
"Statement": {
"Action": [
"virtualserver:ShowVirtualServer"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"Principal": "*",
"Resource": [
"srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666"
],
"Sid": "Statement1"
}
}
3.1.1.3 - 1.0
post /v1/resource-policies/{srn}/statements
Description
Add a permission into the resource based policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | srn required | 삼성 리소스 자원명 Example : c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= | string | None |
| body | body required | StatementCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | StatementResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/resource-policies/{srn}/statements
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Request body
{
"Action": [
"virtualserver:ShowVirtualServer"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": "*",
"Resource": [
"srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666"
],
"Sid": "Statement1"
}
Example HTTP response
Response 201
{
"Statement": {
"Action": [
"virtualserver:ShowVirtualServer"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"Principal": "*",
"Resource": [
"srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666"
],
"Sid": "Statement1"
}
}
3.1.2 - Add a user to a group
3.1.2.1 - 1.2
post /v1/groups/{group_id}/members
Description
Add a user to a group
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | Group ID Example : a946662dc4314dac93da413a32457459 | string | None |
| body | body required | GroupMemberCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupMemberCreateResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}/members
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Request body
{
"user_id": "f39c460fade34fecb05ede8f904b24b7"
}
Example HTTP response
Response 200
{
"group_member": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"user_email": "samsung.kim@samsung.com",
"user_id": "f39c460fade34fecb05ede8f904b24b7",
"user_name": "Kim Samsung"
}
}
3.1.2.2 - 1.1
post /v1/groups/{group_id}/members
Description
Add a user to a group
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | Group ID Example : a946662dc4314dac93da413a32457459 | string | None |
| body | body required | GroupMemberCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupMemberCreateResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}/members
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Request body
{
"user_id": "f39c460fade34fecb05ede8f904b24b7"
}
Example HTTP response
Response 200
{
"group_member": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"user_email": "samsung.kim@samsung.com",
"user_id": "f39c460fade34fecb05ede8f904b24b7",
"user_name": "Kim Samsung"
}
}
3.1.2.3 - 1.0
post /v1/groups/{group_id}/members
Description
Add a user to a group
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | Group ID Example : a946662dc4314dac93da413a32457459 | string | None |
| body | body required | GroupMemberCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupMemberCreateResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}/members
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Request body
{
"user_id": "f39c460fade34fecb05ede8f904b24b7"
}
Example HTTP response
Response 200
{
"group_member": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"user_email": "samsung.kim@samsung.com",
"user_id": "f39c460fade34fecb05ede8f904b24b7",
"user_name": "Kim Samsung"
}
}
3.1.3 - Assign policies to the group
3.1.3.1 - 1.2
post /v1/groups/{group_id}/policy-bindings
Description
Assign policies to the group
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | Group ID Example : a946662dc4314dac93da413a32457459 | string | None |
| body | body required | GroupPolicyBindingRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupPolicyResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}/policy-bindings
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Request body
{
"policy_ids": [
"37f2e31ff86b415698d7e8eeafab445d"
]
}
Example HTTP response
Response 200
{
"policies": [
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
]
}
3.1.3.2 - 1.1
post /v1/groups/{group_id}/policy-bindings
Description
Assign policies to the group
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | Group ID Example : a946662dc4314dac93da413a32457459 | string | None |
| body | body required | GroupPolicyBindingRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupPolicyResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}/policy-bindings
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Request body
{
"policy_ids": [
"37f2e31ff86b415698d7e8eeafab445d"
]
}
Example HTTP response
Response 200
{
"policies": [
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
]
}
3.1.3.3 - 1.0
post /v1/groups/{group_id}/policy-bindings
Description
Assign policies to the group
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | Group ID Example : a946662dc4314dac93da413a32457459 | string | None |
| body | body required | GroupPolicyBindingRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupPolicyResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}/policy-bindings
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Request body
{
"policy_ids": [
"37f2e31ff86b415698d7e8eeafab445d"
]
}
Example HTTP response
Response 200
{
"policies": [
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
]
}
3.1.4 - Assign policies to user
3.1.4.1 - 1.2
post /v1/users/{user_id}/policy-bindings
Description
Assign policies to user
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | user_id required | 사용자 ID Example : | string | None |
| body | body required | UserPolicyRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | UserPolicyResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/users/{user_id}/policy-bindings
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Request body
{
"policy_ids": [
""
]
}
Example HTTP response
Response 200
{
"policies": [
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
],
"user_id": ""
}
3.1.4.2 - 1.1
post /v1/users/{user_id}/policy-bindings
Description
Assign policies to user
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | user_id required | 사용자 ID Example : | string | None |
| body | body required | UserPolicyRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | UserPolicyResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/users/{user_id}/policy-bindings
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Request body
{
"policy_ids": [
""
]
}
Example HTTP response
Response 200
{
"policies": [
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
],
"user_id": ""
}
3.1.4.3 - 1.0
post /v1/users/{user_id}/policy-bindings
Description
Assign policies to user
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | user_id required | 사용자 ID Example : | string | None |
| body | body required | UserPolicyRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | UserPolicyResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/users/{user_id}/policy-bindings
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Request body
{
"policy_ids": [
""
]
}
Example HTTP response
Response 200
{
"policies": [
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
],
"user_id": ""
}
3.1.5 - Attach policies to Role
3.1.5.1 - 1.2
post /v1/roles/{role_id}/policy-bindings
Description
Attach policies to Role
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | role_id required | 역할 ID Example : | string | None |
| body | body required | RolePolicyBindingRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | RolePolicyBindingResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/roles/{role_id}/policy-bindings
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Request body
{
"policy_ids": [
""
]
}
Example HTTP response
Response 200
{
"policies": [
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
]
}
3.1.5.2 - 1.1
post /v1/roles/{role_id}/policy-bindings
Description
Attach policies to Role
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | role_id required | 역할 ID Example : | string | None |
| body | body required | RolePolicyBindingRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | RolePolicyBindingResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/roles/{role_id}/policy-bindings
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Request body
{
"policy_ids": [
""
]
}
Example HTTP response
Response 200
{
"policies": [
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
]
}
3.1.5.3 - 1.0
post /v1/roles/{role_id}/policy-bindings
Description
Attach policies to Role
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | role_id required | 역할 ID Example : | string | None |
| body | body required | RolePolicyBindingRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | RolePolicyBindingResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/roles/{role_id}/policy-bindings
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Request body
{
"policy_ids": [
""
]
}
Example HTTP response
Response 200
{
"policies": [
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
]
}
3.1.6 - Create a group
3.1.6.1 - 1.2
post /v1/groups
Description
Create a group
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | GroupCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | GroupShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Request body
{
"description": "Descriptions for group",
"name": "TestGroup",
"policy_ids": [
"37f2e31ff86b415698d7e8eeafab445d"
],
"tags": [
{
"key": "company",
"value": "SDS"
}
],
"user_ids": [
"f39c460fade34fecb05ede8f904b24b7"
]
}
Example HTTP response
Response 201
{
"group": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"description": "Descriptions for group",
"domain_name": "scp",
"id": "f39c460fade34fecb05ede8f904b24b7",
"members": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_created_at": "2024-05-17T00:23:17Z",
"creator_email": "samsung.kim@samsung.com",
"creator_last_login_at": "2024-05-17T00:23:17Z",
"creator_name": "Kim Samsung",
"group_names": [
"TestGroup",
"SampleGroup"
],
"user_created_at": "2024-05-17T00:23:17Z",
"user_email": "samsung.kim@samsung.com",
"user_id": "f39c460fade34fecb05ede8f904b24b7",
"user_last_login_at": "2024-05-17T00:23:17Z",
"user_name": "Kim Samsung"
}
],
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"name": "TestGroup",
"policies": [],
"resource_type": "group",
"roles": [],
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda",
"type": "USER_DEFINED"
}
}
3.1.6.2 - 1.1
post /v1/groups
Description
Create a group
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | GroupCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | GroupShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Request body
{
"description": "Descriptions for group",
"name": "TestGroup",
"policy_ids": [
"37f2e31ff86b415698d7e8eeafab445d"
],
"tags": [
{
"key": "company",
"value": "SDS"
}
],
"user_ids": [
"f39c460fade34fecb05ede8f904b24b7"
]
}
Example HTTP response
Response 201
{
"group": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"description": "Descriptions for group",
"domain_name": "scp",
"id": "f39c460fade34fecb05ede8f904b24b7",
"members": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_created_at": "2024-05-17T00:23:17Z",
"creator_email": "samsung.kim@samsung.com",
"creator_last_login_at": "2024-05-17T00:23:17Z",
"creator_name": "Kim Samsung",
"group_names": [
"TestGroup",
"SampleGroup"
],
"user_created_at": "2024-05-17T00:23:17Z",
"user_email": "samsung.kim@samsung.com",
"user_id": "f39c460fade34fecb05ede8f904b24b7",
"user_last_login_at": "2024-05-17T00:23:17Z",
"user_name": "Kim Samsung"
}
],
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"name": "TestGroup",
"policies": [],
"resource_type": "group",
"roles": [],
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda",
"type": "USER_DEFINED"
}
}
3.1.6.3 - 1.0
post /v1/groups
Description
Create a group
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | GroupCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | GroupShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Request body
{
"description": "Descriptions for group",
"name": "TestGroup",
"policy_ids": [
"37f2e31ff86b415698d7e8eeafab445d"
],
"tags": [
{
"key": "company",
"value": "SDS"
}
],
"user_ids": [
"f39c460fade34fecb05ede8f904b24b7"
]
}
Example HTTP response
Response 201
{
"group": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"description": "Descriptions for group",
"domain_name": "scp",
"id": "f39c460fade34fecb05ede8f904b24b7",
"members": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_created_at": "2024-05-17T00:23:17Z",
"creator_email": "samsung.kim@samsung.com",
"creator_last_login_at": "2024-05-17T00:23:17Z",
"creator_name": "Kim Samsung",
"group_names": [
"TestGroup",
"SampleGroup"
],
"user_created_at": "2024-05-17T00:23:17Z",
"user_email": "samsung.kim@samsung.com",
"user_id": "f39c460fade34fecb05ede8f904b24b7",
"user_last_login_at": "2024-05-17T00:23:17Z",
"user_name": "Kim Samsung"
}
],
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"name": "TestGroup",
"policies": [],
"resource_type": "group",
"roles": [],
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda",
"type": "USER_DEFINED"
}
}
3.1.7 - Create a policy
3.1.7.1 - 1.2
post /v1/policies
Description
Create a policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | PolicyCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | PolicyShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Request body
{
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_version": {
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"Principal": null,
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"policy_version_name": "PolicyVersion-1"
},
"service_type": "scp-iam",
"tags": [
{
"key": "foo",
"value": "bar"
}
]
}
Example HTTP response
Response 201
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
3.1.7.2 - 1.1
post /v1/policies
Description
Create a policy
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | PolicyCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | PolicyShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Request body
{
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_version": {
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"Principal": null,
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"policy_version_name": "PolicyVersion-1"
},
"service_type": "scp-iam",
"tags": [
{
"key": "foo",
"value": "bar"
}
]
}
Example HTTP response
Response 201
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
3.1.7.3 - 1.0
post /v1/policies
Description
Create a policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | PolicyCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | PolicyShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Request body
{
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_version": {
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"Principal": null,
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"policy_version_name": "PolicyVersion-1"
},
"service_type": "scp-iam",
"tags": [
{
"key": "foo",
"value": "bar"
}
]
}
Example HTTP response
Response 201
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
3.1.8 - Create a saml provider
3.1.8.1 - 1.2
post /v1/saml-providers
Description
Create a saml provider
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | SamlProviderCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | SamlProviderCreateResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/saml-providers
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2,"
"Content-Type = multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW"
Request body
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="description"
SAML provider Description
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="federation_type"
SAML
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="file"; filename="keycloak-idp-saml.xml"
Content-Type: application/xml
(data)
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="saml_provider_name"
IdpTest
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="tags"
[{'key': 'company', 'value': 'SDS'}]
------WebKitFormBoundary7MA4YWxkTrZu0gW--
Example HTTP response
Response 201
{
"account_id": "",
"acs_url": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "",
"description": "",
"federation_type": "",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"idp_cert_end": "",
"idp_file_name": "",
"idp_file_size": "",
"idp_issuer_url": "",
"idp_sso_url": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "",
"saml_provider_name": ""
}
3.1.8.2 - 1.1
post /v1/saml-providers
Description
Create a saml provider
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | SamlProviderCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | SamlProviderCreateResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/saml-providers
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1,"
"Content-Type = multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW"
Request body
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="description"
SAML provider Description
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="federation_type"
SAML
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="file"; filename="keycloak-idp-saml.xml"
Content-Type: application/xml
(data)
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="saml_provider_name"
IdpTest
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="tags"
[{'key': 'company', 'value': 'SDS'}]
------WebKitFormBoundary7MA4YWxkTrZu0gW--
Example HTTP response
Response 201
{
"account_id": "",
"acs_url": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "",
"description": "",
"federation_type": "",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"idp_cert_end": "",
"idp_file_name": "",
"idp_file_size": "",
"idp_issuer_url": "",
"idp_sso_url": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "",
"saml_provider_name": ""
}
3.1.8.3 - 1.0
post /v1/saml-providers
Description
Create a saml provider
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | SamlProviderCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | SamlProviderCreateResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/saml-providers
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0,"
"Content-Type = multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW"
Request body
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="description"
SAML provider Description
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="federation_type"
SAML
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="file"; filename="keycloak-idp-saml.xml"
Content-Type: application/xml
(data)
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="saml_provider_name"
IdpTest
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="tags"
[{'key': 'company', 'value': 'SDS'}]
------WebKitFormBoundary7MA4YWxkTrZu0gW--
Example HTTP response
Response 201
{
"account_id": "",
"acs_url": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "",
"description": "",
"federation_type": "",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"idp_cert_end": "",
"idp_file_name": "",
"idp_file_size": "",
"idp_issuer_url": "",
"idp_sso_url": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "",
"saml_provider_name": ""
}
3.1.9 - Create an access key
3.1.9.1 - 1.2
post /v1/access-keys
Description
Create an access key
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | AccessKeyCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | AccessKeyResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/access-keys
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Request body
{
"access_key_type": "PERMANENT",
"account_id": "f39c460fade34fecb05ede8f904b24b7",
"description": "description",
"duration": "P1Y2M10DT2H30M15S",
"parent_access_key_id": "92d6eid9e9ae4f868s842910k11573a3",
"passcode": "000000"
}
Example HTTP response
Response 201
{
"access_key": {
"access_key": "b754b12b39da4ce29a40c5e324650bd0",
"access_key_type": "PERMANENT",
"account_id": "f39c460fade34fecb05ede8f904b24b7",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "description",
"expiration_timestamp": "9999-12-31T23:59:59Z",
"id": "6558fc9df5b54c8a985465bdf637e097",
"is_enabled": "true",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"parent_access_key_id": "92d6eid9e9ae4f868s842910k11573a3",
"secret_key": "c4150149-f7c6-46bc-9faa-d2b9d20e0899"
}
}
3.1.9.2 - 1.1
post /v1/access-keys
Description
Create an access key
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | AccessKeyCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | AccessKeyResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/access-keys
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Request body
{
"access_key_type": "PERMANENT",
"account_id": "f39c460fade34fecb05ede8f904b24b7",
"description": "description",
"duration": "P1Y2M10DT2H30M15S",
"parent_access_key_id": "92d6eid9e9ae4f868s842910k11573a3",
"passcode": "000000"
}
Example HTTP response
Response 201
{
"access_key": {
"access_key": "b754b12b39da4ce29a40c5e324650bd0",
"access_key_type": "PERMANENT",
"account_id": "f39c460fade34fecb05ede8f904b24b7",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "description",
"expiration_timestamp": "9999-12-31T23:59:59Z",
"id": "6558fc9df5b54c8a985465bdf637e097",
"is_enabled": "true",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"parent_access_key_id": "92d6eid9e9ae4f868s842910k11573a3",
"secret_key": "c4150149-f7c6-46bc-9faa-d2b9d20e0899"
}
}
3.1.9.3 - 1.0
post /v1/access-keys
Description
Create an access key
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | AccessKeyCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | AccessKeyResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/access-keys
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Request body
{
"access_key_type": "PERMANENT",
"account_id": "f39c460fade34fecb05ede8f904b24b7",
"description": "description",
"duration": "P1Y2M10DT2H30M15S",
"parent_access_key_id": "92d6eid9e9ae4f868s842910k11573a3",
"passcode": "000000"
}
Example HTTP response
Response 201
{
"access_key": {
"access_key": "b754b12b39da4ce29a40c5e324650bd0",
"access_key_type": "PERMANENT",
"account_id": "f39c460fade34fecb05ede8f904b24b7",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "description",
"expiration_timestamp": "9999-12-31T23:59:59Z",
"id": "6558fc9df5b54c8a985465bdf637e097",
"is_enabled": "true",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"parent_access_key_id": "92d6eid9e9ae4f868s842910k11573a3",
"secret_key": "c4150149-f7c6-46bc-9faa-d2b9d20e0899"
}
}
3.1.10 - Create IAM user
3.1.10.1 - 1.2
post /v1/accounts/{account_id}/users
Description
Create IAM user
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | account_id required | Account ID Example : | string | None |
| body | body required | IAMUserCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | IAMCreateUserResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/accounts/{account_id}/users
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Request body
{
"description": "",
"group_ids": [
""
],
"password": "",
"policy_ids": [
""
],
"tags": [
""
],
"temporary_password": "",
"user_name": ""
}
Example HTTP response
Response 201
{
"account_id": "",
"company_name": "",
"console_url": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"dst_offset": "",
"email": "",
"email_authenticated": "",
"first_name": "",
"id": "",
"last_login_at": "",
"last_name": "",
"last_password_update_at": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"password": "",
"password_reuse_count": "",
"phone_authenticated": "",
"policies": [],
"state": "",
"timezone": "",
"type": "",
"tz_id": "",
"user_name": "",
"utc_offset": ""
}
3.1.10.2 - 1.1
post /v1/accounts/{account_id}/users
Description
Create IAM user
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | account_id required | Account ID Example : | string | None |
| body | body required | IAMUserCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | IAMCreateUserResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/accounts/{account_id}/users
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Request body
{
"description": "",
"group_ids": [
""
],
"password": "",
"policy_ids": [
""
],
"tags": [
""
],
"temporary_password": "",
"user_name": ""
}
Example HTTP response
Response 201
{
"account_id": "",
"company_name": "",
"console_url": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"dst_offset": "",
"email": "",
"email_authenticated": "",
"first_name": "",
"id": "",
"last_login_at": "",
"last_name": "",
"last_password_update_at": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"password": "",
"password_reuse_count": "",
"phone_authenticated": "",
"policies": [],
"state": "",
"timezone": "",
"type": "",
"tz_id": "",
"user_name": "",
"utc_offset": ""
}
3.1.10.3 - 1.0
post /v1/accounts/{account_id}/users
Description
Create IAM user
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | account_id required | Account ID Example : | string | None |
| body | body required | IAMUserCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | IAMCreateUserResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/accounts/{account_id}/users
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Request body
{
"description": "",
"group_ids": [
""
],
"password": "",
"policy_ids": [
""
],
"tags": [
""
],
"temporary_password": "",
"user_name": ""
}
Example HTTP response
Response 201
{
"account_id": "",
"company_name": "",
"console_url": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"dst_offset": "",
"email": "",
"email_authenticated": "",
"first_name": "",
"id": "",
"last_login_at": "",
"last_name": "",
"last_password_update_at": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"password": "",
"password_reuse_count": "",
"phone_authenticated": "",
"policies": [],
"state": "",
"timezone": "",
"type": "",
"tz_id": "",
"user_name": "",
"utc_offset": ""
}
3.1.11 - Create role
3.1.11.1 - 1.2
post /v1/roles
Description
Create role
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | RoleCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | RoleShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/roles
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Request body
{
"account_id": "",
"assume_role_policy_document": {
"Statement": [
{
"Action": [
"sts:AssumeRole"
],
"Condition": {},
"Effect": "Allow",
"Principal": "srn:e:1234:::iam:user/abc1234",
"Resource": [],
"Sid": "statement1"
}
],
"Version": "2024-07-01"
},
"description": "",
"max_session_duration": 3600,
"name": "",
"policy_ids": [
"37f2e31ff86b415698d7e8eeafab445d"
],
"principals": [
{
"type": "SRN",
"value": "srn:e:1234:::iam:user/abc1234"
}
],
"tags": [
{
"key": "company",
"value": "SDS"
}
]
}
Example HTTP response
Response 202
{
"role": {
"account_id": "",
"assume_role_policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_email": "",
"creator_name": "",
"description": "",
"id": "f39c460fade34fecb05ede8f904b24b7",
"max_session_duration": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"modifier_email": "",
"modifier_name": "",
"name": "",
"policies": [
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
],
"type": "USER_DEFINED"
}
}
3.1.11.2 - 1.1
post /v1/roles
Description
Create role
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | RoleCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | RoleShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/roles
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Request body
{
"account_id": "",
"assume_role_policy_document": {
"Statement": [
{
"Action": [
"sts:AssumeRole"
],
"Condition": {},
"Effect": "Allow",
"Principal": "srn:e:1234:::iam:user/abc1234",
"Resource": [],
"Sid": "statement1"
}
],
"Version": "2024-07-01"
},
"description": "",
"max_session_duration": 3600,
"name": "",
"policy_ids": [
"37f2e31ff86b415698d7e8eeafab445d"
],
"principals": [
{
"type": "SRN",
"value": "srn:e:1234:::iam:user/abc1234"
}
],
"tags": [
{
"key": "company",
"value": "SDS"
}
]
}
Example HTTP response
Response 202
{
"role": {
"account_id": "",
"assume_role_policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_email": "",
"creator_name": "",
"description": "",
"id": "f39c460fade34fecb05ede8f904b24b7",
"max_session_duration": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"modifier_email": "",
"modifier_name": "",
"name": "",
"policies": [
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
],
"type": "USER_DEFINED"
}
}
3.1.11.3 - 1.0
post /v1/roles
Description
Create role
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | RoleCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | RoleShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/roles
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Request body
{
"account_id": "",
"assume_role_policy_document": {
"Statement": [
{
"Action": [
"sts:AssumeRole"
],
"Condition": {},
"Effect": "Allow",
"Principal": "srn:e:1234:::iam:user/abc1234",
"Resource": [],
"Sid": "statement1"
}
],
"Version": "2024-07-01"
},
"description": "",
"max_session_duration": 3600,
"name": "",
"policy_ids": [
"37f2e31ff86b415698d7e8eeafab445d"
],
"principals": [
{
"type": "SRN",
"value": "srn:e:1234:::iam:user/abc1234"
}
],
"tags": [
{
"key": "company",
"value": "SDS"
}
]
}
Example HTTP response
Response 202
{
"role": {
"account_id": "",
"assume_role_policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_email": "",
"creator_name": "",
"description": "",
"id": "f39c460fade34fecb05ede8f904b24b7",
"max_session_duration": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"modifier_email": "",
"modifier_name": "",
"name": "",
"policies": [
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
],
"type": "USER_DEFINED"
}
}
3.1.12 - Delete bulk role
3.1.12.1 - 1.2
delete /v1/roles/bulk
Description
Delete bulk role
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | RoleBulkDeleteRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/roles/bulk
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Request body
{
"account_id": "",
"role_ids": [
""
],
"role_names": [
""
]
}
Example HTTP response
Response 204
3.1.12.2 - 1.1
delete /v1/roles/bulk
Description
Delete bulk role
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | RoleBulkDeleteRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/roles/bulk
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Request body
{
"account_id": "",
"role_ids": [
""
],
"role_names": [
""
]
}
Example HTTP response
Response 204
3.1.12.3 - 1.0
delete /v1/roles/bulk
Description
Delete bulk role
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | RoleBulkDeleteRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/roles/bulk
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Request body
{
"account_id": "",
"role_ids": [
""
],
"role_names": [
""
]
}
Example HTTP response
Response 204
3.1.13 - Delete IAM user
3.1.13.1 - 1.2
delete /v1/accounts/{account_id}/users/{user_id}
Description
Delete IAM user
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | account_id required | Account ID Example : | string | None |
| path | user_id required | User ID Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/accounts/{account_id}/users/{user_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Example HTTP response
Response 204
3.1.13.2 - 1.1
delete /v1/accounts/{account_id}/users/{user_id}
Description
Delete IAM user
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | account_id required | Account ID Example : | string | None |
| path | user_id required | User ID Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/accounts/{account_id}/users/{user_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Example HTTP response
Response 204
3.1.14 - Delete IAM users
3.1.14.1 - 1.2
delete /v1/accounts/{account_id}/users/bulk
Description
Delete IAM users
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | account_id required | Account ID Example : | string | None |
| body | body required | IAMUserDeleteRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/accounts/{account_id}/users/bulk
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Request body
{
"user_ids": [
""
]
}
Example HTTP response
Response 204
3.1.14.2 - 1.1
delete /v1/accounts/{account_id}/users/bulk
Description
Delete IAM users
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | account_id required | Account ID Example : | string | None |
| body | body required | IAMUserDeleteRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/accounts/{account_id}/users/bulk
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Request body
{
"user_ids": [
""
]
}
Example HTTP response
Response 204
3.1.14.3 - 1.0
delete /v1/accounts/{account_id}/users/bulk
Description
Delete IAM users
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | account_id required | Account ID Example : | string | None |
| body | body required | IAMUserDeleteRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/accounts/{account_id}/users/bulk
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Request body
{
"user_ids": [
""
]
}
Example HTTP response
Response 204
3.1.15 - Delete role
3.1.15.1 - 1.2
delete /v1/roles/{role_id}
Description
Delete role
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | role_id required | 역할 ID Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/roles/{role_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Example HTTP response
Response 204
3.1.15.2 - 1.1
delete /v1/roles/{role_id}
Description
Delete role
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | role_id required | 역할 ID Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/roles/{role_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Example HTTP response
Response 204
3.1.15.3 - 1.0
delete /v1/roles/{role_id}
Description
Delete role
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | role_id required | 역할 ID Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/roles/{role_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Example HTTP response
Response 204
3.1.16 - Delete the policy
3.1.16.1 - 1.2
delete /v1/policies/{policy_id}
Description
Delete the policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | policy_id required | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/policies/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Example HTTP response
Response 204
3.1.16.2 - 1.1
delete /v1/policies/{policy_id}
Description
Delete the policy
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | policy_id required | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/policies/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Example HTTP response
Response 204
3.1.16.3 - 1.0
delete /v1/policies/{policy_id}
Description
Delete the policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | policy_id required | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/policies/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Example HTTP response
Response 204
3.1.17 - Delete the resource based policy
3.1.17.1 - 1.2
delete /v1/resource-policies/{srn}
Description
Delete the resource based policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | srn required | 삼성 리소스 자원명 Example : c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/resource-policies/{srn}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Example HTTP response
Response 204
3.1.17.2 - 1.1
delete /v1/resource-policies/{srn}
Description
Delete the resource based policy
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | srn required | 삼성 리소스 자원명 Example : c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/resource-policies/{srn}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Example HTTP response
Response 204
3.1.17.3 - 1.0
delete /v1/resource-policies/{srn}
Description
Delete the resource based policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | srn required | 삼성 리소스 자원명 Example : c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/resource-policies/{srn}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Example HTTP response
Response 204
3.1.18 - Delete user policy
3.1.18.1 - 1.2
delete /v1/users/{user_id}/policy-bindings/{policy_id}
Description
Delete user policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | user_id required | 사용자 ID Example : | string | None |
| path | policy_id required | Policy ID Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/users/{user_id}/policy-bindings/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Example HTTP response
Response 204
3.1.18.2 - 1.1
delete /v1/users/{user_id}/policy-bindings/{policy_id}
Description
Delete user policy
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | user_id required | 사용자 ID Example : | string | None |
| path | policy_id required | Policy ID Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/users/{user_id}/policy-bindings/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Example HTTP response
Response 204
3.1.18.3 - 1.0
delete /v1/users/{user_id}/policy-bindings/{policy_id}
Description
Delete user policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | user_id required | 사용자 ID Example : | string | None |
| path | policy_id required | Policy ID Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/users/{user_id}/policy-bindings/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Example HTTP response
Response 204
3.1.19 - Detach policies to Role
3.1.19.1 - 1.2
delete /v1/roles/{role_id}/policy-bindings
Description
Detach policies to Role
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | role_id required | 역할 ID Example : | string | None |
| body | body required | RolePolicyBindingRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/roles/{role_id}/policy-bindings
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Request body
{
"policy_ids": [
""
]
}
Example HTTP response
Response 204
3.1.19.2 - 1.1
delete /v1/roles/{role_id}/policy-bindings
Description
Detach policies to Role
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | role_id required | 역할 ID Example : | string | None |
| body | body required | RolePolicyBindingRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/roles/{role_id}/policy-bindings
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Request body
{
"policy_ids": [
""
]
}
Example HTTP response
Response 204
3.1.19.3 - 1.0
delete /v1/roles/{role_id}/policy-bindings
Description
Detach policies to Role
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | role_id required | 역할 ID Example : | string | None |
| body | body required | RolePolicyBindingRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/roles/{role_id}/policy-bindings
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Request body
{
"policy_ids": [
""
]
}
Example HTTP response
Response 204
3.1.20 - Detach policy to Role
3.1.20.1 - 1.2
delete /v1/roles/{role_id}/policy-bindings/{policy_id}
Description
Detach policy to Role
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | role_id required | 역할 ID Example : | string | None |
| path | policy_id required | 역할에 연결된 정책 ID Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/roles/{role_id}/policy-bindings/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Example HTTP response
Response 204
3.1.20.2 - 1.1
delete /v1/roles/{role_id}/policy-bindings/{policy_id}
Description
Detach policy to Role
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | role_id required | 역할 ID Example : | string | None |
| path | policy_id required | 역할에 연결된 정책 ID Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/roles/{role_id}/policy-bindings/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Example HTTP response
Response 204
3.1.20.3 - 1.0
delete /v1/roles/{role_id}/policy-bindings/{policy_id}
Description
Detach policy to Role
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | role_id required | 역할 ID Example : | string | None |
| path | policy_id required | 역할에 연결된 정책 ID Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/roles/{role_id}/policy-bindings/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Example HTTP response
Response 204
3.1.21 - Get a Group
3.1.21.1 - 1.2
get /v1/groups/{group_id}
Description
Get a Group
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | Group ID Example : a946662dc4314dac93da413a32457459 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupShowResponse |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Example HTTP response
Response 200
{
"group": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"description": "Descriptions for group",
"domain_name": "scp",
"id": "f39c460fade34fecb05ede8f904b24b7",
"members": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_created_at": "2024-05-17T00:23:17Z",
"creator_email": "samsung.kim@samsung.com",
"creator_last_login_at": "2024-05-17T00:23:17Z",
"creator_name": "Kim Samsung",
"group_names": [
"TestGroup",
"SampleGroup"
],
"user_created_at": "2024-05-17T00:23:17Z",
"user_email": "samsung.kim@samsung.com",
"user_id": "f39c460fade34fecb05ede8f904b24b7",
"user_last_login_at": "2024-05-17T00:23:17Z",
"user_name": "Kim Samsung"
}
],
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"name": "TestGroup",
"policies": [],
"resource_type": "group",
"roles": [],
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda",
"type": "USER_DEFINED"
}
}
3.1.21.2 - 1.1
get /v1/groups/{group_id}
Description
Get a Group
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | Group ID Example : a946662dc4314dac93da413a32457459 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupShowResponse |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Example HTTP response
Response 200
{
"group": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"description": "Descriptions for group",
"domain_name": "scp",
"id": "f39c460fade34fecb05ede8f904b24b7",
"members": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_created_at": "2024-05-17T00:23:17Z",
"creator_email": "samsung.kim@samsung.com",
"creator_last_login_at": "2024-05-17T00:23:17Z",
"creator_name": "Kim Samsung",
"group_names": [
"TestGroup",
"SampleGroup"
],
"user_created_at": "2024-05-17T00:23:17Z",
"user_email": "samsung.kim@samsung.com",
"user_id": "f39c460fade34fecb05ede8f904b24b7",
"user_last_login_at": "2024-05-17T00:23:17Z",
"user_name": "Kim Samsung"
}
],
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"name": "TestGroup",
"policies": [],
"resource_type": "group",
"roles": [],
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda",
"type": "USER_DEFINED"
}
}
3.1.21.3 - 1.0
get /v1/groups/{group_id}
Description
Get a Group
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | Group ID Example : a946662dc4314dac93da413a32457459 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupShowResponse |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Example HTTP response
Response 200
{
"group": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"description": "Descriptions for group",
"domain_name": "scp",
"id": "f39c460fade34fecb05ede8f904b24b7",
"members": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_created_at": "2024-05-17T00:23:17Z",
"creator_email": "samsung.kim@samsung.com",
"creator_last_login_at": "2024-05-17T00:23:17Z",
"creator_name": "Kim Samsung",
"group_names": [
"TestGroup",
"SampleGroup"
],
"user_created_at": "2024-05-17T00:23:17Z",
"user_email": "samsung.kim@samsung.com",
"user_id": "f39c460fade34fecb05ede8f904b24b7",
"user_last_login_at": "2024-05-17T00:23:17Z",
"user_name": "Kim Samsung"
}
],
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"name": "TestGroup",
"policies": [],
"resource_type": "group",
"roles": [],
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda",
"type": "USER_DEFINED"
}
}
3.1.22 - Get a specific policy binding list
3.1.22.1 - 1.2
get /v1/policies/{policy_id}/bindings
Description
Get a specific policy binding list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | policy_id required | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | string | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | identity_id optional | Identity ID Example : f39c460fade34fecb05ede8f904b24b7 | any of [string, null] | None |
| query | identity_type optional | Identity Type Example : GROUP | any of [string, null] | None |
| query | name optional | Name Example : TestGroup | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PolicyBindingPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/policies/{policy_id}/bindings
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Example HTTP response
Response 200
{
"count": 20,
"groups": [
{
"created_at": "2025-03-26T10:18:04Z",
"created_by": "4a816a3f5099442ebb52daefc1f7be32",
"creator_email": "-",
"creator_name": "-",
"description": "openapi-ga2-test-group",
"domain_name": "scp",
"id": "19fca177a57940daa5817960373c6542",
"modified_at": "2025-03-26T10:18:04Z",
"modified_by": "4a816a3f5099442ebb52daefc1f7be32",
"modifier_email": "-",
"modifier_name": "-",
"name": "openapi-ga2-testgroup5",
"policies": [],
"roles": [],
"srn": "srn:dev2::1d9cc99917ff41bb992276ac0ae9e4c8:::iam:group/19fca177a57940daa5817960373c6542",
"type": "USER_DEFINED"
}
],
"page": 0,
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"roles": [
{
"account_id": "d7aba97100564b34a0f4f77c4bc7a303",
"assume_role_policy_document": {
"Statement": [
{
"Action": "*",
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": "*",
"Principal": "*",
"Resource": "*",
"Sid": "statement1"
}
],
"Version": "2024-07-01"
},
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_email": "-",
"creator_name": "-",
"description": "string",
"id": "f39c460fade34fecb05ede8f904b24b7",
"max_session_duration": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"modifier_email": "-",
"modifier_name": "-",
"name": "string",
"type": "DEFAULT"
}
],
"size": 20,
"sort": [
"created_at:asc"
],
"users": [
{
"access_control": false,
"account_id": "d7aba97100564b34a0f4f77c4bc7a303",
"account_name": "",
"allowed_ip_addresses": "",
"company_name": "",
"created_at": "2024-11-15T06:57:42.000000Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"domain_name": "scp",
"dst_offset": "+09:00",
"email": "samsung.kim@samsung.com",
"email_authenticate_code": "8ada8861bad2423295e4bb576bee5886",
"email_authenticated": true,
"first_name": "",
"groups": [],
"id": "90dddfc2b1e04edba54ba2b41539a9ac",
"keycloak_id": "127e3d8c-66dc-4b1b-b38b-9a1d0c6d5507",
"keystone_credential": "",
"last_login_at": "2024-11-25T06:57:42.000000Z",
"last_name": "",
"last_password_update_at": "",
"login_id": "",
"modified_at": "2024-11-17T06:57:42.000000Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"nation_id": "+82",
"phone_authenticated": false,
"phone_number": "0000000000",
"policies": [],
"state": "ACTIVE",
"temporary_password": false,
"term_region_id": "1",
"timezone": "Asia/Seoul",
"type": "IAM",
"tz_id": "Asia/Seoul",
"user_name": "Kim Samsung",
"utc_offset": "+09:00"
}
]
}
3.1.22.2 - 1.1
get /v1/policies/{policy_id}/bindings
Description
Get a specific policy binding list
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | policy_id required | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | string | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | identity_id optional | Identity ID Example : f39c460fade34fecb05ede8f904b24b7 | any of [string, null] | None |
| query | identity_type optional | Identity Type Example : GROUP | any of [string, null] | None |
| query | name optional | Name Example : TestGroup | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PolicyBindingPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/policies/{policy_id}/bindings
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Example HTTP response
Response 200
{
"count": 20,
"groups": [
{
"created_at": "2025-03-26T10:18:04Z",
"created_by": "4a816a3f5099442ebb52daefc1f7be32",
"creator_email": "-",
"creator_name": "-",
"description": "openapi-ga2-test-group",
"domain_name": "scp",
"id": "19fca177a57940daa5817960373c6542",
"modified_at": "2025-03-26T10:18:04Z",
"modified_by": "4a816a3f5099442ebb52daefc1f7be32",
"modifier_email": "-",
"modifier_name": "-",
"name": "openapi-ga2-testgroup5",
"policies": [],
"roles": [],
"srn": "srn:dev2::1d9cc99917ff41bb992276ac0ae9e4c8:::iam:group/19fca177a57940daa5817960373c6542",
"type": "USER_DEFINED"
}
],
"page": 0,
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"roles": [
{
"account_id": "d7aba97100564b34a0f4f77c4bc7a303",
"assume_role_policy_document": {
"Statement": [
{
"Action": "*",
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": "*",
"Principal": "*",
"Resource": "*",
"Sid": "statement1"
}
],
"Version": "2024-07-01"
},
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_email": "-",
"creator_name": "-",
"description": "string",
"id": "f39c460fade34fecb05ede8f904b24b7",
"max_session_duration": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"modifier_email": "-",
"modifier_name": "-",
"name": "string",
"type": "DEFAULT"
}
],
"size": 20,
"sort": [
"created_at:asc"
],
"users": [
{
"access_control": false,
"account_id": "d7aba97100564b34a0f4f77c4bc7a303",
"account_name": "",
"allowed_ip_addresses": "",
"company_name": "",
"created_at": "2024-11-15T06:57:42.000000Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"domain_name": "scp",
"dst_offset": "+09:00",
"email": "samsung.kim@samsung.com",
"email_authenticate_code": "8ada8861bad2423295e4bb576bee5886",
"email_authenticated": true,
"first_name": "",
"groups": [],
"id": "90dddfc2b1e04edba54ba2b41539a9ac",
"keycloak_id": "127e3d8c-66dc-4b1b-b38b-9a1d0c6d5507",
"keystone_credential": "",
"last_login_at": "2024-11-25T06:57:42.000000Z",
"last_name": "",
"last_password_update_at": "",
"login_id": "",
"modified_at": "2024-11-17T06:57:42.000000Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"nation_id": "+82",
"phone_authenticated": false,
"phone_number": "0000000000",
"policies": [],
"state": "ACTIVE",
"temporary_password": false,
"term_region_id": "1",
"timezone": "Asia/Seoul",
"type": "IAM",
"tz_id": "Asia/Seoul",
"user_name": "Kim Samsung",
"utc_offset": "+09:00"
}
]
}
3.1.22.3 - 1.0
get /v1/policies/{policy_id}/bindings
Description
Get a specific policy binding list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | policy_id required | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | string | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | identity_id optional | Identity ID Example : f39c460fade34fecb05ede8f904b24b7 | any of [string, null] | None |
| query | identity_type optional | Identity Type Example : GROUP | any of [string, null] | None |
| query | name optional | Name Example : TestGroup | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PolicyBindingPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/policies/{policy_id}/bindings
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Example HTTP response
Response 200
{
"count": 20,
"groups": [
{
"created_at": "2025-03-26T10:18:04Z",
"created_by": "4a816a3f5099442ebb52daefc1f7be32",
"creator_email": "-",
"creator_name": "-",
"description": "openapi-ga2-test-group",
"domain_name": "scp",
"id": "19fca177a57940daa5817960373c6542",
"modified_at": "2025-03-26T10:18:04Z",
"modified_by": "4a816a3f5099442ebb52daefc1f7be32",
"modifier_email": "-",
"modifier_name": "-",
"name": "openapi-ga2-testgroup5",
"policies": [],
"roles": [],
"srn": "srn:dev2::1d9cc99917ff41bb992276ac0ae9e4c8:::iam:group/19fca177a57940daa5817960373c6542",
"type": "USER_DEFINED"
}
],
"page": 0,
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"roles": [
{
"account_id": "d7aba97100564b34a0f4f77c4bc7a303",
"assume_role_policy_document": {
"Statement": [
{
"Action": "*",
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": "*",
"Principal": "*",
"Resource": "*",
"Sid": "statement1"
}
],
"Version": "2024-07-01"
},
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_email": "-",
"creator_name": "-",
"description": "string",
"id": "f39c460fade34fecb05ede8f904b24b7",
"max_session_duration": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"modifier_email": "-",
"modifier_name": "-",
"name": "string",
"type": "DEFAULT"
}
],
"size": 20,
"sort": [
"created_at:asc"
],
"users": [
{
"access_control": false,
"account_id": "d7aba97100564b34a0f4f77c4bc7a303",
"account_name": "",
"allowed_ip_addresses": "",
"company_name": "",
"created_at": "2024-11-15T06:57:42.000000Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"domain_name": "scp",
"dst_offset": "+09:00",
"email": "samsung.kim@samsung.com",
"email_authenticate_code": "8ada8861bad2423295e4bb576bee5886",
"email_authenticated": true,
"first_name": "",
"groups": [],
"id": "90dddfc2b1e04edba54ba2b41539a9ac",
"keycloak_id": "127e3d8c-66dc-4b1b-b38b-9a1d0c6d5507",
"keystone_credential": "",
"last_login_at": "2024-11-25T06:57:42.000000Z",
"last_name": "",
"last_password_update_at": "",
"login_id": "",
"modified_at": "2024-11-17T06:57:42.000000Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"nation_id": "+82",
"phone_authenticated": false,
"phone_number": "0000000000",
"policies": [],
"state": "ACTIVE",
"temporary_password": false,
"term_region_id": "1",
"timezone": "Asia/Seoul",
"type": "IAM",
"tz_id": "Asia/Seoul",
"user_name": "Kim Samsung",
"utc_offset": "+09:00"
}
]
}
3.1.23 - Get an access key
3.1.23.1 - 1.2
get /v1/access-keys/{access_key_id}
Description
Get an access key
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | access_key_id required | Access key ID Example : f39c460fade34fecb05ede8f904b24b7 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AccessKeyResponse |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/access-keys/{access_key_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Example HTTP response
Response 200
{
"access_key": {
"access_key": "b754b12b39da4ce29a40c5e324650bd0",
"access_key_type": "PERMANENT",
"account_id": "f39c460fade34fecb05ede8f904b24b7",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "description",
"expiration_timestamp": "9999-12-31T23:59:59Z",
"id": "6558fc9df5b54c8a985465bdf637e097",
"is_enabled": "true",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"parent_access_key_id": "92d6eid9e9ae4f868s842910k11573a3",
"secret_key": "c4150149-f7c6-46bc-9faa-d2b9d20e0899"
}
}
3.1.23.2 - 1.1
get /v1/access-keys/{access_key_id}
Description
Get an access key
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | access_key_id required | Access key ID Example : f39c460fade34fecb05ede8f904b24b7 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AccessKeyResponse |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/access-keys/{access_key_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Example HTTP response
Response 200
{
"access_key": {
"access_key": "b754b12b39da4ce29a40c5e324650bd0",
"access_key_type": "PERMANENT",
"account_id": "f39c460fade34fecb05ede8f904b24b7",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "description",
"expiration_timestamp": "9999-12-31T23:59:59Z",
"id": "6558fc9df5b54c8a985465bdf637e097",
"is_enabled": "true",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"parent_access_key_id": "92d6eid9e9ae4f868s842910k11573a3",
"secret_key": "c4150149-f7c6-46bc-9faa-d2b9d20e0899"
}
}
3.1.23.3 - 1.0
get /v1/access-keys/{access_key_id}
Description
Get an access key
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | access_key_id required | Access key ID Example : f39c460fade34fecb05ede8f904b24b7 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AccessKeyResponse |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/access-keys/{access_key_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Example HTTP response
Response 200
{
"access_key": {
"access_key": "b754b12b39da4ce29a40c5e324650bd0",
"access_key_type": "PERMANENT",
"account_id": "f39c460fade34fecb05ede8f904b24b7",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "description",
"expiration_timestamp": "9999-12-31T23:59:59Z",
"id": "6558fc9df5b54c8a985465bdf637e097",
"is_enabled": "true",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"parent_access_key_id": "92d6eid9e9ae4f868s842910k11573a3",
"secret_key": "c4150149-f7c6-46bc-9faa-d2b9d20e0899"
}
}
3.1.24 - Get endpoint list
3.1.24.1 - 1.2
get /v1/endpoints
Description
Get endpoint list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ListEndpointsResponse |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/endpoints
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Example HTTP response
Response 200
{
"endpoints": [
{
"region": "kr-west1",
"service_name": "scp-iam",
"service_type": "scp-iam",
"url": "https://iam.dev2.samsungsdscloud.com"
}
]
}
3.1.24.2 - 1.1
get /v1/endpoints
Description
Get endpoint list
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ListEndpointsResponse |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/endpoints
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Example HTTP response
Response 200
{
"endpoints": [
{
"region": "kr-west1",
"service_name": "scp-iam",
"service_type": "scp-iam",
"url": "https://iam.dev2.samsungsdscloud.com"
}
]
}
3.1.24.3 - 1.0
get /v1/endpoints
Description
Get endpoint list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ListEndpointsResponse |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/endpoints
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Example HTTP response
Response 200
{
"endpoints": [
{
"region": "kr-west1",
"service_name": "scp-iam",
"service_type": "scp-iam",
"url": "https://iam.dev2.samsungsdscloud.com"
}
]
}
3.1.25 - Get IAM users
3.1.25.1 - 1.2
get /v1/accounts/{account_id}/users/{user_id}
Description
Get IAM users
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | account_id required | Account ID Example : | string | None |
| path | user_id required | User ID Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | IAMUserDetailResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/accounts/{account_id}/users/{user_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Example HTTP response
Response 200
{
"account_id": "",
"company_name": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"created_by_name": "",
"description": "",
"dst_offset": "",
"email": "",
"email_authenticated": "",
"first_name": "",
"id": "",
"last_login_at": "",
"last_name": "",
"last_password_update_at": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modified_by_name": "",
"name": "",
"password_reuse_count": "",
"phone_authenticated": "",
"policies": [],
"resource_type": "User",
"service": "iam",
"service_name": "Identity Access Management",
"srn": "",
"state": "",
"timezone": "",
"type": "",
"tz_id": "",
"user_name": "",
"utc_offset": ""
}
3.1.25.2 - 1.1
get /v1/accounts/{account_id}/users/{user_id}
Description
Get IAM users
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | account_id required | Account ID Example : | string | None |
| path | user_id required | User ID Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | IAMUserDetailResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/accounts/{account_id}/users/{user_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Example HTTP response
Response 200
{
"account_id": "",
"company_name": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"created_by_name": "",
"description": "",
"dst_offset": "",
"email": "",
"email_authenticated": "",
"first_name": "",
"id": "",
"last_login_at": "",
"last_name": "",
"last_password_update_at": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modified_by_name": "",
"name": "",
"password_reuse_count": "",
"phone_authenticated": "",
"policies": [],
"resource_type": "User",
"service": "iam",
"service_name": "Identity Access Management",
"srn": "",
"state": "",
"timezone": "",
"type": "",
"tz_id": "",
"user_name": "",
"utc_offset": ""
}
3.1.25.3 - 1.0
get /v1/accounts/{account_id}/users/{user_id}
Description
Get IAM users
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | account_id required | Account ID Example : | string | None |
| path | user_id required | User ID Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | IAMUserDetailResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/accounts/{account_id}/users/{user_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Example HTTP response
Response 200
{
"account_id": "",
"company_name": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"created_by_name": "",
"description": "",
"dst_offset": "",
"email": "",
"email_authenticated": "",
"first_name": "",
"id": "",
"last_login_at": "",
"last_name": "",
"last_password_update_at": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modified_by_name": "",
"name": "",
"password_reuse_count": "",
"phone_authenticated": "",
"policies": [],
"resource_type": "User",
"service": "iam",
"service_name": "Identity Access Management",
"srn": "",
"state": "",
"timezone": "",
"type": "",
"tz_id": "",
"user_name": "",
"utc_offset": ""
}
3.1.26 - Get policy list
3.1.26.1 - 1.2
get /v1/policies
Description
Get policy list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | id optional | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | any of [string, null] | None |
| query | policy_name optional | Policy Name Example : ViewerAccess | any of [string, null] | None |
| query | policy_type optional | Policy Type Example : SYSTEM_MANAGED | any of [string, array[string], null] | None |
| query | service_type optional | Service Type Example : scp-iam | any of [string, array[string], null] | None |
| query | creator_name optional | Policy 생성자 성, 이름 Example : test1 | any of [string, null] | None |
| query | creator_email optional | Policy 생성자 Email Example : test@test.com | any of [string, null] | None |
| query | modifier_name optional | Policy 수정자 성, 이름 Example : test1 | any of [string, null] | None |
| query | modifier_email optional | Policy 수정자 Email Example : test@test.com | any of [string, null] | None |
| query | exclude_group_id optional | 제외할 Group ID Example : a946662dc4314dac93da413a32457459 | any of [string, null] | None |
| query | exclude_user_id optional | 제외할 User ID Example : | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PolicyPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"policies": [
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
3.1.26.2 - 1.1
get /v1/policies
Description
Get policy list
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | id optional | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | any of [string, null] | None |
| query | policy_name optional | Policy Name Example : ViewerAccess | any of [string, null] | None |
| query | policy_type optional | Policy Type Example : SYSTEM_MANAGED | any of [string, array[string], null] | None |
| query | service_type optional | Service Type Example : scp-iam | any of [string, array[string], null] | None |
| query | creator_name optional | Policy 생성자 성, 이름 Example : test1 | any of [string, null] | None |
| query | creator_email optional | Policy 생성자 Email Example : test@test.com | any of [string, null] | None |
| query | modifier_name optional | Policy 수정자 성, 이름 Example : test1 | any of [string, null] | None |
| query | modifier_email optional | Policy 수정자 Email Example : test@test.com | any of [string, null] | None |
| query | exclude_group_id optional | 제외할 Group ID Example : a946662dc4314dac93da413a32457459 | any of [string, null] | None |
| query | exclude_user_id optional | 제외할 User ID Example : | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PolicyPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"policies": [
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
3.1.26.3 - 1.0
get /v1/policies
Description
Get policy list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | id optional | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | any of [string, null] | None |
| query | policy_name optional | Policy Name Example : ViewerAccess | any of [string, null] | None |
| query | policy_type optional | Policy Type Example : SYSTEM_MANAGED | any of [string, array[string], null] | None |
| query | service_type optional | Service Type Example : scp-iam | any of [string, array[string], null] | None |
| query | creator_name optional | Policy 생성자 성, 이름 Example : test1 | any of [string, null] | None |
| query | creator_email optional | Policy 생성자 Email Example : test@test.com | any of [string, null] | None |
| query | modifier_name optional | Policy 수정자 성, 이름 Example : test1 | any of [string, null] | None |
| query | modifier_email optional | Policy 수정자 Email Example : test@test.com | any of [string, null] | None |
| query | exclude_group_id optional | 제외할 Group ID Example : a946662dc4314dac93da413a32457459 | any of [string, null] | None |
| query | exclude_user_id optional | 제외할 User ID Example : | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PolicyPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"policies": [
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
3.1.27 - Get role
3.1.27.1 - 1.2
get /v1/roles/{role_id}
Description
Get role
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | role_id required | 역할 ID Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | RoleShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/roles/{role_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Example HTTP response
Response 200
{
"role": {
"account_id": "",
"assume_role_policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_email": "",
"creator_name": "",
"description": "",
"id": "f39c460fade34fecb05ede8f904b24b7",
"max_session_duration": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"modifier_email": "",
"modifier_name": "",
"name": "",
"policies": [
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
],
"type": "USER_DEFINED"
}
}
3.1.27.2 - 1.1
get /v1/roles/{role_id}
Description
Get role
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | role_id required | 역할 ID Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | RoleShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/roles/{role_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Example HTTP response
Response 200
{
"role": {
"account_id": "",
"assume_role_policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_email": "",
"creator_name": "",
"description": "",
"id": "f39c460fade34fecb05ede8f904b24b7",
"max_session_duration": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"modifier_email": "",
"modifier_name": "",
"name": "",
"policies": [
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
],
"type": "USER_DEFINED"
}
}
3.1.27.3 - 1.0
get /v1/roles/{role_id}
Description
Get role
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | role_id required | 역할 ID Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | RoleShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/roles/{role_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Example HTTP response
Response 200
{
"role": {
"account_id": "",
"assume_role_policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_email": "",
"creator_name": "",
"description": "",
"id": "f39c460fade34fecb05ede8f904b24b7",
"max_session_duration": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"modifier_email": "",
"modifier_name": "",
"name": "",
"policies": [
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
],
"type": "USER_DEFINED"
}
}
3.1.28 - Get role list
3.1.28.1 - 1.2
get /v1/roles
Description
Get role list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | name optional | 역할명 Example : | any of [string, null] | None |
| query | role_type optional | 역할 유형 Example : | any of [string, null] | None |
| query | account_id optional | 역할이 속한 계정의 ID Example : | any of [string, null] | None |
| query | exclude_policy_id optional | 예외 대상 정책 Example : | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | RolePageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/roles
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"roles": [
{
"account_id": "",
"assume_role_policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_email": "",
"creator_name": "",
"description": "",
"id": "f39c460fade34fecb05ede8f904b24b7",
"max_session_duration": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"modifier_email": "",
"modifier_name": "",
"name": "",
"policies": [
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
],
"type": "USER_DEFINED"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
3.1.28.2 - 1.1
get /v1/roles
Description
Get role list
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | name optional | 역할명 Example : | any of [string, null] | None |
| query | role_type optional | 역할 유형 Example : | any of [string, null] | None |
| query | account_id optional | 역할이 속한 계정의 ID Example : | any of [string, null] | None |
| query | exclude_policy_id optional | 예외 대상 정책 Example : | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | RolePageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/roles
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"roles": [
{
"account_id": "",
"assume_role_policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_email": "",
"creator_name": "",
"description": "",
"id": "f39c460fade34fecb05ede8f904b24b7",
"max_session_duration": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"modifier_email": "",
"modifier_name": "",
"name": "",
"policies": [
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
],
"type": "USER_DEFINED"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
3.1.28.3 - 1.0
get /v1/roles
Description
Get role list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | name optional | 역할명 Example : | any of [string, null] | None |
| query | role_type optional | 역할 유형 Example : | any of [string, null] | None |
| query | account_id optional | 역할이 속한 계정의 ID Example : | any of [string, null] | None |
| query | exclude_policy_id optional | 예외 대상 정책 Example : | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | RolePageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/roles
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"roles": [
{
"account_id": "",
"assume_role_policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_email": "",
"creator_name": "",
"description": "",
"id": "f39c460fade34fecb05ede8f904b24b7",
"max_session_duration": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"modifier_email": "",
"modifier_name": "",
"name": "",
"policies": [
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
],
"type": "USER_DEFINED"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
3.1.29 - Get Role Policy-Binding list
3.1.29.1 - 1.2
get /v1/roles/{role_id}/policy-bindings
Description
Get Role Policy-Binding list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | role_id required | 역할 ID Example : | string | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | policy_id optional | 역할에 연결된 정책 ID Example : | any of [string, null] | None |
| query | policy_name optional | 역할에 연결된 정책 이름 Example : | any of [string, null] | None |
| query | policy_type optional | 역할에 연결된 정책 유형 목록 Example : ['SYSTEM_MANAGED', 'USER_DEFINED', 'INLINE'] | any of [string, array[string], null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | RolePolicyBindingPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/roles/{role_id}/policy-bindings
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"policies": [
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
3.1.29.2 - 1.1
get /v1/roles/{role_id}/policy-bindings
Description
Get Role Policy-Binding list
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | role_id required | 역할 ID Example : | string | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | policy_id optional | 역할에 연결된 정책 ID Example : | any of [string, null] | None |
| query | policy_name optional | 역할에 연결된 정책 이름 Example : | any of [string, null] | None |
| query | policy_type optional | 역할에 연결된 정책 유형 목록 Example : ['SYSTEM_MANAGED', 'USER_DEFINED', 'INLINE'] | any of [string, array[string], null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | RolePolicyBindingPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/roles/{role_id}/policy-bindings
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"policies": [
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
3.1.29.3 - 1.0
get /v1/roles/{role_id}/policy-bindings
Description
Get Role Policy-Binding list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | role_id required | 역할 ID Example : | string | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | policy_id optional | 역할에 연결된 정책 ID Example : | any of [string, null] | None |
| query | policy_name optional | 역할에 연결된 정책 이름 Example : | any of [string, null] | None |
| query | policy_type optional | 역할에 연결된 정책 유형 목록 Example : ['SYSTEM_MANAGED', 'USER_DEFINED', 'INLINE'] | any of [string, array[string], null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | RolePolicyBindingPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/roles/{role_id}/policy-bindings
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"policies": [
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
3.1.30 - Get saml provider information
3.1.30.1 - 1.2
get /v1/saml-providers/{saml_provider_id}
Description
Get saml provider information
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | saml_provider_id required | 자격증명공급자 ID Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SamlProviderDetailResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/saml-providers/{saml_provider_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Example HTTP response
Response 200
{
"account_id": "",
"acs_url": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "",
"description": "",
"federation_type": "",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"idp_cert_end": "",
"idp_file_data": "",
"idp_file_name": "",
"idp_file_size": "",
"idp_issuer_url": "",
"idp_sso_url": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "",
"saml_provider_name": ""
}
3.1.30.2 - 1.1
get /v1/saml-providers/{saml_provider_id}
Description
Get saml provider information
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | saml_provider_id required | 자격증명공급자 ID Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SamlProviderDetailResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/saml-providers/{saml_provider_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Example HTTP response
Response 200
{
"account_id": "",
"acs_url": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "",
"description": "",
"federation_type": "",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"idp_cert_end": "",
"idp_file_data": "",
"idp_file_name": "",
"idp_file_size": "",
"idp_issuer_url": "",
"idp_sso_url": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "",
"saml_provider_name": ""
}
3.1.30.3 - 1.0
get /v1/saml-providers/{saml_provider_id}
Description
Get saml provider information
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | saml_provider_id required | 자격증명공급자 ID Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SamlProviderDetailResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/saml-providers/{saml_provider_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Example HTTP response
Response 200
{
"account_id": "",
"acs_url": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "",
"description": "",
"federation_type": "",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"idp_cert_end": "",
"idp_file_data": "",
"idp_file_name": "",
"idp_file_size": "",
"idp_issuer_url": "",
"idp_sso_url": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "",
"saml_provider_name": ""
}
3.1.31 - Get service account
3.1.31.1 - 1.2
get /v1/service-accounts/{service_account_id}
Description
Get service account
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | service_account_id required | Service Account ID Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServiceAccountShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/service-accounts/{service_account_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Example HTTP response
Response 200
{
"service_account": {
"id": "",
"name": "",
"password": "",
"service": ""
}
}
3.1.31.2 - 1.1
get /v1/service-accounts/{service_account_id}
Description
Get service account
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | service_account_id required | Service Account ID Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServiceAccountShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/service-accounts/{service_account_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Example HTTP response
Response 200
{
"service_account": {
"id": "",
"name": "",
"password": "",
"service": ""
}
}
3.1.31.3 - 1.0
get /v1/service-accounts/{service_account_id}
Description
Get service account
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | service_account_id required | Service Account ID Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServiceAccountShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/service-accounts/{service_account_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Example HTTP response
Response 200
{
"service_account": {
"id": "",
"name": "",
"password": "",
"service": ""
}
}
3.1.32 - Get user policy-binding list
3.1.32.1 - 1.2
get /v1/users/{user_id}/policy-bindings
Description
Get user policy-binding list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | user_id required | 사용자 ID Example : | string | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | policy_id optional | Policy Id Example : | any of [string, null] | None |
| query | policy_name optional | Policy Name Example : ViewerAccess | any of [string, null] | None |
| query | policy_type optional | Policy Type List Example : ['SYSTEM_MANAGED', 'USER_DEFINED'] | any of [string, array[string], null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | UserPolicyPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/users/{user_id}/policy-bindings
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"policies": [
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
],
"size": 20,
"sort": [
"created_at:asc"
],
"user_id": ""
}
3.1.32.2 - 1.1
get /v1/users/{user_id}/policy-bindings
Description
Get user policy-binding list
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | user_id required | 사용자 ID Example : | string | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | policy_id optional | Policy Id Example : | any of [string, null] | None |
| query | policy_name optional | Policy Name Example : ViewerAccess | any of [string, null] | None |
| query | policy_type optional | Policy Type List Example : ['SYSTEM_MANAGED', 'USER_DEFINED'] | any of [string, array[string], null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | UserPolicyPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/users/{user_id}/policy-bindings
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"policies": [
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
],
"size": 20,
"sort": [
"created_at:asc"
],
"user_id": ""
}
3.1.32.3 - 1.0
get /v1/users/{user_id}/policy-bindings
Description
Get user policy-binding list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | user_id required | 사용자 ID Example : | string | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | policy_id optional | Policy Id Example : | any of [string, null] | None |
| query | policy_name optional | Policy Name Example : ViewerAccess | any of [string, null] | None |
| query | policy_type optional | Policy Type List Example : ['SYSTEM_MANAGED', 'USER_DEFINED'] | any of [string, array[string], null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | UserPolicyPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/users/{user_id}/policy-bindings
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"policies": [
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
],
"size": 20,
"sort": [
"created_at:asc"
],
"user_id": ""
}
3.1.33 - Group Member list
3.1.33.1 - 1.2
get /v1/groups/{group_id}/members
Description
Group Member list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | Group ID Example : a946662dc4314dac93da413a32457459 | string | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | user_name optional | Group Member 성, 이름 Example : Kim Samsung | any of [string, null] | None |
| query | user_email optional | Group Member Email Example : samsung.kim@samsung.com | any of [string, null] | None |
| query | creator_name optional | Group Member 생성자 성, 이름 Example : Kim Samsung | any of [string, null] | None |
| query | creator_email optional | Group Member 생성자 Email Example : samsung.kim@samsung.com | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupMemberPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}/members
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Example HTTP response
Response 200
{
"count": 20,
"group_members": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_created_at": "2024-05-17T00:23:17Z",
"creator_email": "samsung.kim@samsung.com",
"creator_last_login_at": "2024-05-17T00:23:17Z",
"creator_name": "Kim Samsung",
"group_names": [
"TestGroup",
"SampleGroup"
],
"user_created_at": "2024-05-17T00:23:17Z",
"user_email": "samsung.kim@samsung.com",
"user_id": "f39c460fade34fecb05ede8f904b24b7",
"user_last_login_at": "2024-05-17T00:23:17Z",
"user_name": "Kim Samsung"
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
3.1.33.2 - 1.1
get /v1/groups/{group_id}/members
Description
Group Member list
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | Group ID Example : a946662dc4314dac93da413a32457459 | string | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | user_name optional | Group Member 성, 이름 Example : Kim Samsung | any of [string, null] | None |
| query | user_email optional | Group Member Email Example : samsung.kim@samsung.com | any of [string, null] | None |
| query | creator_name optional | Group Member 생성자 성, 이름 Example : Kim Samsung | any of [string, null] | None |
| query | creator_email optional | Group Member 생성자 Email Example : samsung.kim@samsung.com | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupMemberPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}/members
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Example HTTP response
Response 200
{
"count": 20,
"group_members": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_created_at": "2024-05-17T00:23:17Z",
"creator_email": "samsung.kim@samsung.com",
"creator_last_login_at": "2024-05-17T00:23:17Z",
"creator_name": "Kim Samsung",
"group_names": [
"TestGroup",
"SampleGroup"
],
"user_created_at": "2024-05-17T00:23:17Z",
"user_email": "samsung.kim@samsung.com",
"user_id": "f39c460fade34fecb05ede8f904b24b7",
"user_last_login_at": "2024-05-17T00:23:17Z",
"user_name": "Kim Samsung"
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
3.1.33.3 - 1.0
get /v1/groups/{group_id}/members
Description
Group Member list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | Group ID Example : a946662dc4314dac93da413a32457459 | string | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | user_name optional | Group Member 성, 이름 Example : Kim Samsung | any of [string, null] | None |
| query | user_email optional | Group Member Email Example : samsung.kim@samsung.com | any of [string, null] | None |
| query | creator_name optional | Group Member 생성자 성, 이름 Example : Kim Samsung | any of [string, null] | None |
| query | creator_email optional | Group Member 생성자 Email Example : samsung.kim@samsung.com | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupMemberPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}/members
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Example HTTP response
Response 200
{
"count": 20,
"group_members": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_created_at": "2024-05-17T00:23:17Z",
"creator_email": "samsung.kim@samsung.com",
"creator_last_login_at": "2024-05-17T00:23:17Z",
"creator_name": "Kim Samsung",
"group_names": [
"TestGroup",
"SampleGroup"
],
"user_created_at": "2024-05-17T00:23:17Z",
"user_email": "samsung.kim@samsung.com",
"user_id": "f39c460fade34fecb05ede8f904b24b7",
"user_last_login_at": "2024-05-17T00:23:17Z",
"user_name": "Kim Samsung"
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
3.1.34 - List access keys
3.1.34.1 - 1.2
get /v1/access-keys
Description
List access keys
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | with_count optional | with count Example : true | any of [string, null] | None |
| query | limit optional | limit Example : 20 | any of [integer, null] | None |
| query | marker optional | marker Example : 607e0938521643b5b4b266f343fae693 | any of [string, null] | None |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | account_id optional | Account Id Example : f39c460fade34fecb05ede8f904b24b7 | any of [string, null] | None |
| query | access_key_type optional | Access key type Example : PERMANENT | any of [string, null] | None |
| query | parent_access_key_id optional | Parent access key ID Example : f39c460fade34fecb05ede8f904b24b7 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ListAccessKeyResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/access-keys
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Example HTTP response
Response 200
{
"access_keys": [
{
"access_key": "b754b12b39da4ce29a40c5e324650bd0",
"access_key_type": "PERMANENT",
"account_id": "f39c460fade34fecb05ede8f904b24b7",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "description",
"expiration_timestamp": "9999-12-31T23:59:59Z",
"id": "6558fc9df5b54c8a985465bdf637e097",
"is_enabled": "true",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"parent_access_key_id": "92d6eid9e9ae4f868s842910k11573a3",
"secret_key": "c4150149-f7c6-46bc-9faa-d2b9d20e0899"
}
],
"count": 20,
"links": [
{
"href": "http://scp.samsungsdscloud.com/v1/access-keys?with_count=true&limit=20",
"rel": "first"
},
{
"href": "http://scp.samsungsdscloud.com/v1/access-keys?with_count=true&limit=20",
"rel": "self"
}
]
}
3.1.34.2 - 1.1
get /v1/access-keys
Description
List access keys
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | with_count optional | with count Example : true | any of [string, null] | None |
| query | limit optional | limit Example : 20 | any of [integer, null] | None |
| query | marker optional | marker Example : 607e0938521643b5b4b266f343fae693 | any of [string, null] | None |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | account_id optional | Account Id Example : f39c460fade34fecb05ede8f904b24b7 | any of [string, null] | None |
| query | access_key_type optional | Access key type Example : PERMANENT | any of [string, null] | None |
| query | parent_access_key_id optional | Parent access key ID Example : f39c460fade34fecb05ede8f904b24b7 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ListAccessKeyResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/access-keys
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Example HTTP response
Response 200
{
"access_keys": [
{
"access_key": "b754b12b39da4ce29a40c5e324650bd0",
"access_key_type": "PERMANENT",
"account_id": "f39c460fade34fecb05ede8f904b24b7",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "description",
"expiration_timestamp": "9999-12-31T23:59:59Z",
"id": "6558fc9df5b54c8a985465bdf637e097",
"is_enabled": "true",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"parent_access_key_id": "92d6eid9e9ae4f868s842910k11573a3",
"secret_key": "c4150149-f7c6-46bc-9faa-d2b9d20e0899"
}
],
"count": 20,
"links": [
{
"href": "http://scp.samsungsdscloud.com/v1/access-keys?with_count=true&limit=20",
"rel": "first"
},
{
"href": "http://scp.samsungsdscloud.com/v1/access-keys?with_count=true&limit=20",
"rel": "self"
}
]
}
3.1.34.3 - 1.0
get /v1/access-keys
Description
List access keys
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | with_count optional | with count Example : true | any of [string, null] | None |
| query | limit optional | limit Example : 20 | any of [integer, null] | None |
| query | marker optional | marker Example : 607e0938521643b5b4b266f343fae693 | any of [string, null] | None |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | account_id optional | Account Id Example : f39c460fade34fecb05ede8f904b24b7 | any of [string, null] | None |
| query | access_key_type optional | Access key type Example : PERMANENT | any of [string, null] | None |
| query | parent_access_key_id optional | Parent access key ID Example : f39c460fade34fecb05ede8f904b24b7 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ListAccessKeyResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/access-keys
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Example HTTP response
Response 200
{
"access_keys": [
{
"access_key": "b754b12b39da4ce29a40c5e324650bd0",
"access_key_type": "PERMANENT",
"account_id": "f39c460fade34fecb05ede8f904b24b7",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "description",
"expiration_timestamp": "9999-12-31T23:59:59Z",
"id": "6558fc9df5b54c8a985465bdf637e097",
"is_enabled": "true",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"parent_access_key_id": "92d6eid9e9ae4f868s842910k11573a3",
"secret_key": "c4150149-f7c6-46bc-9faa-d2b9d20e0899"
}
],
"count": 20,
"links": [
{
"href": "http://scp.samsungsdscloud.com/v1/access-keys?with_count=true&limit=20",
"rel": "first"
},
{
"href": "http://scp.samsungsdscloud.com/v1/access-keys?with_count=true&limit=20",
"rel": "self"
}
]
}
3.1.35 - List Groups
3.1.35.1 - 1.2
get /v1/groups
Description
List Groups
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | name optional | Group 이름 Example : TestGroup | any of [string, null] | None |
| query | types optional | Group Types Example : USER_DEFINED,DEFAULT | any of [string, null] | None |
| query | ids optional | Group IDs Example : 629114aa440b456797cc5da5d3d2ef5d,f2b62d3cba5f42a796783266507ce765 | any of [string, null] | None |
| query | has_member optional | Group Member 존재 여부 Example : false | any of [string, null] | None |
| query | has_role optional | Group Role 존재 여부 Example : false | any of [string, null] | None |
| query | is_completed optional | Group 완결 여부 Example : false | any of [string, null] | None |
| query | creator_name optional | Group 생성자 성, 이름 Example : Kim Samsung | any of [string, null] | None |
| query | creator_email optional | Group 생성자 Email Example : samsung.kim@samsung.com | any of [string, null] | None |
| query | modifier_name optional | Group 수정자 성, 이름 Example : Kim Samsung | any of [string, null] | None |
| query | modifier_email optional | Group 수정자 Email Example : samsung.kim@samsung.com | any of [string, null] | None |
| query | exclude_user_id optional | 제외할 사용자 ID Example : f39c460fade34fecb05ede8f904b24b7 | any of [string, null] | None |
| query | exclude_policy_id optional | 제외할 정책 ID Example : 37f2e31ff86b415698d7e8eeafab445d | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Example HTTP response
Response 200
{
"count": 20,
"groups": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"description": "Descriptions for group",
"domain_name": "scp",
"id": "f39c460fade34fecb05ede8f904b24b7",
"members": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_created_at": "2024-05-17T00:23:17Z",
"creator_email": "samsung.kim@samsung.com",
"creator_last_login_at": "2024-05-17T00:23:17Z",
"creator_name": "Kim Samsung",
"group_names": [
"TestGroup",
"SampleGroup"
],
"user_created_at": "2024-05-17T00:23:17Z",
"user_email": "samsung.kim@samsung.com",
"user_id": "f39c460fade34fecb05ede8f904b24b7",
"user_last_login_at": "2024-05-17T00:23:17Z",
"user_name": "Kim Samsung"
}
],
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"name": "TestGroup",
"policies": [],
"resource_type": "group",
"roles": [],
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda",
"type": "USER_DEFINED"
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
3.1.35.2 - 1.1
get /v1/groups
Description
List Groups
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | name optional | Group 이름 Example : TestGroup | any of [string, null] | None |
| query | types optional | Group Types Example : USER_DEFINED,DEFAULT | any of [string, null] | None |
| query | ids optional | Group IDs Example : 629114aa440b456797cc5da5d3d2ef5d,f2b62d3cba5f42a796783266507ce765 | any of [string, null] | None |
| query | has_member optional | Group Member 존재 여부 Example : false | any of [string, null] | None |
| query | has_role optional | Group Role 존재 여부 Example : false | any of [string, null] | None |
| query | is_completed optional | Group 완결 여부 Example : false | any of [string, null] | None |
| query | creator_name optional | Group 생성자 성, 이름 Example : Kim Samsung | any of [string, null] | None |
| query | creator_email optional | Group 생성자 Email Example : samsung.kim@samsung.com | any of [string, null] | None |
| query | modifier_name optional | Group 수정자 성, 이름 Example : Kim Samsung | any of [string, null] | None |
| query | modifier_email optional | Group 수정자 Email Example : samsung.kim@samsung.com | any of [string, null] | None |
| query | exclude_user_id optional | 제외할 사용자 ID Example : f39c460fade34fecb05ede8f904b24b7 | any of [string, null] | None |
| query | exclude_policy_id optional | 제외할 정책 ID Example : 37f2e31ff86b415698d7e8eeafab445d | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Example HTTP response
Response 200
{
"count": 20,
"groups": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"description": "Descriptions for group",
"domain_name": "scp",
"id": "f39c460fade34fecb05ede8f904b24b7",
"members": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_created_at": "2024-05-17T00:23:17Z",
"creator_email": "samsung.kim@samsung.com",
"creator_last_login_at": "2024-05-17T00:23:17Z",
"creator_name": "Kim Samsung",
"group_names": [
"TestGroup",
"SampleGroup"
],
"user_created_at": "2024-05-17T00:23:17Z",
"user_email": "samsung.kim@samsung.com",
"user_id": "f39c460fade34fecb05ede8f904b24b7",
"user_last_login_at": "2024-05-17T00:23:17Z",
"user_name": "Kim Samsung"
}
],
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"name": "TestGroup",
"policies": [],
"resource_type": "group",
"roles": [],
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda",
"type": "USER_DEFINED"
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
3.1.35.3 - 1.0
get /v1/groups
Description
List Groups
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | name optional | Group 이름 Example : TestGroup | any of [string, null] | None |
| query | types optional | Group Types Example : USER_DEFINED,DEFAULT | any of [string, null] | None |
| query | ids optional | Group IDs Example : 629114aa440b456797cc5da5d3d2ef5d,f2b62d3cba5f42a796783266507ce765 | any of [string, null] | None |
| query | has_member optional | Group Member 존재 여부 Example : false | any of [string, null] | None |
| query | has_role optional | Group Role 존재 여부 Example : false | any of [string, null] | None |
| query | is_completed optional | Group 완결 여부 Example : false | any of [string, null] | None |
| query | creator_name optional | Group 생성자 성, 이름 Example : Kim Samsung | any of [string, null] | None |
| query | creator_email optional | Group 생성자 Email Example : samsung.kim@samsung.com | any of [string, null] | None |
| query | modifier_name optional | Group 수정자 성, 이름 Example : Kim Samsung | any of [string, null] | None |
| query | modifier_email optional | Group 수정자 Email Example : samsung.kim@samsung.com | any of [string, null] | None |
| query | exclude_user_id optional | 제외할 사용자 ID Example : f39c460fade34fecb05ede8f904b24b7 | any of [string, null] | None |
| query | exclude_policy_id optional | 제외할 정책 ID Example : 37f2e31ff86b415698d7e8eeafab445d | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Example HTTP response
Response 200
{
"count": 20,
"groups": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"description": "Descriptions for group",
"domain_name": "scp",
"id": "f39c460fade34fecb05ede8f904b24b7",
"members": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_created_at": "2024-05-17T00:23:17Z",
"creator_email": "samsung.kim@samsung.com",
"creator_last_login_at": "2024-05-17T00:23:17Z",
"creator_name": "Kim Samsung",
"group_names": [
"TestGroup",
"SampleGroup"
],
"user_created_at": "2024-05-17T00:23:17Z",
"user_email": "samsung.kim@samsung.com",
"user_id": "f39c460fade34fecb05ede8f904b24b7",
"user_last_login_at": "2024-05-17T00:23:17Z",
"user_name": "Kim Samsung"
}
],
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"name": "TestGroup",
"policies": [],
"resource_type": "group",
"roles": [],
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda",
"type": "USER_DEFINED"
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
3.1.36 - List IAM users
3.1.36.1 - 1.2
get /v1/accounts/{account_id}/users
Description
List IAM users
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | account_id required | Account ID Example : | string | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | login_id optional | Login ID Example : | any of [string, null] | None |
| query | email optional | 사용자 Email Example : | any of [string, null] | None |
| query | nation_id optional | 국가 ID Example : | any of [string, null] | None |
| query | phone_number optional | 사용자 휴대 전화 번호 Example : | any of [string, null] | None |
| query | user_name optional | 사용자 이름 Example : | any of [string, null] | None |
| query | exclude_group_id optional | 예외 대상 그룹 Example : | any of [string, null] | None |
| query | exclude_policy_id optional | 예외 대상 정책 Example : | any of [string, null] | None |
| query | type optional | User Type Example : | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ListIAMUserResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/accounts/{account_id}/users
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
],
"users": [
{
"account_id": "",
"company_name": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"dst_offset": "",
"email": "",
"email_authenticated": "",
"first_name": "",
"groups": [
""
],
"id": "",
"last_login_at": "",
"last_name": "",
"last_password_update_at": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"password_reuse_count": "",
"phone_authenticated": "",
"policies": [],
"state": "",
"timezone": "",
"type": "",
"tz_id": "",
"user_name": "",
"utc_offset": ""
}
]
}
3.1.36.2 - 1.1
get /v1/accounts/{account_id}/users
Description
List IAM users
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | account_id required | Account ID Example : | string | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | login_id optional | Login ID Example : | any of [string, null] | None |
| query | email optional | 사용자 Email Example : | any of [string, null] | None |
| query | nation_id optional | 국가 ID Example : | any of [string, null] | None |
| query | phone_number optional | 사용자 휴대 전화 번호 Example : | any of [string, null] | None |
| query | user_name optional | 사용자 이름 Example : | any of [string, null] | None |
| query | exclude_group_id optional | 예외 대상 그룹 Example : | any of [string, null] | None |
| query | exclude_policy_id optional | 예외 대상 정책 Example : | any of [string, null] | None |
| query | type optional | User Type Example : | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ListIAMUserResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/accounts/{account_id}/users
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
],
"users": [
{
"account_id": "",
"company_name": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"dst_offset": "",
"email": "",
"email_authenticated": "",
"first_name": "",
"groups": [
""
],
"id": "",
"last_login_at": "",
"last_name": "",
"last_password_update_at": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"password_reuse_count": "",
"phone_authenticated": "",
"policies": [],
"state": "",
"timezone": "",
"type": "",
"tz_id": "",
"user_name": "",
"utc_offset": ""
}
]
}
3.1.36.3 - 1.0
get /v1/accounts/{account_id}/users
Description
List IAM users
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | account_id required | Account ID Example : | string | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | login_id optional | Login ID Example : | any of [string, null] | None |
| query | email optional | 사용자 Email Example : | any of [string, null] | None |
| query | nation_id optional | 국가 ID Example : | any of [string, null] | None |
| query | phone_number optional | 사용자 휴대 전화 번호 Example : | any of [string, null] | None |
| query | user_name optional | 사용자 이름 Example : | any of [string, null] | None |
| query | exclude_group_id optional | 예외 대상 그룹 Example : | any of [string, null] | None |
| query | exclude_policy_id optional | 예외 대상 정책 Example : | any of [string, null] | None |
| query | type optional | User Type Example : | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ListIAMUserResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/accounts/{account_id}/users
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
],
"users": [
{
"account_id": "",
"company_name": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"dst_offset": "",
"email": "",
"email_authenticated": "",
"first_name": "",
"groups": [
""
],
"id": "",
"last_login_at": "",
"last_name": "",
"last_password_update_at": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"password_reuse_count": "",
"phone_authenticated": "",
"policies": [],
"state": "",
"timezone": "",
"type": "",
"tz_id": "",
"user_name": "",
"utc_offset": ""
}
]
}
3.1.37 - List saml providers
3.1.37.1 - 1.2
get /v1/saml-providers
Description
List saml providers
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | federation_type optional | 자격증명공급자 유형 Example : | any of [string, null] | None |
| query | saml_provider_name optional | 자격증명공급자 이름 Example : | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ListSamlProviderResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/saml-providers
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"saml_providers": [
{
"account_id": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "",
"description": "",
"federation_type": "",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "",
"saml_provider_name": ""
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
3.1.37.2 - 1.1
get /v1/saml-providers
Description
List saml providers
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | federation_type optional | 자격증명공급자 유형 Example : | any of [string, null] | None |
| query | saml_provider_name optional | 자격증명공급자 이름 Example : | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ListSamlProviderResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/saml-providers
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"saml_providers": [
{
"account_id": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "",
"description": "",
"federation_type": "",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "",
"saml_provider_name": ""
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
3.1.37.3 - 1.0
get /v1/saml-providers
Description
List saml providers
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | federation_type optional | 자격증명공급자 유형 Example : | any of [string, null] | None |
| query | saml_provider_name optional | 자격증명공급자 이름 Example : | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ListSamlProviderResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/saml-providers
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"saml_providers": [
{
"account_id": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "",
"description": "",
"federation_type": "",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "",
"saml_provider_name": ""
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
3.1.38 - List service accounts
3.1.38.1 - 1.2
get /v1/service-accounts
Description
List service accounts
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | name optional | Service Account Name Example : | any of [string, null] | None |
| query | service optional | Service Account’s Service Example : | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServiceAccountListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/service-accounts
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Example HTTP response
Response 200
{
"service_accounts": [
{
"id": "",
"name": "",
"service": ""
}
]
}
3.1.38.2 - 1.1
get /v1/service-accounts
Description
List service accounts
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | name optional | Service Account Name Example : | any of [string, null] | None |
| query | service optional | Service Account’s Service Example : | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServiceAccountListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/service-accounts
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Example HTTP response
Response 200
{
"service_accounts": [
{
"id": "",
"name": "",
"service": ""
}
]
}
3.1.38.3 - 1.0
get /v1/service-accounts
Description
List service accounts
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | name optional | Service Account Name Example : | any of [string, null] | None |
| query | service optional | Service Account’s Service Example : | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServiceAccountListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/service-accounts
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Example HTTP response
Response 200
{
"service_accounts": [
{
"id": "",
"name": "",
"service": ""
}
]
}
3.1.39 - Modify a Group
3.1.39.1 - 1.2
put /v1/groups/{group_id}
Description
Modify a Group
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | Group ID Example : a946662dc4314dac93da413a32457459 | string | None |
| body | body required | GroupSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/groups/{group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Request body
{
"description": "Descriptions for group",
"name": "TestGroup"
}
Example HTTP response
Response 200
{
"group": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"description": "Descriptions for group",
"domain_name": "scp",
"id": "f39c460fade34fecb05ede8f904b24b7",
"members": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_created_at": "2024-05-17T00:23:17Z",
"creator_email": "samsung.kim@samsung.com",
"creator_last_login_at": "2024-05-17T00:23:17Z",
"creator_name": "Kim Samsung",
"group_names": [
"TestGroup",
"SampleGroup"
],
"user_created_at": "2024-05-17T00:23:17Z",
"user_email": "samsung.kim@samsung.com",
"user_id": "f39c460fade34fecb05ede8f904b24b7",
"user_last_login_at": "2024-05-17T00:23:17Z",
"user_name": "Kim Samsung"
}
],
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"name": "TestGroup",
"policies": [],
"resource_type": "group",
"roles": [],
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda",
"type": "USER_DEFINED"
}
}
3.1.39.2 - 1.1
put /v1/groups/{group_id}
Description
Modify a Group
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | Group ID Example : a946662dc4314dac93da413a32457459 | string | None |
| body | body required | GroupSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/groups/{group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Request body
{
"description": "Descriptions for group",
"name": "TestGroup"
}
Example HTTP response
Response 200
{
"group": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"description": "Descriptions for group",
"domain_name": "scp",
"id": "f39c460fade34fecb05ede8f904b24b7",
"members": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_created_at": "2024-05-17T00:23:17Z",
"creator_email": "samsung.kim@samsung.com",
"creator_last_login_at": "2024-05-17T00:23:17Z",
"creator_name": "Kim Samsung",
"group_names": [
"TestGroup",
"SampleGroup"
],
"user_created_at": "2024-05-17T00:23:17Z",
"user_email": "samsung.kim@samsung.com",
"user_id": "f39c460fade34fecb05ede8f904b24b7",
"user_last_login_at": "2024-05-17T00:23:17Z",
"user_name": "Kim Samsung"
}
],
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"name": "TestGroup",
"policies": [],
"resource_type": "group",
"roles": [],
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda",
"type": "USER_DEFINED"
}
}
3.1.39.3 - 1.0
put /v1/groups/{group_id}
Description
Modify a Group
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | Group ID Example : a946662dc4314dac93da413a32457459 | string | None |
| body | body required | GroupSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/groups/{group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Request body
{
"description": "Descriptions for group",
"name": "TestGroup"
}
Example HTTP response
Response 200
{
"group": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"description": "Descriptions for group",
"domain_name": "scp",
"id": "f39c460fade34fecb05ede8f904b24b7",
"members": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_created_at": "2024-05-17T00:23:17Z",
"creator_email": "samsung.kim@samsung.com",
"creator_last_login_at": "2024-05-17T00:23:17Z",
"creator_name": "Kim Samsung",
"group_names": [
"TestGroup",
"SampleGroup"
],
"user_created_at": "2024-05-17T00:23:17Z",
"user_email": "samsung.kim@samsung.com",
"user_id": "f39c460fade34fecb05ede8f904b24b7",
"user_last_login_at": "2024-05-17T00:23:17Z",
"user_name": "Kim Samsung"
}
],
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"name": "TestGroup",
"policies": [],
"resource_type": "group",
"roles": [],
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda",
"type": "USER_DEFINED"
}
}
3.1.40 - Query policy list
3.1.40.1 - 1.2
post /v1/policies/list
Description
Query policy list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | id optional | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | any of [string, null] | None |
| query | policy_name optional | Policy Name Example : ViewerAccess | any of [string, null] | None |
| query | policy_type optional | Policy Type Example : SYSTEM_MANAGED | any of [string, array[string], null] | None |
| query | service_type optional | Service Type Example : scp-iam | any of [string, array[string], null] | None |
| query | creator_name optional | Policy 생성자 성, 이름 Example : test1 | any of [string, null] | None |
| query | creator_email optional | Policy 생성자 Email Example : test@test.com | any of [string, null] | None |
| query | modifier_name optional | Policy 수정자 성, 이름 Example : test1 | any of [string, null] | None |
| query | modifier_email optional | Policy 수정자 Email Example : test@test.com | any of [string, null] | None |
| query | exclude_group_id optional | 제외할 Group ID Example : a946662dc4314dac93da413a32457459 | any of [string, null] | None |
| query | exclude_user_id optional | 제외할 User ID Example : | any of [string, null] | None |
| body | body required | PolicyQueryRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PolicyPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/policies/list
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Request body
{
"excluded_policy_ids": [
"37f2e31ff86b415698d7e8eeafab445d"
]
}
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"policies": [
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
3.1.40.2 - 1.1
post /v1/policies/list
Description
Query policy list
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | id optional | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | any of [string, null] | None |
| query | policy_name optional | Policy Name Example : ViewerAccess | any of [string, null] | None |
| query | policy_type optional | Policy Type Example : SYSTEM_MANAGED | any of [string, array[string], null] | None |
| query | service_type optional | Service Type Example : scp-iam | any of [string, array[string], null] | None |
| query | creator_name optional | Policy 생성자 성, 이름 Example : test1 | any of [string, null] | None |
| query | creator_email optional | Policy 생성자 Email Example : test@test.com | any of [string, null] | None |
| query | modifier_name optional | Policy 수정자 성, 이름 Example : test1 | any of [string, null] | None |
| query | modifier_email optional | Policy 수정자 Email Example : test@test.com | any of [string, null] | None |
| query | exclude_group_id optional | 제외할 Group ID Example : a946662dc4314dac93da413a32457459 | any of [string, null] | None |
| query | exclude_user_id optional | 제외할 User ID Example : | any of [string, null] | None |
| body | body required | PolicyQueryRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PolicyPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/policies/list
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Request body
{
"excluded_policy_ids": [
"37f2e31ff86b415698d7e8eeafab445d"
]
}
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"policies": [
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
3.1.40.3 - 1.0
post /v1/policies/list
Description
Query policy list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | id optional | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | any of [string, null] | None |
| query | policy_name optional | Policy Name Example : ViewerAccess | any of [string, null] | None |
| query | policy_type optional | Policy Type Example : SYSTEM_MANAGED | any of [string, array[string], null] | None |
| query | service_type optional | Service Type Example : scp-iam | any of [string, array[string], null] | None |
| query | creator_name optional | Policy 생성자 성, 이름 Example : test1 | any of [string, null] | None |
| query | creator_email optional | Policy 생성자 Email Example : test@test.com | any of [string, null] | None |
| query | modifier_name optional | Policy 수정자 성, 이름 Example : test1 | any of [string, null] | None |
| query | modifier_email optional | Policy 수정자 Email Example : test@test.com | any of [string, null] | None |
| query | exclude_group_id optional | 제외할 Group ID Example : a946662dc4314dac93da413a32457459 | any of [string, null] | None |
| query | exclude_user_id optional | 제외할 User ID Example : | any of [string, null] | None |
| body | body required | PolicyQueryRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PolicyPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/policies/list
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Request body
{
"excluded_policy_ids": [
"37f2e31ff86b415698d7e8eeafab445d"
]
}
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"policies": [
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
3.1.41 - Remove a permission into the resource based policy
3.1.41.1 - 1.2
delete /v1/resource-policies/{srn}/statements/{sid}
Description
Remove a permission into the resource based policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | srn required | 삼성 리소스 자원명 Example : c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= | string | None |
| path | sid required | Statement ID Example : Statement1 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/resource-policies/{srn}/statements/{sid}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Example HTTP response
Response 204
3.1.41.2 - 1.1
delete /v1/resource-policies/{srn}/statements/{sid}
Description
Remove a permission into the resource based policy
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | srn required | 삼성 리소스 자원명 Example : c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= | string | None |
| path | sid required | Statement ID Example : Statement1 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/resource-policies/{srn}/statements/{sid}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Example HTTP response
Response 204
3.1.41.3 - 1.0
delete /v1/resource-policies/{srn}/statements/{sid}
Description
Remove a permission into the resource based policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | srn required | 삼성 리소스 자원명 Example : c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= | string | None |
| path | sid required | Statement ID Example : Statement1 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/resource-policies/{srn}/statements/{sid}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Example HTTP response
Response 204
3.1.42 - Remove a User from a Group
3.1.42.1 - 1.2
delete /v1/groups/{group_id}/members/{user_id}
Description
Remove a User from a Group
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | Group ID Example : a946662dc4314dac93da413a32457459 | string | None |
| path | user_id required | User ID Example : ef50cdc207f05f6fb8f20219f229ed1f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}/members/{user_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Example HTTP response
Response 204
3.1.42.2 - 1.1
delete /v1/groups/{group_id}/members/{user_id}
Description
Remove a User from a Group
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | Group ID Example : a946662dc4314dac93da413a32457459 | string | None |
| path | user_id required | User ID Example : ef50cdc207f05f6fb8f20219f229ed1f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}/members/{user_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Example HTTP response
Response 204
3.1.42.3 - 1.0
delete /v1/groups/{group_id}/members/{user_id}
Description
Remove a User from a Group
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | Group ID Example : a946662dc4314dac93da413a32457459 | string | None |
| path | user_id required | User ID Example : ef50cdc207f05f6fb8f20219f229ed1f | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}/members/{user_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Example HTTP response
Response 204
3.1.43 - Remove policies
3.1.43.1 - 1.2
delete /v1/policies/bulk
Description
Remove policies
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ListPolicyRemoveRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/policies/bulk
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Request body
{
"ids": [
"37f2e31ff86b415698d7e8eeafab445d"
]
}
Example HTTP response
Response 204
3.1.43.2 - 1.1
delete /v1/policies/bulk
Description
Remove policies
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ListPolicyRemoveRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/policies/bulk
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Request body
{
"ids": [
"37f2e31ff86b415698d7e8eeafab445d"
]
}
Example HTTP response
Response 204
3.1.43.3 - 1.0
delete /v1/policies/bulk
Description
Remove policies
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ListPolicyRemoveRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/policies/bulk
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Request body
{
"ids": [
"37f2e31ff86b415698d7e8eeafab445d"
]
}
Example HTTP response
Response 204
3.1.44 - Remove policy assignment from group
3.1.44.1 - 1.2
delete /v1/groups/{group_id}/policy-bindings/{policy_id}
Description
Remove policy assignment from group
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | Group ID Example : a946662dc4314dac93da413a32457459 | string | None |
| path | policy_id required | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}/policy-bindings/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Example HTTP response
Response 204
3.1.44.2 - 1.1
delete /v1/groups/{group_id}/policy-bindings/{policy_id}
Description
Remove policy assignment from group
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | Group ID Example : a946662dc4314dac93da413a32457459 | string | None |
| path | policy_id required | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}/policy-bindings/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Example HTTP response
Response 204
3.1.44.3 - 1.0
delete /v1/groups/{group_id}/policy-bindings/{policy_id}
Description
Remove policy assignment from group
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | Group ID Example : a946662dc4314dac93da413a32457459 | string | None |
| path | policy_id required | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}/policy-bindings/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Example HTTP response
Response 204
3.1.45 - Remove saml providers
3.1.45.1 - 1.2
delete /v1/saml-providers/bulk
Description
Remove saml providers
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ListSamlProviderRemoveRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/saml-providers/bulk
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Request body
{
"ids": [
""
]
}
Example HTTP response
Response 204
3.1.45.2 - 1.1
delete /v1/saml-providers/bulk
Description
Remove saml providers
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ListSamlProviderRemoveRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/saml-providers/bulk
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Request body
{
"ids": [
""
]
}
Example HTTP response
Response 204
3.1.45.3 - 1.0
delete /v1/saml-providers/bulk
Description
Remove saml providers
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ListSamlProviderRemoveRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/saml-providers/bulk
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Request body
{
"ids": [
""
]
}
Example HTTP response
Response 204
3.1.46 - Remove the access key
3.1.46.1 - 1.2
delete /v1/access-keys/{access_key_id}
Description
Remove the access key
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | access_key_id required | Access key ID Example : f39c460fade34fecb05ede8f904b24b7 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/access-keys/{access_key_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Example HTTP response
Response 204
3.1.46.2 - 1.1
delete /v1/access-keys/{access_key_id}
Description
Remove the access key
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | access_key_id required | Access key ID Example : f39c460fade34fecb05ede8f904b24b7 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/access-keys/{access_key_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Example HTTP response
Response 204
3.1.46.3 - 1.0
delete /v1/access-keys/{access_key_id}
Description
Remove the access key
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | access_key_id required | Access key ID Example : f39c460fade34fecb05ede8f904b24b7 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/access-keys/{access_key_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Example HTTP response
Response 204
3.1.47 - Remove the access keys
3.1.47.1 - 1.2
delete /v1/access-keys/bulk
Description
Remove the access keys
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ListAccessKeyRemoveRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ListAccessKeyResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/access-keys/bulk
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Request body
{
"ids": [
""
],
"limit": 20,
"marker": "607e0938521643b5b4b266f343fae693",
"sort": "created_at:desc",
"with_count": "true"
}
Example HTTP response
Response 200
{
"access_keys": [
{
"access_key": "b754b12b39da4ce29a40c5e324650bd0",
"access_key_type": "PERMANENT",
"account_id": "f39c460fade34fecb05ede8f904b24b7",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "description",
"expiration_timestamp": "9999-12-31T23:59:59Z",
"id": "6558fc9df5b54c8a985465bdf637e097",
"is_enabled": "true",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"parent_access_key_id": "92d6eid9e9ae4f868s842910k11573a3",
"secret_key": "c4150149-f7c6-46bc-9faa-d2b9d20e0899"
}
],
"count": 20,
"links": [
{
"href": "http://scp.samsungsdscloud.com/v1/access-keys?with_count=true&limit=20",
"rel": "first"
},
{
"href": "http://scp.samsungsdscloud.com/v1/access-keys?with_count=true&limit=20",
"rel": "self"
}
]
}
3.1.47.2 - 1.1
delete /v1/access-keys/bulk
Description
Remove the access keys
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ListAccessKeyRemoveRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ListAccessKeyResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/access-keys/bulk
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Request body
{
"ids": [
""
],
"limit": 20,
"marker": "607e0938521643b5b4b266f343fae693",
"sort": "created_at:desc",
"with_count": "true"
}
Example HTTP response
Response 200
{
"access_keys": [
{
"access_key": "b754b12b39da4ce29a40c5e324650bd0",
"access_key_type": "PERMANENT",
"account_id": "f39c460fade34fecb05ede8f904b24b7",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "description",
"expiration_timestamp": "9999-12-31T23:59:59Z",
"id": "6558fc9df5b54c8a985465bdf637e097",
"is_enabled": "true",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"parent_access_key_id": "92d6eid9e9ae4f868s842910k11573a3",
"secret_key": "c4150149-f7c6-46bc-9faa-d2b9d20e0899"
}
],
"count": 20,
"links": [
{
"href": "http://scp.samsungsdscloud.com/v1/access-keys?with_count=true&limit=20",
"rel": "first"
},
{
"href": "http://scp.samsungsdscloud.com/v1/access-keys?with_count=true&limit=20",
"rel": "self"
}
]
}
3.1.47.3 - 1.0
delete /v1/access-keys/bulk
Description
Remove the access keys
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ListAccessKeyRemoveRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ListAccessKeyResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/access-keys/bulk
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Request body
{
"ids": [
""
],
"limit": 20,
"marker": "607e0938521643b5b4b266f343fae693",
"sort": "created_at:desc",
"with_count": "true"
}
Example HTTP response
Response 200
{
"access_keys": [
{
"access_key": "b754b12b39da4ce29a40c5e324650bd0",
"access_key_type": "PERMANENT",
"account_id": "f39c460fade34fecb05ede8f904b24b7",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "description",
"expiration_timestamp": "9999-12-31T23:59:59Z",
"id": "6558fc9df5b54c8a985465bdf637e097",
"is_enabled": "true",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"parent_access_key_id": "92d6eid9e9ae4f868s842910k11573a3",
"secret_key": "c4150149-f7c6-46bc-9faa-d2b9d20e0899"
}
],
"count": 20,
"links": [
{
"href": "http://scp.samsungsdscloud.com/v1/access-keys?with_count=true&limit=20",
"rel": "first"
},
{
"href": "http://scp.samsungsdscloud.com/v1/access-keys?with_count=true&limit=20",
"rel": "self"
}
]
}
3.1.48 - Remove the Group
3.1.48.1 - 1.2
delete /v1/groups/{group_id}
Description
Remove the Group
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | Group ID Example : a946662dc4314dac93da413a32457459 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Example HTTP response
Response 204
3.1.48.2 - 1.1
delete /v1/groups/{group_id}
Description
Remove the Group
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | Group ID Example : a946662dc4314dac93da413a32457459 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Example HTTP response
Response 204
3.1.48.3 - 1.0
delete /v1/groups/{group_id}
Description
Remove the Group
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | Group ID Example : a946662dc4314dac93da413a32457459 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Example HTTP response
Response 204
3.1.49 - Send Temporary Access Key OTP
3.1.49.1 - 1.2
post /v1/access-keys/send-otp
Description
Send Temporary Access Key OTP
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | AccessKeyOtpRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/access-keys/send-otp
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Request body
{
"locale": "ko_KR",
"method": "PHONE"
}
Example HTTP response
Response 204
3.1.49.2 - 1.1
post /v1/access-keys/send-otp
Description
Send Temporary Access Key OTP
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | AccessKeyOtpRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/access-keys/send-otp
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Request body
{
"locale": "ko_KR",
"method": "PHONE"
}
Example HTTP response
Response 204
3.1.49.3 - 1.0
post /v1/access-keys/send-otp
Description
Send Temporary Access Key OTP
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | AccessKeyOtpRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/access-keys/send-otp
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Request body
{
"locale": "ko_KR",
"method": "PHONE"
}
Example HTTP response
Response 204
3.1.50 - Set a permission into the resource based policy
3.1.50.1 - 1.2
put /v1/resource-policies/{srn}/statements/{sid}
Description
Set a permission into the resource based policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | srn required | 삼성 리소스 자원명 Example : c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= | string | None |
| path | sid required | Statement ID Example : Statement1 | string | None |
| body | body required | StatementCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | StatementResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/resource-policies/{srn}/statements/{sid}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Request body
{
"Action": [
"virtualserver:ShowVirtualServer"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": "*",
"Resource": [
"srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666"
],
"Sid": "Statement1"
}
Example HTTP response
Response 200
{
"Statement": {
"Action": [
"virtualserver:ShowVirtualServer"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"Principal": "*",
"Resource": [
"srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666"
],
"Sid": "Statement1"
}
}
3.1.50.2 - 1.1
put /v1/resource-policies/{srn}/statements/{sid}
Description
Set a permission into the resource based policy
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | srn required | 삼성 리소스 자원명 Example : c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= | string | None |
| path | sid required | Statement ID Example : Statement1 | string | None |
| body | body required | StatementCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | StatementResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/resource-policies/{srn}/statements/{sid}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Request body
{
"Action": [
"virtualserver:ShowVirtualServer"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": "*",
"Resource": [
"srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666"
],
"Sid": "Statement1"
}
Example HTTP response
Response 200
{
"Statement": {
"Action": [
"virtualserver:ShowVirtualServer"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"Principal": "*",
"Resource": [
"srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666"
],
"Sid": "Statement1"
}
}
3.1.50.3 - 1.0
put /v1/resource-policies/{srn}/statements/{sid}
Description
Set a permission into the resource based policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | srn required | 삼성 리소스 자원명 Example : c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= | string | None |
| path | sid required | Statement ID Example : Statement1 | string | None |
| body | body required | StatementCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | StatementResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/resource-policies/{srn}/statements/{sid}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Request body
{
"Action": [
"virtualserver:ShowVirtualServer"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": "*",
"Resource": [
"srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666"
],
"Sid": "Statement1"
}
Example HTTP response
Response 200
{
"Statement": {
"Action": [
"virtualserver:ShowVirtualServer"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"Principal": "*",
"Resource": [
"srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666"
],
"Sid": "Statement1"
}
}
3.1.51 - Set an access key
3.1.51.1 - 1.2
put /v1/access-keys/{access_key_id}
Description
Set or update an access key
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | access_key_id required | Access key ID Example : f39c460fade34fecb05ede8f904b24b7 | string | None |
| body | body required | AccessKeyUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AccessKeyResponse |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/access-keys/{access_key_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Request body
{
"is_enabled": "true"
}
Example HTTP response
Response 200
{
"access_key": {
"access_key": "b754b12b39da4ce29a40c5e324650bd0",
"access_key_type": "PERMANENT",
"account_id": "f39c460fade34fecb05ede8f904b24b7",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "description",
"expiration_timestamp": "9999-12-31T23:59:59Z",
"id": "6558fc9df5b54c8a985465bdf637e097",
"is_enabled": "true",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"parent_access_key_id": "92d6eid9e9ae4f868s842910k11573a3",
"secret_key": "c4150149-f7c6-46bc-9faa-d2b9d20e0899"
}
}
3.1.51.2 - 1.1
put /v1/access-keys/{access_key_id}
Description
Set or update an access key
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | access_key_id required | Access key ID Example : f39c460fade34fecb05ede8f904b24b7 | string | None |
| body | body required | AccessKeyUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AccessKeyResponse |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/access-keys/{access_key_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Request body
{
"is_enabled": "true"
}
Example HTTP response
Response 200
{
"access_key": {
"access_key": "b754b12b39da4ce29a40c5e324650bd0",
"access_key_type": "PERMANENT",
"account_id": "f39c460fade34fecb05ede8f904b24b7",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "description",
"expiration_timestamp": "9999-12-31T23:59:59Z",
"id": "6558fc9df5b54c8a985465bdf637e097",
"is_enabled": "true",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"parent_access_key_id": "92d6eid9e9ae4f868s842910k11573a3",
"secret_key": "c4150149-f7c6-46bc-9faa-d2b9d20e0899"
}
}
3.1.51.3 - 1.0
put /v1/access-keys/{access_key_id}
Description
Set or update an access key
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | access_key_id required | Access key ID Example : f39c460fade34fecb05ede8f904b24b7 | string | None |
| body | body required | AccessKeyUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AccessKeyResponse |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/access-keys/{access_key_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Request body
{
"is_enabled": "true"
}
Example HTTP response
Response 200
{
"access_key": {
"access_key": "b754b12b39da4ce29a40c5e324650bd0",
"access_key_type": "PERMANENT",
"account_id": "f39c460fade34fecb05ede8f904b24b7",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "description",
"expiration_timestamp": "9999-12-31T23:59:59Z",
"id": "6558fc9df5b54c8a985465bdf637e097",
"is_enabled": "true",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"parent_access_key_id": "92d6eid9e9ae4f868s842910k11573a3",
"secret_key": "c4150149-f7c6-46bc-9faa-d2b9d20e0899"
}
}
3.1.52 - Set role
3.1.52.1 - 1.2
put /v1/roles/{role_id}
Description
Set role
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | role_id required | 역할 ID Example : | string | None |
| body | body required | RoleSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | RoleShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/roles/{role_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Request body
{
"description": "",
"max_session_duration": 3600
}
Example HTTP response
Response 200
{
"role": {
"account_id": "",
"assume_role_policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_email": "",
"creator_name": "",
"description": "",
"id": "f39c460fade34fecb05ede8f904b24b7",
"max_session_duration": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"modifier_email": "",
"modifier_name": "",
"name": "",
"policies": [
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
],
"type": "USER_DEFINED"
}
}
3.1.52.2 - 1.1
put /v1/roles/{role_id}
Description
Set role
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | role_id required | 역할 ID Example : | string | None |
| body | body required | RoleSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | RoleShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/roles/{role_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Request body
{
"description": "",
"max_session_duration": 3600
}
Example HTTP response
Response 200
{
"role": {
"account_id": "",
"assume_role_policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_email": "",
"creator_name": "",
"description": "",
"id": "f39c460fade34fecb05ede8f904b24b7",
"max_session_duration": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"modifier_email": "",
"modifier_name": "",
"name": "",
"policies": [
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
],
"type": "USER_DEFINED"
}
}
3.1.52.3 - 1.0
put /v1/roles/{role_id}
Description
Set role
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | role_id required | 역할 ID Example : | string | None |
| body | body required | RoleSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | RoleShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/roles/{role_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Request body
{
"description": "",
"max_session_duration": 3600
}
Example HTTP response
Response 200
{
"role": {
"account_id": "",
"assume_role_policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_email": "",
"creator_name": "",
"description": "",
"id": "f39c460fade34fecb05ede8f904b24b7",
"max_session_duration": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"modifier_email": "",
"modifier_name": "",
"name": "",
"policies": [
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
],
"type": "USER_DEFINED"
}
}
3.1.53 - Set role trust policy
3.1.53.1 - 1.2
put /v1/roles/{role_id}/trust-policy
Description
Set role trust policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | role_id required | 역할 ID Example : | string | None |
| body | body required | RoleTrustPolicyRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | RoleTrustPolicyShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/roles/{role_id}/trust-policy
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Request body
{
"assume_role_policy_document": {
"Statement": [
{
"Action": [
"sts:AssumeRole"
],
"Condition": {},
"Effect": "Allow",
"Principal": "srn:e:1234:::iam:user/abc1234",
"Resource": [],
"Sid": "statement1"
}
],
"Version": "2024-07-01"
}
}
Example HTTP response
Response 200
{
"assume_role_policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac"
}
3.1.53.2 - 1.1
put /v1/roles/{role_id}/trust-policy
Description
Set role trust policy
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | role_id required | 역할 ID Example : | string | None |
| body | body required | RoleTrustPolicyRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | RoleTrustPolicyShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/roles/{role_id}/trust-policy
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Request body
{
"assume_role_policy_document": {
"Statement": [
{
"Action": [
"sts:AssumeRole"
],
"Condition": {},
"Effect": "Allow",
"Principal": "srn:e:1234:::iam:user/abc1234",
"Resource": [],
"Sid": "statement1"
}
],
"Version": "2024-07-01"
}
}
Example HTTP response
Response 200
{
"assume_role_policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac"
}
3.1.53.3 - 1.0
put /v1/roles/{role_id}/trust-policy
Description
Set role trust policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | role_id required | 역할 ID Example : | string | None |
| body | body required | RoleTrustPolicyRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | RoleTrustPolicyShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/roles/{role_id}/trust-policy
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Request body
{
"assume_role_policy_document": {
"Statement": [
{
"Action": [
"sts:AssumeRole"
],
"Condition": {},
"Effect": "Allow",
"Principal": "srn:e:1234:::iam:user/abc1234",
"Resource": [],
"Sid": "statement1"
}
],
"Version": "2024-07-01"
}
}
Example HTTP response
Response 200
{
"assume_role_policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac"
}
3.1.54 - Set the policy
3.1.54.1 - 1.2
put /v1/policies/{policy_id}
Description
Set the policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | policy_id required | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | string | None |
| body | body required | PolicySetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PolicyShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/policies/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Request body
{
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"policy_name": "Policy1",
"policy_version": {
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"Principal": null,
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"policy_version_name": "PolicyVersion-1"
}
}
Example HTTP response
Response 200
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
3.1.54.2 - 1.1
put /v1/policies/{policy_id}
Description
Set the policy
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | policy_id required | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | string | None |
| body | body required | PolicySetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PolicyShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/policies/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Request body
{
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"policy_name": "Policy1",
"policy_version": {
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"Principal": null,
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"policy_version_name": "PolicyVersion-1"
}
}
Example HTTP response
Response 200
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
3.1.54.3 - 1.0
put /v1/policies/{policy_id}
Description
Set the policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | policy_id required | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | string | None |
| body | body required | PolicySetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PolicyShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/policies/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Request body
{
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"policy_name": "Policy1",
"policy_version": {
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"Principal": null,
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"policy_version_name": "PolicyVersion-1"
}
}
Example HTTP response
Response 200
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
3.1.55 - Set the policy group binding
3.1.55.1 - 1.2
put /v1/policies/{policy_id}/bindings
Description
Set the policy group binding
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | policy_id required | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | string | None |
| body | body required | PolicyBindingSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PolicyBindingPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/policies/{policy_id}/bindings
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Request body
{
"add_ids": [
"a946662dc4314dac93da413a32457459"
],
"identity_type": "GROUP",
"remove_ids": [
"a946662dc4314dac93da413a32457459"
]
}
Example HTTP response
Response 200
{
"count": 20,
"groups": [
{
"created_at": "2025-03-26T10:18:04Z",
"created_by": "4a816a3f5099442ebb52daefc1f7be32",
"creator_email": "-",
"creator_name": "-",
"description": "openapi-ga2-test-group",
"domain_name": "scp",
"id": "19fca177a57940daa5817960373c6542",
"modified_at": "2025-03-26T10:18:04Z",
"modified_by": "4a816a3f5099442ebb52daefc1f7be32",
"modifier_email": "-",
"modifier_name": "-",
"name": "openapi-ga2-testgroup5",
"policies": [],
"roles": [],
"srn": "srn:dev2::1d9cc99917ff41bb992276ac0ae9e4c8:::iam:group/19fca177a57940daa5817960373c6542",
"type": "USER_DEFINED"
}
],
"page": 0,
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"roles": [
{
"account_id": "d7aba97100564b34a0f4f77c4bc7a303",
"assume_role_policy_document": {
"Statement": [
{
"Action": "*",
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": "*",
"Principal": "*",
"Resource": "*",
"Sid": "statement1"
}
],
"Version": "2024-07-01"
},
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_email": "-",
"creator_name": "-",
"description": "string",
"id": "f39c460fade34fecb05ede8f904b24b7",
"max_session_duration": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"modifier_email": "-",
"modifier_name": "-",
"name": "string",
"type": "DEFAULT"
}
],
"size": 20,
"sort": [
"created_at:asc"
],
"users": [
{
"access_control": false,
"account_id": "d7aba97100564b34a0f4f77c4bc7a303",
"account_name": "",
"allowed_ip_addresses": "",
"company_name": "",
"created_at": "2024-11-15T06:57:42.000000Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"domain_name": "scp",
"dst_offset": "+09:00",
"email": "samsung.kim@samsung.com",
"email_authenticate_code": "8ada8861bad2423295e4bb576bee5886",
"email_authenticated": true,
"first_name": "",
"groups": [],
"id": "90dddfc2b1e04edba54ba2b41539a9ac",
"keycloak_id": "127e3d8c-66dc-4b1b-b38b-9a1d0c6d5507",
"keystone_credential": "",
"last_login_at": "2024-11-25T06:57:42.000000Z",
"last_name": "",
"last_password_update_at": "",
"login_id": "",
"modified_at": "2024-11-17T06:57:42.000000Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"nation_id": "+82",
"phone_authenticated": false,
"phone_number": "0000000000",
"policies": [],
"state": "ACTIVE",
"temporary_password": false,
"term_region_id": "1",
"timezone": "Asia/Seoul",
"type": "IAM",
"tz_id": "Asia/Seoul",
"user_name": "Kim Samsung",
"utc_offset": "+09:00"
}
]
}
3.1.55.2 - 1.1
put /v1/policies/{policy_id}/bindings
Description
Set the policy group binding
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | policy_id required | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | string | None |
| body | body required | PolicyBindingSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PolicyBindingPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/policies/{policy_id}/bindings
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Request body
{
"add_ids": [
"a946662dc4314dac93da413a32457459"
],
"identity_type": "GROUP",
"remove_ids": [
"a946662dc4314dac93da413a32457459"
]
}
Example HTTP response
Response 200
{
"count": 20,
"groups": [
{
"created_at": "2025-03-26T10:18:04Z",
"created_by": "4a816a3f5099442ebb52daefc1f7be32",
"creator_email": "-",
"creator_name": "-",
"description": "openapi-ga2-test-group",
"domain_name": "scp",
"id": "19fca177a57940daa5817960373c6542",
"modified_at": "2025-03-26T10:18:04Z",
"modified_by": "4a816a3f5099442ebb52daefc1f7be32",
"modifier_email": "-",
"modifier_name": "-",
"name": "openapi-ga2-testgroup5",
"policies": [],
"roles": [],
"srn": "srn:dev2::1d9cc99917ff41bb992276ac0ae9e4c8:::iam:group/19fca177a57940daa5817960373c6542",
"type": "USER_DEFINED"
}
],
"page": 0,
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"roles": [
{
"account_id": "d7aba97100564b34a0f4f77c4bc7a303",
"assume_role_policy_document": {
"Statement": [
{
"Action": "*",
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": "*",
"Principal": "*",
"Resource": "*",
"Sid": "statement1"
}
],
"Version": "2024-07-01"
},
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_email": "-",
"creator_name": "-",
"description": "string",
"id": "f39c460fade34fecb05ede8f904b24b7",
"max_session_duration": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"modifier_email": "-",
"modifier_name": "-",
"name": "string",
"type": "DEFAULT"
}
],
"size": 20,
"sort": [
"created_at:asc"
],
"users": [
{
"access_control": false,
"account_id": "d7aba97100564b34a0f4f77c4bc7a303",
"account_name": "",
"allowed_ip_addresses": "",
"company_name": "",
"created_at": "2024-11-15T06:57:42.000000Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"domain_name": "scp",
"dst_offset": "+09:00",
"email": "samsung.kim@samsung.com",
"email_authenticate_code": "8ada8861bad2423295e4bb576bee5886",
"email_authenticated": true,
"first_name": "",
"groups": [],
"id": "90dddfc2b1e04edba54ba2b41539a9ac",
"keycloak_id": "127e3d8c-66dc-4b1b-b38b-9a1d0c6d5507",
"keystone_credential": "",
"last_login_at": "2024-11-25T06:57:42.000000Z",
"last_name": "",
"last_password_update_at": "",
"login_id": "",
"modified_at": "2024-11-17T06:57:42.000000Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"nation_id": "+82",
"phone_authenticated": false,
"phone_number": "0000000000",
"policies": [],
"state": "ACTIVE",
"temporary_password": false,
"term_region_id": "1",
"timezone": "Asia/Seoul",
"type": "IAM",
"tz_id": "Asia/Seoul",
"user_name": "Kim Samsung",
"utc_offset": "+09:00"
}
]
}
3.1.55.3 - 1.0
put /v1/policies/{policy_id}/bindings
Description
Set the policy group binding
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | policy_id required | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | string | None |
| body | body required | PolicyBindingSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PolicyBindingPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/policies/{policy_id}/bindings
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Request body
{
"add_ids": [
"a946662dc4314dac93da413a32457459"
],
"identity_type": "GROUP",
"remove_ids": [
"a946662dc4314dac93da413a32457459"
]
}
Example HTTP response
Response 200
{
"count": 20,
"groups": [
{
"created_at": "2025-03-26T10:18:04Z",
"created_by": "4a816a3f5099442ebb52daefc1f7be32",
"creator_email": "-",
"creator_name": "-",
"description": "openapi-ga2-test-group",
"domain_name": "scp",
"id": "19fca177a57940daa5817960373c6542",
"modified_at": "2025-03-26T10:18:04Z",
"modified_by": "4a816a3f5099442ebb52daefc1f7be32",
"modifier_email": "-",
"modifier_name": "-",
"name": "openapi-ga2-testgroup5",
"policies": [],
"roles": [],
"srn": "srn:dev2::1d9cc99917ff41bb992276ac0ae9e4c8:::iam:group/19fca177a57940daa5817960373c6542",
"type": "USER_DEFINED"
}
],
"page": 0,
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"roles": [
{
"account_id": "d7aba97100564b34a0f4f77c4bc7a303",
"assume_role_policy_document": {
"Statement": [
{
"Action": "*",
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": "*",
"Principal": "*",
"Resource": "*",
"Sid": "statement1"
}
],
"Version": "2024-07-01"
},
"created_at": "2024-05-17T00:23:17Z",
"created_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"creator_email": "-",
"creator_name": "-",
"description": "string",
"id": "f39c460fade34fecb05ede8f904b24b7",
"max_session_duration": 0,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "ef50cdc207f05f6fb8f20219f229ed1f",
"modifier_email": "-",
"modifier_name": "-",
"name": "string",
"type": "DEFAULT"
}
],
"size": 20,
"sort": [
"created_at:asc"
],
"users": [
{
"access_control": false,
"account_id": "d7aba97100564b34a0f4f77c4bc7a303",
"account_name": "",
"allowed_ip_addresses": "",
"company_name": "",
"created_at": "2024-11-15T06:57:42.000000Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"domain_name": "scp",
"dst_offset": "+09:00",
"email": "samsung.kim@samsung.com",
"email_authenticate_code": "8ada8861bad2423295e4bb576bee5886",
"email_authenticated": true,
"first_name": "",
"groups": [],
"id": "90dddfc2b1e04edba54ba2b41539a9ac",
"keycloak_id": "127e3d8c-66dc-4b1b-b38b-9a1d0c6d5507",
"keystone_credential": "",
"last_login_at": "2024-11-25T06:57:42.000000Z",
"last_name": "",
"last_password_update_at": "",
"login_id": "",
"modified_at": "2024-11-17T06:57:42.000000Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"nation_id": "+82",
"phone_authenticated": false,
"phone_number": "0000000000",
"policies": [],
"state": "ACTIVE",
"temporary_password": false,
"term_region_id": "1",
"timezone": "Asia/Seoul",
"type": "IAM",
"tz_id": "Asia/Seoul",
"user_name": "Kim Samsung",
"utc_offset": "+09:00"
}
]
}
3.1.56 - Set the resource based policy
3.1.56.1 - 1.2
put /v1/resource-policies/{srn}
Description
Set the resource based policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | srn required | 삼성 리소스 자원명 Example : c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= | string | None |
| body | body required | ResourcePolicySetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResourcePolicyShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/resource-policies/{srn}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Request body
{
"policy_version": {
"policy_document": {
"Statement": [
{
"Action": [
"virtualserver:ShowVirtualServer"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"Principal": "*",
"Resource": [
"srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"policy_version_name": "PolicyVersion-1"
}
}
Example HTTP response
Response 200
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "f39c460fade34fecb05ede8f904b24b7",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "RESOURCE_BASED",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"virtualserver:ShowVirtualServer"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"Principal": "*",
"Resource": [
"srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
}
}
],
"service_name": "Identity Access Management"
}
3.1.56.2 - 1.1
put /v1/resource-policies/{srn}
Description
Set the resource based policy
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | srn required | 삼성 리소스 자원명 Example : c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= | string | None |
| body | body required | ResourcePolicySetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResourcePolicyShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/resource-policies/{srn}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Request body
{
"policy_version": {
"policy_document": {
"Statement": [
{
"Action": [
"virtualserver:ShowVirtualServer"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"Principal": "*",
"Resource": [
"srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"policy_version_name": "PolicyVersion-1"
}
}
Example HTTP response
Response 200
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "f39c460fade34fecb05ede8f904b24b7",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "RESOURCE_BASED",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"virtualserver:ShowVirtualServer"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"Principal": "*",
"Resource": [
"srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
}
}
],
"service_name": "Identity Access Management"
}
3.1.56.3 - 1.0
put /v1/resource-policies/{srn}
Description
Set the resource based policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | srn required | 삼성 리소스 자원명 Example : c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= | string | None |
| body | body required | ResourcePolicySetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResourcePolicyShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/resource-policies/{srn}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Request body
{
"policy_version": {
"policy_document": {
"Statement": [
{
"Action": [
"virtualserver:ShowVirtualServer"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"Principal": "*",
"Resource": [
"srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"policy_version_name": "PolicyVersion-1"
}
}
Example HTTP response
Response 200
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "f39c460fade34fecb05ede8f904b24b7",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "RESOURCE_BASED",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"virtualserver:ShowVirtualServer"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"Principal": "*",
"Resource": [
"srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
}
}
],
"service_name": "Identity Access Management"
}
3.1.57 - Show group policy
3.1.57.1 - 1.2
get /v1/groups/{group_id}/policy-bindings
Description
Show group policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | Group ID Example : a946662dc4314dac93da413a32457459 | string | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | policy_id optional | Policy Id Example : 37f2e31ff86b415698d7e8eeafab445d | any of [string, null] | None |
| query | policy_name optional | Policy Name Example : ViewerAccess | any of [string, null] | None |
| query | policy_type optional | Policy Type List Example : ['SYSTEM_MANAGED', 'USER_DEFINED'] | any of [string, array[string], null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupPolicyPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}/policy-bindings
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"policies": [
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
3.1.57.2 - 1.1
get /v1/groups/{group_id}/policy-bindings
Description
Show group policy
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | Group ID Example : a946662dc4314dac93da413a32457459 | string | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | policy_id optional | Policy Id Example : 37f2e31ff86b415698d7e8eeafab445d | any of [string, null] | None |
| query | policy_name optional | Policy Name Example : ViewerAccess | any of [string, null] | None |
| query | policy_type optional | Policy Type List Example : ['SYSTEM_MANAGED', 'USER_DEFINED'] | any of [string, array[string], null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupPolicyPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}/policy-bindings
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"policies": [
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
3.1.57.3 - 1.0
get /v1/groups/{group_id}/policy-bindings
Description
Show group policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | Group ID Example : a946662dc4314dac93da413a32457459 | string | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | policy_id optional | Policy Id Example : 37f2e31ff86b415698d7e8eeafab445d | any of [string, null] | None |
| query | policy_name optional | Policy Name Example : ViewerAccess | any of [string, null] | None |
| query | policy_type optional | Policy Type List Example : ['SYSTEM_MANAGED', 'USER_DEFINED'] | any of [string, array[string], null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupPolicyPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}/policy-bindings
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"policies": [
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
3.1.58 - Show the policy
3.1.58.1 - 1.2
get /v1/policies/{policy_id}
Description
Show the policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | policy_id required | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PolicyShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/policies/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Example HTTP response
Response 200
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
3.1.58.2 - 1.1
get /v1/policies/{policy_id}
Description
Show the policy
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | policy_id required | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PolicyShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/policies/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Example HTTP response
Response 200
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
3.1.58.3 - 1.0
get /v1/policies/{policy_id}
Description
Show the policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | policy_id required | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PolicyShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/policies/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Example HTTP response
Response 200
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "c1b1fc611eb34eccbccfb563f77395ee",
"description": "Descriptions for policy",
"domain_name": "scp",
"id": "37f2e31ff86b415698d7e8eeafab445d",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "IDENTITY_BASED",
"policy_name": "PolicyName",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"iam:*"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"NotAction": [],
"Principal": [],
"Resource": [
"*"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
},
"policy_id": "37f2e31ff86b415698d7e8eeafab445d",
"policy_version_name": "PolicyVersion-1"
}
],
"resource_type": "policy",
"service_name": "Identity Access Management",
"service_type": "iam",
"srn": "srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d",
"state": "ACTIVE"
}
3.1.59 - Show the resource based policy
3.1.59.1 - 1.2
get /v1/resource-policies/{srn}
Description
Show the resource based policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | srn required | 삼성 리소스 자원명 Example : c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResourcePolicyShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/resource-policies/{srn}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Example HTTP response
Response 200
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "f39c460fade34fecb05ede8f904b24b7",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "RESOURCE_BASED",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"virtualserver:ShowVirtualServer"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"Principal": "*",
"Resource": [
"srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
}
}
],
"service_name": "Identity Access Management"
}
3.1.59.2 - 1.1
get /v1/resource-policies/{srn}
Description
Show the resource based policy
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | srn required | 삼성 리소스 자원명 Example : c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResourcePolicyShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/resource-policies/{srn}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Example HTTP response
Response 200
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "f39c460fade34fecb05ede8f904b24b7",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "RESOURCE_BASED",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"virtualserver:ShowVirtualServer"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"Principal": "*",
"Resource": [
"srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
}
}
],
"service_name": "Identity Access Management"
}
3.1.59.3 - 1.0
get /v1/resource-policies/{srn}
Description
Show the resource based policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | srn required | 삼성 리소스 자원명 Example : c3JuOmRldjI6OjEyMzQ1Njc4OTAxMDIzNDU2OTA6a3Itd2VzdDE6OnZpcnR1YWxzZXJ2ZXI6dmlydHVhbC1zZXJ2ZXIvYWJjZGUtMTIzNC01NTU1LTY2NjY= | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResourcePolicyShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/resource-policies/{srn}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Example HTTP response
Response 200
{
"account_id": "e99c73a8690d4ae39ae75e38a26f2b99",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_email": "samsung.kim@samsung.com",
"creator_name": "Kim Samsung",
"default_version_id": "f39c460fade34fecb05ede8f904b24b7",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_email": "samsung.kim@samsung.com",
"modifier_name": "Kim Samsung",
"policy_category": "RESOURCE_BASED",
"policy_type": "USER_DEFINED",
"policy_versions": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "c1b1fc611eb34eccbccfb563f77395ee",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"policy_document": {
"Statement": [
{
"Action": [
"virtualserver:ShowVirtualServer"
],
"Condition": {
"StringEquals": {
"scp:RequestedRegion": [
"kr-west1"
]
}
},
"Effect": "Allow",
"Principal": "*",
"Resource": [
"srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666"
],
"Sid": "Statement1"
}
],
"Version": "2024-07-01"
}
}
],
"service_name": "Identity Access Management"
}
3.1.60 - Update IAM user
3.1.60.1 - 1.2
put /v1/accounts/{account_id}/users/{user_id}
Description
Update IAM user
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | account_id required | Account ID Example : | string | None |
| path | user_id required | User ID Example : | string | None |
| body | body required | IAMUserUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | UserResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/accounts/{account_id}/users/{user_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Request body
{
"description": "",
"password_reuse_count": ""
}
Example HTTP response
Response 200
{
"account_id": "",
"company_name": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"dst_offset": "",
"email": "",
"email_authenticated": "",
"first_name": "",
"id": "",
"last_login_at": "",
"last_name": "",
"last_password_update_at": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"password_reuse_count": "",
"phone_authenticated": "",
"policies": [],
"state": "",
"timezone": "",
"type": "",
"tz_id": "",
"user_name": "",
"utc_offset": ""
}
3.1.60.2 - 1.1
put /v1/accounts/{account_id}/users/{user_id}
Description
Update IAM user
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | account_id required | Account ID Example : | string | None |
| path | user_id required | User ID Example : | string | None |
| body | body required | IAMUserUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | UserResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/accounts/{account_id}/users/{user_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Request body
{
"description": "",
"password_reuse_count": ""
}
Example HTTP response
Response 200
{
"account_id": "",
"company_name": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"dst_offset": "",
"email": "",
"email_authenticated": "",
"first_name": "",
"id": "",
"last_login_at": "",
"last_name": "",
"last_password_update_at": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"password_reuse_count": "",
"phone_authenticated": "",
"policies": [],
"state": "",
"timezone": "",
"type": "",
"tz_id": "",
"user_name": "",
"utc_offset": ""
}
3.1.60.3 - 1.0
put /v1/accounts/{account_id}/users/{user_id}
Description
Update IAM user
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | account_id required | Account ID Example : | string | None |
| path | user_id required | User ID Example : | string | None |
| body | body required | IAMUserUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | UserResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/accounts/{account_id}/users/{user_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Request body
{
"description": "",
"password_reuse_count": ""
}
Example HTTP response
Response 200
{
"account_id": "",
"company_name": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"dst_offset": "",
"email": "",
"email_authenticated": "",
"first_name": "",
"id": "",
"last_login_at": "",
"last_name": "",
"last_password_update_at": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"password_reuse_count": "",
"phone_authenticated": "",
"policies": [],
"state": "",
"timezone": "",
"type": "",
"tz_id": "",
"user_name": "",
"utc_offset": ""
}
3.1.61 - Update IAM user password
3.1.61.1 - 1.2
put /v1/accounts/{account_id}/users/{user_id}/password
Description
Update IAM user password
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | account_id required | Account ID Example : | string | None |
| path | user_id required | User ID Example : | string | None |
| body | body required | IAMUserPasswordUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | IAMCreateUserResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/accounts/{account_id}/users/{user_id}/password
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2"
Request body
{
"password": "",
"temporary_password": false
}
Example HTTP response
Response 200
{
"account_id": "",
"company_name": "",
"console_url": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"dst_offset": "",
"email": "",
"email_authenticated": "",
"first_name": "",
"id": "",
"last_login_at": "",
"last_name": "",
"last_password_update_at": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"password": "",
"password_reuse_count": "",
"phone_authenticated": "",
"policies": [],
"state": "",
"timezone": "",
"type": "",
"tz_id": "",
"user_name": "",
"utc_offset": ""
}
3.1.61.2 - 1.1
put /v1/accounts/{account_id}/users/{user_id}/password
Description
Update IAM user password
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | account_id required | Account ID Example : | string | None |
| path | user_id required | User ID Example : | string | None |
| body | body required | IAMUserPasswordUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | IAMCreateUserResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/accounts/{account_id}/users/{user_id}/password
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1"
Request body
{
"password": "",
"temporary_password": false
}
Example HTTP response
Response 200
{
"account_id": "",
"company_name": "",
"console_url": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"dst_offset": "",
"email": "",
"email_authenticated": "",
"first_name": "",
"id": "",
"last_login_at": "",
"last_name": "",
"last_password_update_at": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"password": "",
"password_reuse_count": "",
"phone_authenticated": "",
"policies": [],
"state": "",
"timezone": "",
"type": "",
"tz_id": "",
"user_name": "",
"utc_offset": ""
}
3.1.61.3 - 1.0
put /v1/accounts/{account_id}/users/{user_id}/password
Description
Update IAM user password
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | account_id required | Account ID Example : | string | None |
| path | user_id required | User ID Example : | string | None |
| body | body required | IAMUserPasswordUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | IAMCreateUserResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/accounts/{account_id}/users/{user_id}/password
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0"
Request body
{
"password": "",
"temporary_password": false
}
Example HTTP response
Response 200
{
"account_id": "",
"company_name": "",
"console_url": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "",
"dst_offset": "",
"email": "",
"email_authenticated": "",
"first_name": "",
"id": "",
"last_login_at": "",
"last_name": "",
"last_password_update_at": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "",
"password": "",
"password_reuse_count": "",
"phone_authenticated": "",
"policies": [],
"state": "",
"timezone": "",
"type": "",
"tz_id": "",
"user_name": "",
"utc_offset": ""
}
3.1.62 - Update saml provider information
3.1.62.1 - 1.2
put /v1/saml-providers/{saml_provider_id}
Description
Update saml provider information
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | saml_provider_id required | 자격증명공급자 ID Example : | string | None |
| body | body required | SamlProviderUpdateRequestData |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SamlProviderDetailResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/saml-providers/{saml_provider_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.2,"
"Content-Type = multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW"
Request body
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="description"
SAML provider Description
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="file"; filename="keycloak-idp-saml.xml"
Content-Type: application/xml
(data)
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="saml_provider_name"
IdpTest
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="tags"
[{'key': 'company', 'value': 'SDS'}]
------WebKitFormBoundary7MA4YWxkTrZu0gW--
Example HTTP response
Response 200
{
"account_id": "",
"acs_url": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "",
"description": "",
"federation_type": "",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"idp_cert_end": "",
"idp_file_data": "",
"idp_file_name": "",
"idp_file_size": "",
"idp_issuer_url": "",
"idp_sso_url": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "",
"saml_provider_name": ""
}
3.1.62.2 - 1.1
put /v1/saml-providers/{saml_provider_id}
Description
Update saml provider information
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | saml_provider_id required | 자격증명공급자 ID Example : | string | None |
| body | body required | SamlProviderUpdateRequestData |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SamlProviderDetailResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/saml-providers/{saml_provider_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.1,"
"Content-Type = multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW"
Request body
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="description"
SAML provider Description
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="file"; filename="keycloak-idp-saml.xml"
Content-Type: application/xml
(data)
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="saml_provider_name"
IdpTest
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="tags"
[{'key': 'company', 'value': 'SDS'}]
------WebKitFormBoundary7MA4YWxkTrZu0gW--
Example HTTP response
Response 200
{
"account_id": "",
"acs_url": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "",
"description": "",
"federation_type": "",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"idp_cert_end": "",
"idp_file_data": "",
"idp_file_name": "",
"idp_file_size": "",
"idp_issuer_url": "",
"idp_sso_url": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "",
"saml_provider_name": ""
}
3.1.62.3 - 1.0
put /v1/saml-providers/{saml_provider_id}
Description
Update saml provider information
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | saml_provider_id required | 자격증명공급자 ID Example : | string | None |
| body | body required | SamlProviderUpdateRequestData |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | SamlProviderDetailResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/saml-providers/{saml_provider_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam 1.0,"
"Content-Type = multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW"
Request body
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="description"
SAML provider Description
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="file"; filename="keycloak-idp-saml.xml"
Content-Type: application/xml
(data)
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="saml_provider_name"
IdpTest
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="tags"
[{'key': 'company', 'value': 'SDS'}]
------WebKitFormBoundary7MA4YWxkTrZu0gW--
Example HTTP response
Response 200
{
"account_id": "",
"acs_url": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "",
"description": "",
"federation_type": "",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"idp_cert_end": "",
"idp_file_data": "",
"idp_file_name": "",
"idp_file_size": "",
"idp_issuer_url": "",
"idp_sso_url": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "",
"saml_provider_name": ""
}
3.2 - Models
3.2.1 - AccessKey
| Name | Description | Schema | Default |
|---|---|---|---|
| access_key required | Access Key Example : b754b12b39da4ce29a40c5e324650bd0 | string | |
| access_key_type required | Access key type Example : PERMANENT | enum (PERMANENT, TEMPORARY, SECRET_VAULT_TEMPORARY) | |
| account_id required | Account Id Example : f39c460fade34fecb05ede8f904b24b7 | string | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| description optional | Description Example : description | any of [string, null] | |
| expiration_timestamp required | Access key expiration timestamp Example : 9999-12-31T23:59:59Z | string (date-time) | |
| id required | ID Example : 6558fc9df5b54c8a985465bdf637e097 | string | |
| is_enabled required | 활성화 여부 Example : true | boolean | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| parent_access_key_id required | Parent access key ID which is used for temporary access key to create by Example : 92d6eid9e9ae4f868s842910k11573a3 | any of [string, null] | |
| secret_key required | Secret Key Example : c4150149-f7c6-46bc-9faa-d2b9d20e0899 | string |
3.2.2 - AccessKeyCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| access_key_type required | Access key type Example : PERMANENT | enum (PERMANENT, TEMPORARY) | |
| account_id optional | Account Id Example : f39c460fade34fecb05ede8f904b24b7 | string | |
| description optional | Description Example : description | any of [string, null] | |
| duration optional | Expiration duration Example : P1Y2M10DT2H30M15S | any of [string, null] | |
| parent_access_key_id optional | Required access key for creating temporary access key Example : 92d6eid9e9ae4f868s842910k11573a3 | any of [string, null] | |
| passcode optional | Required for temporary access key Example : 000000 | any of [string, null] |
3.2.3 - AccessKeyOtpRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| locale optional | Locale Example : ko_KR | enum (ko_KR, en_US) | |
| method optional | OTP method (EMAIL or PHONE) Example : PHONE | enum (PHONE, EMAIL) |
3.2.4 - AccessKeyResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| access_key required | AccessKey |
3.2.5 - AccessKeyUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| is_enabled optional | 활성화 여부 Example : true | boolean | True |
3.2.6 - CreatedGroupMember
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | 생성 일시 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : ef50cdc207f05f6fb8f20219f229ed1f | string | |
| creator_email optional | 생성자 Email Example : samsung.kim@samsung.com | string | - |
| creator_name optional | 생성자 성, 이름 Example : Kim Samsung | string | - |
| user_email optional | User Email Example : samsung.kim@samsung.com | string | - |
| user_id required | User ID Example : f39c460fade34fecb05ede8f904b24b7 | string | |
| user_name optional | User 성, 이름 Example : Kim Samsung | string | - |
3.2.7 - EndpointsResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| region required | Region Example : kr-west1 | string | |
| service_name required | Service name Example : scp-iam | string | |
| service_type required | Service type Example : scp-iam | string | |
| url required | URL Example : https://iam.dev2.samsungsdscloud.com | string |
3.2.8 - Group
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | 생성 일시 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : ef50cdc207f05f6fb8f20219f229ed1f | string | |
| creator_email optional | 생성자 Email Example : samsung.kim@samsung.com | string | - |
| creator_name optional | 생성자 성, 이름 Example : Kim Samsung | string | - |
| description required | Group 설명 Example : Descriptions for group | any of [string, null] | |
| domain_name required | 도메인 이름 Example : scp | string | |
| id required | ID Example : f39c460fade34fecb05ede8f904b24b7 | string | |
| members optional | Project Group Member List | any of [array[GroupMember], null] | |
| modified_at required | 수정 일시 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : ef50cdc207f05f6fb8f20219f229ed1f | string | |
| modifier_email optional | 수정자 Email Example : samsung.kim@samsung.com | string | - |
| modifier_name optional | 수정자 성, 이름 Example : Kim Samsung | string | - |
| name required | Group 이름 Example : TestGroupPattern : ^[a-zA-Z0-9\-.,_+=@ㄱ-ㅎㅏ-ㅣ가-힣]*$Minimum length : 3Maximum length : 24 | string | |
| policies required | Policy | any of [array[Policy], null] | |
| resource_type optional | 리소스 명 Example : group | any of [string, null] | group |
| roles required | Role 정보 | any of [array[Role], null] | |
| service_name optional | 서비스 Display 명 Example : Identity Access Management | any of [string, null] | Identity Access Management |
| service_type optional | 서비스 명 Example : iam | any of [string, null] | iam |
| srn optional | Group SRN Example : srn:dev1:::::iam:group/0e0688b33641451a83d2ab8878666fda | any of [string, null] | |
| type required | Group Type Example : USER_DEFINED | string |
3.2.9 - GroupCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description required | Group 설명 Example : Descriptions for group | any of [string, null] | |
| name required | Group 이름 Example : TestGroupPattern : ^[a-zA-Z0-9\-.,_+=@ㄱ-ㅎㅏ-ㅣ가-힣]*$Minimum length : 3Maximum length : 24 | string | |
| policy_ids optional | Group Policy ID List Example : ['37f2e31ff86b415698d7e8eeafab445d'] | any of [array[string], null] | |
| tags optional | Group Tag Example : [{'key': 'company', 'value': 'SDS'}] | any of [array[object[string]], null] | |
| user_ids optional | Group Member User ID List Example : ['f39c460fade34fecb05ede8f904b24b7'] | any of [array[string], null] |
3.2.10 - GroupMember
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | 생성 일시 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : ef50cdc207f05f6fb8f20219f229ed1f | string | |
| creator_created_at required | 생성 일시 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| creator_email optional | 생성자 Email Example : samsung.kim@samsung.com | string | - |
| creator_last_login_at optional | Group Member last login at Example : 2024-05-17T00:23:17Z | any of [string (date-time), null] | |
| creator_name optional | 생성자 성, 이름 Example : Kim Samsung | string | - |
| group_names optional | Group names Example : ['TestGroup', 'SampleGroup'] | array[string] | |
| user_created_at required | 생성 일시 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| user_email optional | User Email Example : samsung.kim@samsung.com | string | - |
| user_id required | User ID Example : f39c460fade34fecb05ede8f904b24b7 | string | |
| user_last_login_at optional | Group Member last login at Example : 2024-05-17T00:23:17Z | any of [string (date-time), null] | |
| user_name optional | User 성, 이름 Example : Kim Samsung | string | - |
3.2.11 - GroupMemberCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| user_id required | Group Member User ID Example : f39c460fade34fecb05ede8f904b24b7 | string |
3.2.12 - GroupMemberCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| group_member required | CreatedGroupMember |
3.2.13 - GroupMemberPageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| group_members required | array[GroupMember] | ||
| page required | page Example : 0 | integer | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
3.2.14 - GroupPageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| groups required | array[Group] | ||
| page required | page Example : 0 | integer | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
3.2.15 - GroupPolicyBindingRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| policy_ids required | Policy ID List Example : ['37f2e31ff86b415698d7e8eeafab445d'] | array[string] |
3.2.16 - GroupPolicyPageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| policies required | array[Policy] | ||
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
3.2.17 - GroupPolicyResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| policies required | array[Policy] |
3.2.18 - GroupSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description required | Group 설명 Example : Descriptions for group | any of [string, null] | |
| name required | Group 이름 Example : TestGroupPattern : ^[a-zA-Z0-9\-.,_+=@ㄱ-ㅎㅏ-ㅣ가-힣]*$Minimum length : 3Maximum length : 24 | string |
3.2.19 - GroupShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| group required | Group |
3.2.20 - IAMCreateUserResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id optional | Account ID Example : | any of [string, null] | |
| company_name optional | 회사 이름 Example : | any of [string, null] | |
| console_url required | Console URL Example : | string | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| description optional | User Description Example : | any of [string, null] | |
| dst_offset optional | DST Offset Example : | any of [string, null] | |
| email optional | User Email Example : | any of [string, null] | |
| email_authenticated required | email 인증 여부 Example : | boolean | |
| first_name optional | 사용자 이름 Example : | any of [string, null] | |
| id required | ID Example : | string | |
| last_login_at optional | 마지막 로그인 Example : | any of [string (date-time), null] | |
| last_name optional | 사용자 성 Example : | any of [string, null] | |
| last_password_update_at optional | 마지막 비밀번호 수정시간 Example : | any of [string (date-time), null] | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name optional | Name Example : | any of [string, null] | |
| password required | 비밀 번호 Example : | string | |
| password_reuse_count required | 비밀 번호 재사용 가능 횟수 Example : | integer | |
| phone_authenticated required | 휴대폰 인증 여부 Example : | boolean | |
| policies required | User Policies | any of [array[Policy], null] | |
| state optional | 상태 Example : | any of [string, null] | |
| timezone optional | Timezone ID Example : | any of [string, null] | |
| type required | Type Example : | string | |
| tz_id optional | Timezone ID Example : | any of [string, null] | |
| user_name optional | User Name Example : | any of [string, null] | |
| utc_offset optional | UTC Offset Example : | any of [string, null] |
3.2.21 - IamPolicyDocument
| Name | Description | Schema | Default |
|---|---|---|---|
| Statement required | Statement | array[Statement] | |
| Version required | Policy Version Example : 2024-07-01 | string |
3.2.22 - IAMUserCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | description Example : | any of [string, null] | |
| group_ids optional | Group IDs Example : | any of [array[string], null] | |
| password required | 비밀 번호 Example : | string | |
| policy_ids optional | Policy IDs Example : | any of [array[string], null] | |
| tags optional | User Tag Example : | any of [array[object[string]], null] | |
| temporary_password required | temporary Example : | boolean | |
| user_name required | 사용자 이름 Example : Pattern : ^[a-zA-Z0-9\+\.\@\-\_]*$Maximum length : 64 | string |
3.2.23 - IAMUserDeleteRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| user_ids optional | 사용자 ID 목록 Example : | any of [array[string], null] |
3.2.24 - IAMUserDetailResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id optional | Account ID Example : | any of [string, null] | |
| company_name optional | 회사 이름 Example : | any of [string, null] | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| created_by_name optional | created_by_name Example : | any of [string, null] | |
| description optional | User Description Example : | any of [string, null] | |
| dst_offset optional | DST Offset Example : | any of [string, null] | |
| email optional | User Email Example : | any of [string, null] | |
| email_authenticated required | email 인증 여부 Example : | boolean | |
| first_name optional | 사용자 이름 Example : | any of [string, null] | |
| id required | ID Example : | string | |
| last_login_at optional | 마지막 로그인 Example : | any of [string (date-time), null] | |
| last_name optional | 사용자 성 Example : | any of [string, null] | |
| last_password_update_at optional | 마지막 비밀번호 수정시간 Example : | any of [string (date-time), null] | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| modified_by_name optional | modified_by_name Example : | any of [string, null] | |
| name optional | Name Example : | any of [string, null] | |
| password_reuse_count required | 비밀 번호 재사용 가능 횟수 Example : | integer | |
| phone_authenticated required | 휴대폰 인증 여부 Example : | boolean | |
| policies required | User Policies | any of [array[Policy], null] | |
| resource_type optional | service Example : User | any of [string, null] | User |
| service optional | 서비스 명 Example : iam | any of [string, null] | iam |
| service_name optional | 서비스 Display 명 Example : Identity Access Management | any of [string, null] | Identity Access Management |
| srn required | SRN Example : | any of [string, null] | |
| state optional | 상태 Example : | any of [string, null] | |
| timezone optional | Timezone ID Example : | any of [string, null] | |
| type required | Type Example : | string | |
| tz_id optional | Timezone ID Example : | any of [string, null] | |
| user_name optional | User Name Example : | any of [string, null] | |
| utc_offset optional | UTC Offset Example : | any of [string, null] |
3.2.25 - IAMUserPasswordUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| password required | 비밀 번호 Example : | string | |
| temporary_password optional | temporary Example : False | any of [boolean, null] |
3.2.26 - IAMUserResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id optional | Account ID Example : | any of [string, null] | |
| company_name optional | 회사 이름 Example : | any of [string, null] | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| description optional | User Description Example : | any of [string, null] | |
| dst_offset optional | DST Offset Example : | any of [string, null] | |
| email optional | User Email Example : | any of [string, null] | |
| email_authenticated required | email 인증 여부 Example : | boolean | |
| first_name optional | 사용자 이름 Example : | any of [string, null] | |
| groups optional | group names Example : | any of [array[string], null] | |
| id required | ID Example : | string | |
| last_login_at optional | 마지막 로그인 Example : | any of [string (date-time), null] | |
| last_name optional | 사용자 성 Example : | any of [string, null] | |
| last_password_update_at optional | 마지막 비밀번호 수정시간 Example : | any of [string (date-time), null] | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name optional | Name Example : | any of [string, null] | |
| password_reuse_count required | 비밀 번호 재사용 가능 횟수 Example : | integer | |
| phone_authenticated required | 휴대폰 인증 여부 Example : | boolean | |
| policies required | User Policies | any of [array[Policy], null] | |
| state optional | 상태 Example : | any of [string, null] | |
| timezone optional | Timezone ID Example : | any of [string, null] | |
| type required | Type Example : | string | |
| tz_id optional | Timezone ID Example : | any of [string, null] | |
| user_name optional | User Name Example : | any of [string, null] | |
| utc_offset optional | UTC Offset Example : | any of [string, null] |
3.2.27 - IAMUserUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | description Example : | any of [string, null] | |
| password_reuse_count required | 비밀 번호 재사용 가능 횟수 Example : Maximum : 24 | integer |
3.2.28 - ListAccessKeyRemoveRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| ids optional | Access key id list | array[string] | |
| limit optional | limit Example : 20 | any of [integer, null] | |
| marker optional | marker Example : 607e0938521643b5b4b266f343fae693 | any of [string, null] | |
| sort optional | sort Example : created_at:desc | any of [string, null] | |
| with_count optional | with count Example : true | any of [string, null] |
3.2.29 - ListAccessKeyResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| access_keys required | array[AccessKey] | ||
| count optional | 전체 개수 Example : 20 | any of [integer, null] | |
| links optional | links Example : [{'href': 'http://scp.samsungsdscloud.com/v1/access-keys?with_count=true&limit=20', 'rel': 'first'}, {'href': 'http://scp.samsungsdscloud.com/v1/access-keys?with_count=true&limit=20', 'rel': 'self'}] | any of [array[object], null] |
3.2.30 - ListEndpointsResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| endpoints required | array[EndpointsResponse] |
3.2.31 - ListIAMUserResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] | |
| users required | array[IAMUserResponse] |
3.2.32 - ListPolicyRemoveRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| ids optional | Policy id list Example : ['37f2e31ff86b415698d7e8eeafab445d'] | array[string] |
3.2.33 - ListSamlProviderRemoveRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| ids optional | Saml provider id list | array[string] |
3.2.34 - ListSamlProviderResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| saml_providers required | array[SamlProviderResponse] | ||
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
3.2.35 - Policy
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Project Id Example : e99c73a8690d4ae39ae75e38a26f2b99 | any of [string, null] | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| creator_email optional | 생성자 Email Example : samsung.kim@samsung.com | any of [string, null] | |
| creator_name optional | 생성자 성, 이름 Example : Kim Samsung | any of [string, null] | |
| default_version_id optional | Policy Default Version Id Example : c1b1fc611eb34eccbccfb563f77395ee | string | |
| description optional | Description Example : Descriptions for policy | any of [string, null] | |
| domain_name required | 도메인 이름 Example : scp | string | |
| id optional | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | string | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| modifier_email optional | 수정자 Email Example : samsung.kim@samsung.com | any of [string, null] | |
| modifier_name optional | 수정자 성, 이름 Example : Kim Samsung | any of [string, null] | |
| policy_category optional | Policy Category Example : IDENTITY_BASED | enum (IDENTITY_BASED, RESOURCE_BASED, SESSION) | |
| policy_name optional | Policy Name Example : PolicyNamePattern : ^[a-zA-Z0-9\-.,_+=@ㄱ-ㅎㅏ-ㅣ가-힣]*$Minimum length : 3Maximum length : 128 | string | |
| policy_type optional | Policy Type Example : USER_DEFINED | enum (SYSTEM_MANAGED, USER_DEFINED, INLINE) | |
| policy_versions optional | Policy Versions | array[PolicyVersion] | |
| resource_type optional | Resource Type Example : policy | any of [string, null] | policy |
| service_name optional | 서비스 Display 명 Example : Identity Access Management | any of [string, null] | Identity Access Management |
| service_type optional | Service Type Example : iam | any of [string, null] | iam |
| srn required | 삼성 리소스 자원명 Example : srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d | string | |
| state optional | Policy State Example : ACTIVE | enum (ACTIVE, INACTIVE, DELETED) | ACTIVE |
3.2.36 - PolicyBindingPageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| groups optional | Group Example : [{'created_at': '2025-03-26T10:18:04Z', 'created_by': '4a816a3f5099442ebb52daefc1f7be32', 'creator_email': '-', 'creator_name': '-', 'description': 'openapi-ga2-test-group', 'domain_name': 'scp', 'id': '19fca177a57940daa5817960373c6542', 'modified_at': '2025-03-26T10:18:04Z', 'modified_by': '4a816a3f5099442ebb52daefc1f7be32', 'modifier_email': '-', 'modifier_name': '-', 'name': 'openapi-ga2-testgroup5', 'policies': [], 'roles': [], 'srn': 'srn:dev2::1d9cc99917ff41bb992276ac0ae9e4c8:::iam:group/19fca177a57940daa5817960373c6542', 'type': 'USER_DEFINED'}] | any of [array[object], null] | |
| page required | page Example : 0 | integer | |
| policy_id optional | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | string | |
| roles optional | Role Example : [{'account_id': 'd7aba97100564b34a0f4f77c4bc7a303', 'assume_role_policy_document': {'Statement': [{'Action': '*', 'Condition': {'StringEquals': {'scp:RequestedRegion': ['kr-west1']}}, 'Effect': 'Allow', 'NotAction': '*', 'Principal': '*', 'Resource': '*', 'Sid': 'statement1'}], 'Version': '2024-07-01'}, 'created_at': '2024-05-17T00:23:17Z', 'created_by': 'ef50cdc207f05f6fb8f20219f229ed1f', 'creator_email': '-', 'creator_name': '-', 'description': 'string', 'id': 'f39c460fade34fecb05ede8f904b24b7', 'max_session_duration': 0, 'modified_at': '2024-05-17T00:23:17Z', 'modified_by': 'ef50cdc207f05f6fb8f20219f229ed1f', 'modifier_email': '-', 'modifier_name': '-', 'name': 'string', 'type': 'DEFAULT'}] | any of [array[object], null] | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] | |
| users optional | User Example : [{'access_control': False, 'account_id': 'd7aba97100564b34a0f4f77c4bc7a303', 'account_name': '', 'allowed_ip_addresses': '', 'company_name': '', 'created_at': '2024-11-15T06:57:42.000000Z', 'created_by': '90dddfc2b1e04edba54ba2b41539a9ac', 'description': '', 'domain_name': 'scp', 'dst_offset': '+09:00', 'email': 'samsung.kim@samsung.com', 'email_authenticate_code': '8ada8861bad2423295e4bb576bee5886', 'email_authenticated': True, 'first_name': '', 'groups': [], 'id': '90dddfc2b1e04edba54ba2b41539a9ac', 'keycloak_id': '127e3d8c-66dc-4b1b-b38b-9a1d0c6d5507', 'keystone_credential': '', 'last_login_at': '2024-11-25T06:57:42.000000Z', 'last_name': '', 'last_password_update_at': '', 'login_id': '', 'modified_at': '2024-11-17T06:57:42.000000Z', 'modified_by': '90dddfc2b1e04edba54ba2b41539a9ac', 'nation_id': '+82', 'phone_authenticated': False, 'phone_number': '0000000000', 'policies': [], 'state': 'ACTIVE', 'temporary_password': False, 'term_region_id': '1', 'timezone': 'Asia/Seoul', 'type': 'IAM', 'tz_id': 'Asia/Seoul', 'user_name': 'Kim Samsung', 'utc_offset': '+09:00'}] | any of [array[object], null] |
3.2.37 - PolicyBindingSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| add_ids optional | ID List Example : ['a946662dc4314dac93da413a32457459'] | any of [array[string], null] | |
| identity_type required | Identity Type Example : GROUP | string | |
| remove_ids optional | ID List Example : ['a946662dc4314dac93da413a32457459'] | any of [array[string], null] |
3.2.38 - PolicyCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| default_version_id optional | Default Version Id Example : c1b1fc611eb34eccbccfb563f77395ee | any of [string, null] | |
| description optional | Description Example : Descriptions for policy | any of [string, null] | |
| policy_category optional | Policy Category Example : IDENTITY_BASED | enum (IDENTITY_BASED, RESOURCE_BASED, SESSION) | IDENTITY_BASED |
| policy_name required | Policy Name Example : PolicyNamePattern : ^[a-zA-Z0-9\-.,_+=@ㄱ-ㅎㅏ-ㅣ가-힣]*$Minimum length : 3Maximum length : 128 | string | |
| policy_type optional | Policy Type Example : USER_DEFINED | enum (SYSTEM_MANAGED, USER_DEFINED, INLINE) | USER_DEFINED |
| policy_version required | Policy Version | PolicyVersionCreateRequest | |
| service_type optional | Service Type Example : scp-iam | any of [string, null] | |
| tags optional | Policy Tag Example : [{'key': 'foo', 'value': 'bar'}] | any of [array[object[string]], null] |
3.2.39 - PolicyDocument
| Name | Description | Schema | Default |
|---|---|---|---|
| Statement required | Statement | array[Statement] | |
| Version required | Policy Version Example : 2024-07-01 | string |
3.2.40 - PolicyPageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| policies required | array[Policy] | ||
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
3.2.41 - PolicyQueryRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| excluded_policy_ids optional | 제외할 Policy IDs Example : ['37f2e31ff86b415698d7e8eeafab445d'] | any of [array[string], null] |
3.2.42 - PolicySetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| default_version_id optional | Policy Default Version Id Example : c1b1fc611eb34eccbccfb563f77395ee | any of [string, null] | |
| description optional | Description Example : Descriptions for policy | any of [string, null] | |
| policy_name optional | Policy Name Example : Policy1Pattern : ^[a-zA-Z0-9\-.,_+=@ㄱ-ㅎㅏ-ㅣ가-힣]*$ | any of [string, null] | |
| policy_version optional | Policy Versions | any of [PolicyVersionCreateRequest, null] |
3.2.43 - PolicyShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Project Id Example : e99c73a8690d4ae39ae75e38a26f2b99 | any of [string, null] | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| creator_email optional | 생성자 Email Example : samsung.kim@samsung.com | any of [string, null] | |
| creator_name optional | 생성자 성, 이름 Example : Kim Samsung | any of [string, null] | |
| default_version_id optional | Policy Default Version Id Example : c1b1fc611eb34eccbccfb563f77395ee | string | |
| description optional | Description Example : Descriptions for policy | any of [string, null] | |
| domain_name required | 도메인 이름 Example : scp | string | |
| id optional | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | string | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| modifier_email optional | 수정자 Email Example : samsung.kim@samsung.com | any of [string, null] | |
| modifier_name optional | 수정자 성, 이름 Example : Kim Samsung | any of [string, null] | |
| policy_category optional | Policy Category Example : IDENTITY_BASED | enum (IDENTITY_BASED, RESOURCE_BASED, SESSION) | |
| policy_name optional | Policy Name Example : PolicyNamePattern : ^[a-zA-Z0-9\-.,_+=@ㄱ-ㅎㅏ-ㅣ가-힣]*$Minimum length : 3Maximum length : 128 | string | |
| policy_type optional | Policy Type Example : USER_DEFINED | enum (SYSTEM_MANAGED, USER_DEFINED, INLINE) | |
| policy_versions optional | Policy Versions | array[PolicyVersion] | |
| resource_type optional | Resource Type Example : policy | any of [string, null] | policy |
| service_name optional | 서비스 Display 명 Example : Identity Access Management | any of [string, null] | Identity Access Management |
| service_type optional | Service Type Example : iam | any of [string, null] | iam |
| srn required | 삼성 리소스 자원명 Example : srn:qa2:::::iam:policy/37f2e31ff86b415698d7e8eeafab445d | string | |
| state optional | Policy State Example : ACTIVE | enum (ACTIVE, INACTIVE, DELETED) | ACTIVE |
3.2.44 - PolicyVersion
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| id optional | Policy Version Id Example : c1b1fc611eb34eccbccfb563f77395ee | string | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| policy_document required | Policy Document | IamPolicyDocument | |
| policy_id optional | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | string | |
| policy_version_name optional | Policy Version Name Example : PolicyVersion-1 | string |
3.2.45 - PolicyVersionCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| policy_document required | Policy Document Example : {'Statement': [{'Action': ['iam:*'], 'Condition': {'StringEquals': {'scp:RequestedRegion': ['kr-west1']}}, 'Effect': 'Allow', 'Principal': None, 'Resource': ['*'], 'Sid': 'Statement1'}], 'Version': '2024-07-01'} | IamPolicyDocument | |
| policy_id optional | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | string | |
| policy_version_id optional | Policy Version Id Example : c1b1fc611eb34eccbccfb563f77395ee | string | |
| policy_version_name optional | Policy Version Name Example : PolicyVersion-1 | string | POLICY_VERSION_1 |
3.2.46 - ResourcePolicySetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| policy_version required | Description | ResourcePolicyVersionCreateRequest |
3.2.47 - ResourcePolicyShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Project Id Example : e99c73a8690d4ae39ae75e38a26f2b99 | any of [string, null] | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| creator_email optional | 생성자 Email Example : samsung.kim@samsung.com | any of [string, null] | |
| creator_name optional | 생성자 성, 이름 Example : Kim Samsung | any of [string, null] | |
| default_version_id optional | Policy Default Version Id Example : f39c460fade34fecb05ede8f904b24b7 | string | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| modifier_email optional | 수정자 Email Example : samsung.kim@samsung.com | any of [string, null] | |
| modifier_name optional | 수정자 성, 이름 Example : Kim Samsung | any of [string, null] | |
| policy_category optional | Policy Category Example : RESOURCE_BASED | enum (IDENTITY_BASED, RESOURCE_BASED, SESSION) | |
| policy_type optional | Policy Type Example : USER_DEFINED | enum (SYSTEM_MANAGED, USER_DEFINED, INLINE) | |
| policy_versions optional | Policy Versions | array[ResourcePolicyVersion] | |
| service_name optional | 서비스 Display 명 Example : Identity Access Management | any of [string, null] | Identity Access Management |
3.2.48 - ResourcePolicyVersion
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| id optional | Policy Version Id Example : c1b1fc611eb34eccbccfb563f77395ee | string | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| policy_document required | Policy Document Example : {'Statement': [{'Action': ['virtualserver:ShowVirtualServer'], 'Condition': {'StringEquals': {'scp:RequestedRegion': ['kr-west1']}}, 'Effect': 'Allow', 'Principal': '*', 'Resource': ['srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666'], 'Sid': 'Statement1'}], 'Version': '2024-07-01'} | IamPolicyDocument |
3.2.49 - ResourcePolicyVersionCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| policy_document required | Policy Document Example : {'Statement': [{'Action': ['virtualserver:ShowVirtualServer'], 'Condition': {'StringEquals': {'scp:RequestedRegion': ['kr-west1']}}, 'Effect': 'Allow', 'Principal': '*', 'Resource': ['srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666'], 'Sid': 'Statement1'}], 'Version': '2024-07-01'} | IamPolicyDocument | |
| policy_id optional | Policy ID Example : 37f2e31ff86b415698d7e8eeafab445d | any of [string, null] | |
| policy_version_id optional | Policy Version Id Example : c1b1fc611eb34eccbccfb563f77395ee | any of [string, null] | |
| policy_version_name optional | Policy Version Name Example : PolicyVersion-1 | string | POLICY_VERSION_1 |
3.2.50 - Role
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id optional | 역할이 속한 계정의 ID Example : | any of [string, null] | |
| assume_role_policy_document required | 역할 신뢰 정책 | PolicyDocument | |
| created_at required | 생성 일시 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : ef50cdc207f05f6fb8f20219f229ed1f | string | |
| creator_email optional | 생성자 Email Example : | any of [string, null] | |
| creator_name optional | 생성자 성, 이름 Example : | any of [string, null] | |
| description required | 역할 설명 Example : | any of [string, null] | |
| id required | ID Example : f39c460fade34fecb05ede8f904b24b7 | string | |
| max_session_duration required | 역할 세션 최대 지속 시간(초) Example : | integer | |
| modified_at required | 수정 일시 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : ef50cdc207f05f6fb8f20219f229ed1f | string | |
| modifier_email optional | 수정자 Email Example : | any of [string, null] | |
| modifier_name optional | 수정자 성, 이름 Example : | any of [string, null] | |
| name required | 역할명 Example : | string | |
| policies required | 역할에 연결된 정책 목록 | any of [array[Policy], null] | |
| type optional | 역할 유형 Example : USER_DEFINED | enum (USER_DEFINED, SERVICE, SERVICE_LINKED) | USER_DEFINED |
3.2.51 - RoleBulkDeleteRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id optional | 역할이 속한 계정의 ID Example : | any of [string, null] | |
| role_ids optional | 역할 ID 목록 Example : | any of [array[string], null] | |
| role_names optional | 역할명 목록 Example : | any of [array[string], null] |
3.2.52 - RoleCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id optional | 역할이 속한 계정의 ID Example : | any of [string, null] | |
| assume_role_policy_document optional | 역할 신뢰 정책 Example : {'Statement': [{'Action': ['sts:AssumeRole'], 'Condition': {}, 'Effect': 'Allow', 'Principal': 'srn:e:1234:::iam:user/abc1234', 'Resource': [], 'Sid': 'statement1'}], 'Version': '2024-07-01'} | any of [PolicyDocument, null] | |
| description optional | 역할 설명 Example : | any of [string, null] | |
| max_session_duration optional | 역할 세션 최대 지속 시간(초) Example : 3600Minimum : 3600Maximum : 43200 | integer | 3600 |
| name required | 역할명 Example : Pattern : ^[a-zA-Z0-9\+\=\,\.\@\-\_]*$Maximum length : 64 | string | |
| policy_ids required | 역할에 연결할 정책 ID 목록 Example : ['37f2e31ff86b415698d7e8eeafab445d'] | array[string] | |
| principals optional | 신뢰 정책 수행 주체 목록 Example : [{'type': 'SRN', 'value': 'srn:e:1234:::iam:user/abc1234'}] | any of [array[RoleTrustPolicyPrincipal], null] | |
| tags optional | 역할 태그 Example : [{'key': 'company', 'value': 'SDS'}] | any of [array[object[string]], null] |
3.2.53 - RolePageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| roles required | array[Role] | ||
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
3.2.54 - RolePolicyBindingPageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| policies required | array[Policy] | ||
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
3.2.55 - RolePolicyBindingRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| policy_ids required | Policy ID List | array[string] |
3.2.56 - RolePolicyBindingResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| policies required | array[Policy] |
3.2.57 - RoleSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | 역할 설명 Example : | any of [string, null] | |
| max_session_duration optional | 역할 세션 최대 지속 시간(초) Example : 3600 | any of [integer, null] |
3.2.58 - RoleShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| role required | Role |
3.2.59 - RoleTrustPolicyPrincipal
| Name | Description | Schema | Default |
|---|---|---|---|
| type required | 신뢰 정책 수행 주체 유형 Example : | string | |
| value required | 신뢰 정책 수행 주체 Example : | string |
3.2.60 - RoleTrustPolicyRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| assume_role_policy_document required | 역할 신뢰 정책 Example : {'Statement': [{'Action': ['sts:AssumeRole'], 'Condition': {}, 'Effect': 'Allow', 'Principal': 'srn:e:1234:::iam:user/abc1234', 'Resource': [], 'Sid': 'statement1'}], 'Version': '2024-07-01'} | PolicyDocument |
3.2.61 - RoleTrustPolicyShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| assume_role_policy_document required | PolicyDocument | ||
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string |
3.2.62 - SamlProviderCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | 자격증명공급자 설명 Example : SAML provider Description | any of [string, null] | |
| federation_type required | 자격증명공급자 유형 Example : SAML | string | |
| file optional | 메타데이터 파일 Example : keycloak-idp-saml.xml | string (binary) | |
| saml_provider_name required | 자격증명공급자 이름 Example : IdpTest | string | |
| tags optional | 태그 Example : [{'key': 'company', 'value': 'SDS'}] | any of [array[object[string]], null] |
3.2.63 - SamlProviderCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : | string | |
| acs_url optional | ACS URL Example : | any of [string, null] | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| creator_name optional | 생성자 Example : | any of [string, null] | |
| description optional | 자격증명공급자 설명 Example : | any of [string, null] | |
| federation_type optional | 자격증명공급자 유형 Example : | any of [string, null] | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| idp_cert_end optional | 유효기간 Example : | any of [string (date-time), null] | |
| idp_file_name optional | 메타데이터 파일 이름 Example : | any of [string, null] | |
| idp_file_size optional | 메타데이터 파일 크기 Example : | any of [integer, null] | |
| idp_issuer_url optional | 발행자 URL Example : | any of [string, null] | |
| idp_sso_url optional | SSO 서비스 위치 Example : | any of [string, null] | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| modifier_name optional | 수정자 Example : | any of [string, null] | |
| saml_provider_name optional | 자격증명공급자 이름 Example : | any of [string, null] |
3.2.64 - SamlProviderDetailResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : | string | |
| acs_url optional | ACS URL Example : | any of [string, null] | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| creator_name optional | 생성자 Example : | any of [string, null] | |
| description optional | 자격증명공급자 설명 Example : | any of [string, null] | |
| federation_type optional | 자격증명공급자 유형 Example : | any of [string, null] | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| idp_cert_end optional | 유효기간 Example : | any of [string (date-time), null] | |
| idp_file_data optional | 메타데이터 내용 Example : | any of [string, null] | |
| idp_file_name optional | 메타데이터 파일 이름 Example : | any of [string, null] | |
| idp_file_size optional | 메타데이터 파일 크기 Example : | any of [integer, null] | |
| idp_issuer_url optional | 발행자 URL Example : | any of [string, null] | |
| idp_sso_url optional | SSO 서비스 위치 Example : | any of [string, null] | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| modifier_name optional | 수정자 Example : | any of [string, null] | |
| saml_provider_name optional | 자격증명공급자 이름 Example : | any of [string, null] |
3.2.65 - SamlProviderResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : | string | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| creator_name optional | 생성자 Example : | any of [string, null] | |
| description optional | 자격증명공급자 설명 Example : | any of [string, null] | |
| federation_type optional | 자격증명공급자 유형 Example : | any of [string, null] | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| modifier_name optional | 수정자 Example : | any of [string, null] | |
| saml_provider_name optional | 자격증명공급자 이름 Example : | any of [string, null] |
3.2.66 - SamlProviderUpdateRequestData
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | 자격증명공급자 설명 Example : SAML provider Description | string | |
| file optional | 메타데이터 파일 Example : keycloak-idp-saml.xml | string (binary) | |
| saml_provider_name optional | 자격증명공급자 이름 Example : IdpTest | any of [string, null] | |
| tags optional | 태그 Example : [{'key': 'company', 'value': 'SDS'}] | any of [array[object[string]], null] |
3.2.67 - ServiceAccount
| Name | Description | Schema | Default |
|---|---|---|---|
| id required | Service Account ID Example : | string | |
| name required | Service Account Name Example : | string | |
| service required | Service Account’s Service Example : | string |
3.2.68 - ServiceAccountDetail
| Name | Description | Schema | Default |
|---|---|---|---|
| id required | Service Account ID Example : | string | |
| name required | Service Account Name Example : | string | |
| password required | Service Account’s Password Example : | string | |
| service required | Service Account’s Service Example : | string |
3.2.69 - ServiceAccountListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| service_accounts required | array[ServiceAccount] |
3.2.70 - ServiceAccountShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| service_account required | ServiceAccountDetail |
3.2.71 - Statement
| Name | Description | Schema | Default |
|---|---|---|---|
| Action optional | Action Example : ['iam:*'] | any of [array[string], null] | |
| Condition optional | Condition Example : {'StringEquals': {'scp:RequestedRegion': ['kr-west1']}} | any of [object[object[array[object]]], null] | |
| Effect required | Effect Example : Allow | string | |
| NotAction optional | NotAction Example : | any of [array[string], null] | |
| Principal optional | Principal Example : | any of [string, object[array[string]], null] | |
| Resource optional | Resource Example : ['*'] | array[string] | |
| Sid optional | Statement Id Example : Statement1 | string | statement1 |
3.2.72 - StatementCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| Action optional | Action Example : ['virtualserver:ShowVirtualServer'] | any of [array[string], null] | |
| Condition optional | Condition Example : {'StringEquals': {'scp:RequestedRegion': ['kr-west1']}} | any of [object[object[array[object]]], null] | |
| Effect required | Effect Example : Allow | string | |
| NotAction optional | NotAction Example : | any of [array[string], null] | |
| Principal optional | Principal Example : * | any of [string, object[array[string]], null] | |
| Resource optional | Resource Example : ['srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666'] | array[string] | |
| Sid optional | Statement Id Example : Statement1 | string | statement1 |
3.2.73 - StatementResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| Statement required | Statement Example : {'Action': ['virtualserver:ShowVirtualServer'], 'Condition': {'StringEquals': {'scp:RequestedRegion': ['kr-west1']}}, 'Effect': 'Allow', 'Principal': '*', 'Resource': ['srn:dev2::1234567890102345690:kr-west1::virtualserver:virtual-server/abcde-1234-5555-6666'], 'Sid': 'Statement1'} | Statement |
3.2.74 - UserPolicyPageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| policies required | User policy | array[Policy] | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] | |
| user_id required | 사용자 ID Example : | string |
3.2.75 - UserPolicyRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| policy_ids optional | User Policy Bindings | array[string] |
3.2.76 - UserPolicyResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| policies required | User policy | array[Policy] | |
| user_id required | 사용자 ID Example : | string |
3.2.77 - UserResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id optional | Account ID Example : | any of [string, null] | |
| company_name optional | 회사 이름 Example : | any of [string, null] | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| description optional | User Description Example : | any of [string, null] | |
| dst_offset optional | DST Offset Example : | any of [string, null] | |
| email optional | User Email Example : | any of [string, null] | |
| email_authenticated required | email 인증 여부 Example : | boolean | |
| first_name optional | 사용자 이름 Example : | any of [string, null] | |
| id required | ID Example : | string | |
| last_login_at optional | 마지막 로그인 Example : | any of [string (date-time), null] | |
| last_name optional | 사용자 성 Example : | any of [string, null] | |
| last_password_update_at optional | 마지막 비밀번호 수정시간 Example : | any of [string (date-time), null] | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name optional | Name Example : | any of [string, null] | |
| password_reuse_count required | 비밀 번호 재사용 가능 횟수 Example : | integer | |
| phone_authenticated required | 휴대폰 인증 여부 Example : | boolean | |
| policies required | User Policies | any of [array[Policy], null] | |
| state optional | 상태 Example : | any of [string, null] | |
| timezone optional | Timezone ID Example : | any of [string, null] | |
| type required | Type Example : | string | |
| tz_id optional | Timezone ID Example : | any of [string, null] | |
| user_name optional | User Name Example : | any of [string, null] | |
| utc_offset optional | UTC Offset Example : | any of [string, null] |
4 - ID Center
Overview
ID Center는 고객이 운영하는 자격 증명 공급자와 연계하여 Samsung Cloud Platform 의 Account 별 자원에 대한 접근 권한을 중앙에서 손쉽게 관리할 수 있는 서비스입니다. 본 가이드는 IAM 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | DEPRECATED | 20260223 |
| 1.1 | SUPPORTED | 20260531 |
| 1.2 | CURRENT | - |
OpenAPI URL
https://iam-identity-center.{region}.{environment}.samsungsdscloud.com
Environment and Region List
| environment | region |
|---|---|
| s | kr-west1 |
| s | kr-east1 |
| g | kr-south1 |
| g | kr-south2 |
| g | kr-south3 |
| e | kr-west1 |
| e | kr-east1 |
4.1 - APIs
4.1.1 - CreateAccountAssignment
4.1.1.1 - 1.2
post /v1/account-assignments
Description
set a specific account Assignment
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | AccountAssignmentsCreateRequestV1Dot2 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | AccountAssignmentsCreateResponseV1Dot2 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/account-assignments
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.2"
Request body
{
"accounts": [
{
"target_account_email": "target_account@example.com",
"target_account_id": "3265ab469f0d406d83073da3e11e7a6c",
"target_account_name": "target_account@example.com"
}
],
"instance_id": "ssoins-12345",
"permission_sets": [
{
"custom_policies": [],
"inline_policies": [],
"managed_policies": [],
"permission_set_id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
"permission_set_name": "Permission Set",
"permission_set_srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
"session_duration": 3600
}
],
"principals": [
{
"principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"principal_type": "USER"
}
]
}
Example HTTP response
Response 201
{
"account_assignments": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"permission_set_id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
"principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"principal_type": "USER",
"target_account_id": "3265ab469f0d406d83073da3e11e7a6c"
}
],
"count": 20,
"links": [
{
"href": "http://scp.samsungsdscloud.com/v1/notices",
"rel": "self"
}
]
}
4.1.1.2 - 1.1
post /v1/account-assignments
Description
set a specific account Assignment
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | AccountAssignmentsCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | AccountAssignmentsCreateResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/account-assignments
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.1"
Request body
{
"accounts": [
{
"target_account_email": "target_account@example.com",
"target_account_id": "3265ab469f0d406d83073da3e11e7a6c",
"target_account_name": "target_account@example.com"
}
],
"instance_id": "ssoins-12345",
"permission_sets": [
{
"customer_policies": [],
"inline_policies": [],
"managed_policies": [],
"permission_set_id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
"permission_set_name": "Permission Set",
"permission_set_srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
"session_duration": 3600
}
],
"principals": [
{
"principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"principal_type": "USER"
}
]
}
Example HTTP response
Response 201
{
"account_assignment_id": "b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8",
"permission_set_id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
"principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"principal_type": "USER",
"role_srn": "Permissions for administrators",
"target_account_id": "3265ab469f0d406d83073da3e11e7a6c"
}
4.1.1.3 - 1.0
post /v1/account-assignments
Description
set a specific account Assignment
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | AccountAssignmentsCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | AccountAssignmentsCreateResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/account-assignments
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.0"
Request body
{
"accounts": [
{
"target_account_email": "target_account@example.com",
"target_account_id": "3265ab469f0d406d83073da3e11e7a6c",
"target_account_name": "target_account@example.com"
}
],
"instance_id": "ssoins-12345",
"permission_sets": [
{
"customer_policies": [],
"inline_policies": [],
"managed_policies": [],
"permission_set_id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
"permission_set_name": "Permission Set",
"permission_set_srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
"session_duration": 3600
}
],
"principals": [
{
"principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"principal_type": "USER"
}
]
}
Example HTTP response
Response 201
{
"account_assignment_id": "b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8",
"permission_set_id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
"principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"principal_type": "USER",
"role_srn": "Permissions for administrators",
"target_account_id": "3265ab469f0d406d83073da3e11e7a6c"
}
4.1.2 - CreateBulkGroupUsers
4.1.2.1 - 1.2
post /v1/groups/{group_id}/users
Description
add multiple users to a specific group
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | 그룹 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
| body | body required | GroupUsersRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}/users
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.2"
Request body
{
"instance_id": "ssoins-12345",
"user_uuids": [
"user-12345",
"user-67890"
]
}
Example HTTP response
Response 200
{
"group": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "John Doe",
"description": "Group for administrators",
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"instance_id": "ssoins-12345",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "Smith",
"name": "Admin_Group",
"user_count": 1,
"users": [
{
"id": "6fdd2a6d-6f4f-4157-8259-5d55e7dd1269",
"name": "John Doe",
"user_id": "johndoe"
}
]
}
}
4.1.2.2 - 1.1
post /v1/groups/{group_id}/users
Description
add multiple users to a specific group
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | 그룹 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
| body | body required | GroupUsersRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}/users
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.1"
Request body
{
"instance_id": "ssoins-12345",
"user_uuids": [
"user-12345",
"user-67890"
]
}
Example HTTP response
Response 200
{
"group": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "John Doe",
"description": "Group for administrators",
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"instance_id": "ssoins-12345",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "Smith",
"name": "Admin_Group",
"user_count": 1,
"users": [
{
"id": "6fdd2a6d-6f4f-4157-8259-5d55e7dd1269",
"name": "John Doe",
"user_id": "johndoe"
}
]
}
}
4.1.2.3 - 1.0
post /v1/groups/{group_id}/users
Description
add multiple users to a specific group
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | 그룹 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
| body | body required | GroupUsersRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}/users
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.0"
Request body
{
"instance_id": "ssoins-12345",
"user_uuids": [
"user-12345",
"user-67890"
]
}
Example HTTP response
Response 200
{
"group": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "John Doe",
"description": "Group for administrators",
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"instance_id": "ssoins-12345",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "Smith",
"name": "Admin_Group",
"user_count": 1,
"users": [
{
"id": "6fdd2a6d-6f4f-4157-8259-5d55e7dd1269",
"name": "John Doe",
"user_id": "johndoe"
}
]
}
}
4.1.3 - CreateGroup
4.1.3.1 - 1.2
post /v1/groups
Description
create a group
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | GroupCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | GroupShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.2"
Request body
{
"description": "Group for administrators",
"instance_id": "ssoins-12345",
"name": "Admin_Group",
"user_uuids": [
"138c2fc8c29a449dbfa8681f8f1d78e2"
]
}
Example HTTP response
Response 201
{
"group": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "John Doe",
"description": "Group for administrators",
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"instance_id": "ssoins-12345",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "Smith",
"name": "Admin_Group",
"user_count": 1,
"users": [
{
"id": "6fdd2a6d-6f4f-4157-8259-5d55e7dd1269",
"name": "John Doe",
"user_id": "johndoe"
}
]
}
}
4.1.3.2 - 1.1
post /v1/groups
Description
create a group
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | GroupCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | GroupShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.1"
Request body
{
"description": "Group for administrators",
"instance_id": "ssoins-12345",
"name": "Admin_Group",
"user_uuids": [
"138c2fc8c29a449dbfa8681f8f1d78e2"
]
}
Example HTTP response
Response 201
{
"group": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "John Doe",
"description": "Group for administrators",
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"instance_id": "ssoins-12345",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "Smith",
"name": "Admin_Group",
"user_count": 1,
"users": [
{
"id": "6fdd2a6d-6f4f-4157-8259-5d55e7dd1269",
"name": "John Doe",
"user_id": "johndoe"
}
]
}
}
4.1.3.3 - 1.0
post /v1/groups
Description
create a group
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | GroupCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | GroupShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.0"
Request body
{
"description": "Group for administrators",
"instance_id": "ssoins-12345",
"name": "Admin_Group",
"user_uuids": [
"138c2fc8c29a449dbfa8681f8f1d78e2"
]
}
Example HTTP response
Response 201
{
"group": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "John Doe",
"description": "Group for administrators",
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"instance_id": "ssoins-12345",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "Smith",
"name": "Admin_Group",
"user_count": 1,
"users": [
{
"id": "6fdd2a6d-6f4f-4157-8259-5d55e7dd1269",
"name": "John Doe",
"user_id": "johndoe"
}
]
}
}
4.1.4 - CreateInstance
4.1.4.1 - 1.2
post /v1/instances
Description
create a instance
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | InstanceCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | InstanceShowResponseV1Dot1 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/instances
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.2"
Request body
{
"description": "My Instance Description",
"identity_store_config": {
"bind_credential": "password",
"bind_dn": "CN=Administrator,CN=Users,DC=test,DC=add",
"connection_url": "ldaps://test.subdomain.company.com:123",
"rdn_ldap_attribute": "cn",
"user_object_classes": "person, organizationalPerson, user",
"username_ldap_attribute": "sAMAccountName",
"users_dn": "OU=Employees,OU=Accounts,DC=sub,DC=org"
},
"identity_store_type": "ACTIVE_DIRECTORY",
"name": "My Instance"
}
Example HTTP response
Response 201
{
"instance": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"delegated_account_id": "acc-2353",
"delegated_at": "2023-10-15 14:30:00",
"delegated_by": "sef2w3c8c29a449dbfa8681f8f1d78e2",
"description": "My Instance Description",
"id": "ssoins-12345",
"identity_store_config": {
"bind_credential": "password",
"bind_dn": "CN=Administrator,CN=Users,DC=test,DC=add",
"component_id": "HYIK7LLKQL2MFK2K8Jb1ew",
"connection_url": "ldaps://test.subdomain.company.com:123",
"rdn_ldap_attribute": "cn",
"user_object_classes": "person, organizationalPerson, user",
"username_ldap_attribute": "sAMAccountName",
"users_dn": "OU=Employees,OU=Accounts,DC=sub,DC=org"
},
"identity_store_id": "d-12345",
"identity_store_type": "ACTIVE_DIRECTORY",
"last_sync_at": "2025-08-06 10:30:00",
"last_sync_status": [
"CREATED",
"RUNNING",
"FINISHED",
"FAILED",
"NONE"
],
"master_account_id": "acc-12345",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "My Instance",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"region": "kr-west1",
"srn": "srn:identity-center::prj-01234:kr-west-1::instance/ins-01234",
"sso_start_url": "https://login.e.samsungsdscloud.com/d-12345",
"state": "ACTIVE"
}
}
4.1.4.2 - 1.1
post /v1/instances
Description
create a instance
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | InstanceCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | InstanceShowResponseV1Dot1 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/instances
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.1"
Request body
{
"description": "My Instance Description",
"identity_store_config": {
"bind_credential": "password",
"bind_dn": "CN=Administrator,CN=Users,DC=test,DC=add",
"connection_url": "ldaps://test.subdomain.company.com:123",
"rdn_ldap_attribute": "cn",
"user_object_classes": "person, organizationalPerson, user",
"username_ldap_attribute": "sAMAccountName",
"users_dn": "OU=Employees,OU=Accounts,DC=sub,DC=org"
},
"identity_store_type": "ACTIVE_DIRECTORY",
"name": "My Instance"
}
Example HTTP response
Response 201
{
"instance": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"delegated_account_id": "acc-2353",
"delegated_at": "2023-10-15 14:30:00",
"delegated_by": "sef2w3c8c29a449dbfa8681f8f1d78e2",
"description": "My Instance Description",
"id": "ssoins-12345",
"identity_store_config": {
"bind_credential": "password",
"bind_dn": "CN=Administrator,CN=Users,DC=test,DC=add",
"component_id": "HYIK7LLKQL2MFK2K8Jb1ew",
"connection_url": "ldaps://test.subdomain.company.com:123",
"rdn_ldap_attribute": "cn",
"user_object_classes": "person, organizationalPerson, user",
"username_ldap_attribute": "sAMAccountName",
"users_dn": "OU=Employees,OU=Accounts,DC=sub,DC=org"
},
"identity_store_id": "d-12345",
"identity_store_type": "ACTIVE_DIRECTORY",
"last_sync_at": "2025-08-06 10:30:00",
"last_sync_status": [
"CREATED",
"RUNNING",
"FINISHED",
"FAILED",
"NONE"
],
"master_account_id": "acc-12345",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "My Instance",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"region": "kr-west1",
"srn": "srn:identity-center::prj-01234:kr-west-1::instance/ins-01234",
"sso_start_url": "https://login.e.samsungsdscloud.com/d-12345",
"state": "ACTIVE"
}
}
4.1.5 - CreatePermissionSet
4.1.5.1 - 1.2
post /v1/permission-sets
Description
create a permission set
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | PermissionSetCreateRequestV1Dot2 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | PermissionSetDetailsV1Dot2 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/permission-sets
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.2"
Request body
{
"custom_policies": [],
"description": "My Instance Description",
"inline_policies": [],
"instance_id": "ssoins-12345",
"managed_policies": [],
"name": "My Instance",
"session_duration": 3600
}
Example HTTP response
Response 201
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "",
"custom_policies": [
""
],
"description": "Permissions for administrators",
"id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
"inline_policies": [
""
],
"instance_id": "ssoins-12345",
"managed_policies": [
""
],
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "",
"name": "Permission Set",
"session_duration": 3600,
"srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
"state": "ACTIVE"
}
4.1.5.2 - 1.1
post /v1/permission-sets
Description
create a permission set
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | PermissionSetCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | PermissionSetDetails |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/permission-sets
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.1"
Request body
{
"customer_policies": [],
"description": "My Instance Description",
"inline_policies": [],
"instance_id": "ssoins-12345",
"managed_policies": [],
"name": "My Instance",
"session_duration": 3600
}
Example HTTP response
Response 201
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "",
"customer_policies": [
""
],
"description": "Permissions for administrators",
"id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
"inline_policies": [
""
],
"instance_id": "ssoins-12345",
"managed_policies": [
""
],
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "",
"name": "Permission Set",
"session_duration": 3600,
"srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
"state": "ACTIVE"
}
4.1.5.3 - 1.0
post /v1/permission-sets
Description
create a permission set
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | PermissionSetCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | PermissionSetDetails |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/permission-sets
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.0"
Request body
{
"customer_policies": [],
"description": "My Instance Description",
"inline_policies": [],
"instance_id": "ssoins-12345",
"managed_policies": [],
"name": "My Instance",
"session_duration": 3600
}
Example HTTP response
Response 201
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "",
"customer_policies": [
""
],
"description": "Permissions for administrators",
"id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
"inline_policies": [
""
],
"instance_id": "ssoins-12345",
"managed_policies": [
""
],
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "",
"name": "Permission Set",
"session_duration": 3600,
"srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
"state": "ACTIVE"
}
4.1.6 - CreateUser
4.1.6.1 - 1.2
post /v1/users
Description
create a user
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | UserCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | UserResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/users
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.2"
Request body
{
"business_unit": "Business Unit A",
"department": "Department X",
"description": "Description of John Doe",
"email": "john.doe@example.com",
"employee_id": "emp-12345",
"group_ids": [
"39520424-440c-41c0-9b9c-f22b2129f6f9",
"80c53fe1-4e27-4cce-92be-151cf0f2873e"
],
"instance_id": "ssoins-12345",
"manager": "Alice Smith",
"name": "John Doe",
"nation_id": "+82",
"password": "",
"phone_number": "010-1234-5678",
"temporary_password": true,
"user_id": "johndoe"
}
Example HTTP response
Response 201
{
"user": {
"business_unit": "Business Unit A",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "John Doe",
"department": "Department X",
"description": "Description of John Doe",
"email": "john.doe@example.com",
"email_authenticated": false,
"employee_id": "emp-12345",
"groups": [],
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"instance_id": "ssoins-12345",
"last_login_at": "2024-12-19 01:09:05.000",
"last_password_update_at": "2025-11-24T08:14:51.694996",
"manager": "Alice Smith",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "Smith",
"name": "John Doe",
"nation_id": "+82",
"password": "",
"password_failed_count": 6,
"password_reuse_count": 6,
"phone_authenticated": false,
"phone_number": "010-1234-5678",
"temporary_password": "",
"tz_id": "Asia/Seoul",
"user_id": "johndoe"
}
}
4.1.6.2 - 1.1
post /v1/users
Description
create a user
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | UserCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | UserResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/users
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.1"
Request body
{
"business_unit": "Business Unit A",
"department": "Department X",
"description": "Description of John Doe",
"email": "john.doe@example.com",
"employee_id": "emp-12345",
"group_ids": [
"39520424-440c-41c0-9b9c-f22b2129f6f9",
"80c53fe1-4e27-4cce-92be-151cf0f2873e"
],
"instance_id": "ssoins-12345",
"manager": "Alice Smith",
"name": "John Doe",
"nation_id": "+82",
"password": "",
"phone_number": "010-1234-5678",
"temporary_password": true,
"user_id": "johndoe"
}
Example HTTP response
Response 201
{
"user": {
"business_unit": "Business Unit A",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "John Doe",
"department": "Department X",
"description": "Description of John Doe",
"email": "john.doe@example.com",
"email_authenticated": false,
"employee_id": "emp-12345",
"groups": [],
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"instance_id": "ssoins-12345",
"last_login_at": "2024-12-19 01:09:05.000",
"last_password_update_at": "2025-11-24T08:14:51.694996",
"manager": "Alice Smith",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "Smith",
"name": "John Doe",
"nation_id": "+82",
"password": "",
"password_failed_count": 6,
"password_reuse_count": 6,
"phone_authenticated": false,
"phone_number": "010-1234-5678",
"temporary_password": "",
"tz_id": "Asia/Seoul",
"user_id": "johndoe"
}
}
4.1.6.3 - 1.0
post /v1/users
Description
create a user
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | UserCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | UserResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/users
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.0"
Request body
{
"business_unit": "Business Unit A",
"department": "Department X",
"description": "Description of John Doe",
"email": "john.doe@example.com",
"employee_id": "emp-12345",
"group_ids": [
"39520424-440c-41c0-9b9c-f22b2129f6f9",
"80c53fe1-4e27-4cce-92be-151cf0f2873e"
],
"instance_id": "ssoins-12345",
"manager": "Alice Smith",
"name": "John Doe",
"nation_id": "+82",
"password": "",
"phone_number": "010-1234-5678",
"temporary_password": true,
"user_id": "johndoe"
}
Example HTTP response
Response 201
{
"user": {
"business_unit": "Business Unit A",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "John Doe",
"department": "Department X",
"description": "Description of John Doe",
"email": "john.doe@example.com",
"email_authenticated": false,
"employee_id": "emp-12345",
"groups": [],
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"instance_id": "ssoins-12345",
"last_login_at": "2024-12-19 01:09:05.000",
"last_password_update_at": "2025-11-24T08:14:51.694996",
"manager": "Alice Smith",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "Smith",
"name": "John Doe",
"nation_id": "+82",
"password": "",
"password_failed_count": 6,
"password_reuse_count": 6,
"phone_authenticated": false,
"phone_number": "010-1234-5678",
"temporary_password": "",
"tz_id": "Asia/Seoul",
"user_id": "johndoe"
}
}
4.1.7 - DeleteAccountAssignment
4.1.7.1 - 1.2
delete /v1/account-assignments/{account_assignment_id}
Description
delete a specific account Assignment
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | account_assignment_id required | 할당 ID Example : b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8 | string | None |
| body | body required | AccountAssignmentDeleteRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/account-assignments/{account_assignment_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.2"
Request body
{
"instance_id": "ssoins-12345",
"only_user_removed": false,
"target_account_id": "3265ab469f0d406d83073da3e11e7a6c"
}
Example HTTP response
Response 204
4.1.7.2 - 1.1
delete /v1/account-assignments/{account_assignment_id}
Description
delete a specific account Assignment
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | account_assignment_id required | 할당 ID Example : b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8 | string | None |
| body | body required | AccountAssignmentDeleteRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/account-assignments/{account_assignment_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.1"
Request body
{
"instance_id": "ssoins-12345",
"only_user_removed": false,
"target_account_id": "3265ab469f0d406d83073da3e11e7a6c"
}
Example HTTP response
Response 204
4.1.7.3 - 1.0
delete /v1/account-assignments/{account_assignment_id}
Description
delete a specific account Assignment
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | account_assignment_id required | 할당 ID Example : b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8 | string | None |
| body | body required | AccountAssignmentDeleteRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/account-assignments/{account_assignment_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.0"
Request body
{
"instance_id": "ssoins-12345",
"only_user_removed": false,
"target_account_id": "3265ab469f0d406d83073da3e11e7a6c"
}
Example HTTP response
Response 204
4.1.8 - DeleteBulkAccountAssignment
4.1.8.1 - 1.2
delete /v1/account-assignments
Description
delete multiple account Assignment
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | AccountAssignmentsDeleteRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/account-assignments
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.2"
Request body
{
"account_assignment_ids": [
"b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8"
],
"instance_id": "ssoins-12345",
"only_user_removed": false,
"target_account_id": "3265ab469f0d406d83073da3e11e7a6c"
}
Example HTTP response
Response 204
4.1.8.2 - 1.1
delete /v1/account-assignments
Description
delete multiple account Assignment
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | AccountAssignmentsDeleteRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/account-assignments
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.1"
Request body
{
"account_assignment_ids": [
"b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8"
],
"instance_id": "ssoins-12345",
"only_user_removed": false,
"target_account_id": "3265ab469f0d406d83073da3e11e7a6c"
}
Example HTTP response
Response 204
4.1.8.3 - 1.0
delete /v1/account-assignments
Description
delete multiple account Assignment
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | AccountAssignmentsDeleteRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/account-assignments
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.0"
Request body
{
"account_assignment_ids": [
"b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8"
],
"instance_id": "ssoins-12345",
"only_user_removed": false,
"target_account_id": "3265ab469f0d406d83073da3e11e7a6c"
}
Example HTTP response
Response 204
4.1.9 - DeleteBulkGroups
4.1.9.1 - 1.2
delete /v1/groups
Description
delete groups
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | GroupDeleteBulkRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupRemoveResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.2"
Request body
{
"group_ids": [
"group-12345",
"group-67890"
],
"instance_id": "ssoins-12345"
}
Example HTTP response
Response 200
{
"failed_ids": [
{
"error_code": "NOT_FOUND",
"failed_caused": "NotFoundError",
"failed_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
"failed_name": ""
}
],
"success_ids": [
{
"success_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
"success_name": "test"
}
]
}
4.1.9.2 - 1.1
delete /v1/groups
Description
delete groups
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | GroupDeleteBulkRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupRemoveResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.1"
Request body
{
"group_ids": [
"group-12345",
"group-67890"
],
"instance_id": "ssoins-12345"
}
Example HTTP response
Response 200
{
"failed_ids": [
{
"error_code": "NOT_FOUND",
"failed_caused": "NotFoundError",
"failed_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
"failed_name": ""
}
],
"success_ids": [
{
"success_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
"success_name": "test"
}
]
}
4.1.9.3 - 1.0
delete /v1/groups
Description
delete groups
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | GroupDeleteBulkRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupRemoveResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.0"
Request body
{
"group_ids": [
"group-12345",
"group-67890"
],
"instance_id": "ssoins-12345"
}
Example HTTP response
Response 200
{
"failed_ids": [
{
"error_code": "NOT_FOUND",
"failed_caused": "NotFoundError",
"failed_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
"failed_name": ""
}
],
"success_ids": [
{
"success_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
"success_name": "test"
}
]
}
4.1.10 - DeleteBulkGroupUsers
4.1.10.1 - 1.2
delete /v1/groups/{group_id}/users
Description
remove users from the specific group
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | 그룹 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
| body | body required | GroupUsersRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}/users
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.2"
Request body
{
"instance_id": "ssoins-12345",
"user_uuids": [
"user-12345",
"user-67890"
]
}
Example HTTP response
Response 204
4.1.10.2 - 1.1
delete /v1/groups/{group_id}/users
Description
remove users from the specific group
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | 그룹 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
| body | body required | GroupUsersRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}/users
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.1"
Request body
{
"instance_id": "ssoins-12345",
"user_uuids": [
"user-12345",
"user-67890"
]
}
Example HTTP response
Response 204
4.1.10.3 - 1.0
delete /v1/groups/{group_id}/users
Description
remove users from the specific group
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | 그룹 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
| body | body required | GroupUsersRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}/users
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.0"
Request body
{
"instance_id": "ssoins-12345",
"user_uuids": [
"user-12345",
"user-67890"
]
}
Example HTTP response
Response 204
4.1.11 - DeleteBulkUsers
4.1.11.1 - 1.2
delete /v1/users
Description
delete bulk users
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | UserDeleteBulkRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | UserRemoveResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/users
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.2"
Request body
{
"instance_id": "ssoins-12345",
"user_uuids": [
"user-12345",
"user-67890"
]
}
Example HTTP response
Response 200
{
"failed_ids": [
{
"error_code": "NOT_FOUND",
"failed_caused": "NotFoundError",
"failed_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
"failed_name": ""
}
],
"success_ids": [
{
"success_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
"success_name": "test"
}
]
}
4.1.11.2 - 1.1
delete /v1/users
Description
delete bulk users
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | UserDeleteBulkRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | UserRemoveResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/users
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.1"
Request body
{
"instance_id": "ssoins-12345",
"user_uuids": [
"user-12345",
"user-67890"
]
}
Example HTTP response
Response 200
{
"failed_ids": [
{
"error_code": "NOT_FOUND",
"failed_caused": "NotFoundError",
"failed_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
"failed_name": ""
}
],
"success_ids": [
{
"success_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
"success_name": "test"
}
]
}
4.1.11.3 - 1.0
delete /v1/users
Description
delete bulk users
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | UserDeleteBulkRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | UserRemoveResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/users
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.0"
Request body
{
"instance_id": "ssoins-12345",
"user_uuids": [
"user-12345",
"user-67890"
]
}
Example HTTP response
Response 200
{
"failed_ids": [
{
"error_code": "NOT_FOUND",
"failed_caused": "NotFoundError",
"failed_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
"failed_name": ""
}
],
"success_ids": [
{
"success_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
"success_name": "test"
}
]
}
4.1.12 - DeleteGroup
4.1.12.1 - 1.2
delete /v1/groups/{group_id}
Description
delete a specific group
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | 그룹 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
| body | body required | InstanceBaseRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupRemoveResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.2"
Request body
{
"instance_id": "ssoins-12345"
}
Example HTTP response
Response 200
{
"failed_ids": [
{
"error_code": "NOT_FOUND",
"failed_caused": "NotFoundError",
"failed_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
"failed_name": ""
}
],
"success_ids": [
{
"success_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
"success_name": "test"
}
]
}
4.1.12.2 - 1.1
delete /v1/groups/{group_id}
Description
delete a specific group
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | 그룹 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
| body | body required | InstanceBaseRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupRemoveResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.1"
Request body
{
"instance_id": "ssoins-12345"
}
Example HTTP response
Response 200
{
"failed_ids": [
{
"error_code": "NOT_FOUND",
"failed_caused": "NotFoundError",
"failed_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
"failed_name": ""
}
],
"success_ids": [
{
"success_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
"success_name": "test"
}
]
}
4.1.12.3 - 1.0
delete /v1/groups/{group_id}
Description
delete a specific group
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | 그룹 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
| body | body required | InstanceBaseRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupRemoveResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.0"
Request body
{
"instance_id": "ssoins-12345"
}
Example HTTP response
Response 200
{
"failed_ids": [
{
"error_code": "NOT_FOUND",
"failed_caused": "NotFoundError",
"failed_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
"failed_name": ""
}
],
"success_ids": [
{
"success_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
"success_name": "test"
}
]
}
4.1.13 - DeleteInstance
4.1.13.1 - 1.2
delete /v1/instances/{instance_id}
Description
delete a specific instance
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/instances/{instance_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.2"
Example HTTP response
Response 204
4.1.13.2 - 1.1
delete /v1/instances/{instance_id}
Description
delete a specific instance
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/instances/{instance_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.1"
Example HTTP response
Response 204
4.1.13.3 - 1.0
delete /v1/instances/{instance_id}
Description
delete a specific instance
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/instances/{instance_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.0"
Example HTTP response
Response 204
4.1.14 - DeletePermissionSet
4.1.14.1 - 1.2
delete /v1/permission-sets/{permission_set_id}
Description
delete a specific permission set
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | permission_set_id required | 권한 세트 ID Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 | string | None |
| query | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/permission-sets/{permission_set_id}?instance_id={instance_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.2"
Example HTTP response
Response 204
4.1.14.2 - 1.1
delete /v1/permission-sets/{permission_set_id}
Description
delete a specific permission set
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | permission_set_id required | 권한 세트 ID Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 | string | None |
| query | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/permission-sets/{permission_set_id}?instance_id={instance_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.1"
Example HTTP response
Response 204
4.1.14.3 - 1.0
delete /v1/permission-sets/{permission_set_id}
Description
delete a specific permission set
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | permission_set_id required | 권한 세트 ID Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 | string | None |
| query | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/permission-sets/{permission_set_id}?instance_id={instance_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.0"
Example HTTP response
Response 204
4.1.15 - DeletePermissionSetPolicies
4.1.15.1 - 1.2
delete /v1/permission-sets/{permission_set_id}/policies
Description
delete policies to a specific permission set
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | permission_set_id required | 권한 세트 ID Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 | string | None |
| body | body required | PermissionSetPoliciesDeleteRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/permission-sets/{permission_set_id}/policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.2"
Request body
{
"instance_id": "ssoins-12345",
"policy_ids": [
""
]
}
Example HTTP response
Response 204
4.1.15.2 - 1.1
delete /v1/permission-sets/{permission_set_id}/policies
Description
delete policies to a specific permission set
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | permission_set_id required | 권한 세트 ID Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 | string | None |
| body | body required | PermissionSetPoliciesDeleteRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/permission-sets/{permission_set_id}/policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.1"
Request body
{
"instance_id": "ssoins-12345",
"policy_ids": [
""
]
}
Example HTTP response
Response 204
4.1.15.3 - 1.0
delete /v1/permission-sets/{permission_set_id}/policies
Description
delete policies to a specific permission set
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | permission_set_id required | 권한 세트 ID Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 | string | None |
| body | body required | PermissionSetPoliciesDeleteRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/permission-sets/{permission_set_id}/policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.0"
Request body
{
"instance_id": "ssoins-12345",
"policy_ids": [
""
]
}
Example HTTP response
Response 204
4.1.16 - DeleteUser
4.1.16.1 - 1.2
delete /v1/users/{user_uuid}
Description
delete a specific user
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | user_uuid required | 사용자 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
| body | body required | InstanceBaseRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | UserRemoveResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/users/{user_uuid}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.2"
Request body
{
"instance_id": "ssoins-12345"
}
Example HTTP response
Response 200
{
"failed_ids": [
{
"error_code": "NOT_FOUND",
"failed_caused": "NotFoundError",
"failed_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
"failed_name": ""
}
],
"success_ids": [
{
"success_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
"success_name": "test"
}
]
}
4.1.16.2 - 1.1
delete /v1/users/{user_uuid}
Description
delete a specific user
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | user_uuid required | 사용자 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
| body | body required | InstanceBaseRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | UserRemoveResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/users/{user_uuid}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.1"
Request body
{
"instance_id": "ssoins-12345"
}
Example HTTP response
Response 200
{
"failed_ids": [
{
"error_code": "NOT_FOUND",
"failed_caused": "NotFoundError",
"failed_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
"failed_name": ""
}
],
"success_ids": [
{
"success_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
"success_name": "test"
}
]
}
4.1.16.3 - 1.0
delete /v1/users/{user_uuid}
Description
delete a specific user
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | user_uuid required | 사용자 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
| body | body required | InstanceBaseRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | UserRemoveResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/users/{user_uuid}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.0"
Request body
{
"instance_id": "ssoins-12345"
}
Example HTTP response
Response 200
{
"failed_ids": [
{
"error_code": "NOT_FOUND",
"failed_caused": "NotFoundError",
"failed_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
"failed_name": ""
}
],
"success_ids": [
{
"success_id": "7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e",
"success_name": "test"
}
]
}
4.1.17 - ListAccountAssignments
4.1.17.1 - 1.2
get /v1/account-assignments
Description
get account assignment list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
| query | target_account_id required | 할당된 계정 ID Example : 3265ab469f0d406d83073da3e11e7a6c | string | None |
| query | target_account_name optional | 할당된 Account명 Example : Admin Account | any of [string, null] | None |
| query | target_account_email optional | 할당된 계정 이메일 Example : target_account@example.com | any of [string, null] | None |
| query | permission_set_id optional | 권한 세트 ID Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 | any of [string, null] | None |
| query | principal_name optional | 주체 이름 Example : GROUP0407 | any of [string, null] | None |
| query | role_srn optional | 역할 SRN Example : srn:role:kr-j:1234:role/admin@example.com | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AccountAssignmentsPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/account-assignments?instance_id={instance_id}&target_account_id={target_account_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.2"
Example HTTP response
Response 200
{
"account_assignments": [
{
"instance_id": "ssoins-12345",
"permission_sets": [],
"principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"principal_name": "GROUP0407",
"principal_type": "USER",
"role_srn": "Permissions for administrators",
"target_account_email": "target_account@example.com",
"target_account_id": "3265ab469f0d406d83073da3e11e7a6c",
"target_account_name": "Admin Account"
}
],
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
4.1.17.2 - 1.1
get /v1/account-assignments
Description
get account assignment list
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
| query | target_account_id required | 할당된 계정 ID Example : 3265ab469f0d406d83073da3e11e7a6c | string | None |
| query | target_account_name optional | 할당된 Account명 Example : Admin Account | any of [string, null] | None |
| query | target_account_email optional | 할당된 계정 이메일 Example : target_account@example.com | any of [string, null] | None |
| query | permission_set_id optional | 권한 세트 ID Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 | any of [string, null] | None |
| query | principal_name optional | 주체 이름 Example : GROUP0407 | any of [string, null] | None |
| query | role_srn optional | 역할 SRN Example : srn:role:kr-j:1234:role/admin@example.com | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AccountAssignmentsPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/account-assignments?instance_id={instance_id}&target_account_id={target_account_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.1"
Example HTTP response
Response 200
{
"account_assignments": [
{
"instance_id": "ssoins-12345",
"permission_sets": [],
"principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"principal_name": "GROUP0407",
"principal_type": "USER",
"role_srn": "Permissions for administrators",
"target_account_email": "target_account@example.com",
"target_account_id": "3265ab469f0d406d83073da3e11e7a6c",
"target_account_name": "Admin Account"
}
],
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
4.1.17.3 - 1.0
get /v1/account-assignments
Description
get account assignment list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
| query | target_account_id required | 할당된 계정 ID Example : 3265ab469f0d406d83073da3e11e7a6c | string | None |
| query | target_account_name optional | 할당된 Account명 Example : Admin Account | any of [string, null] | None |
| query | target_account_email optional | 할당된 계정 이메일 Example : target_account@example.com | any of [string, null] | None |
| query | permission_set_id optional | 권한 세트 ID Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 | any of [string, null] | None |
| query | principal_name optional | 주체 이름 Example : GROUP0407 | any of [string, null] | None |
| query | role_srn optional | 역할 SRN Example : srn:role:kr-j:1234:role/admin@example.com | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AccountAssignmentsPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/account-assignments?instance_id={instance_id}&target_account_id={target_account_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.0"
Example HTTP response
Response 200
{
"account_assignments": [
{
"instance_id": "ssoins-12345",
"permission_sets": [],
"principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"principal_name": "GROUP0407",
"principal_type": "USER",
"role_srn": "Permissions for administrators",
"target_account_email": "target_account@example.com",
"target_account_id": "3265ab469f0d406d83073da3e11e7a6c",
"target_account_name": "Admin Account"
}
],
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
4.1.18 - ListGroups
4.1.18.1 - 1.2
get /v1/groups
Description
get groups list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
| query | name optional | 그룹 이름 Example : Admin_Group | any of [string, null] | None |
| query | excluded_user_uuid optional | 사용자 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | any of [string, null] | None |
| query | excluded_account_id optional | Account ID Example : 1234ab567cd64769e8f9g490hi304891 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups?instance_id={instance_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.2"
Example HTTP response
Response 200
{
"count": 20,
"groups": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "John Doe",
"description": "Group for administrators",
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"instance_id": "ssoins-12345",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "Smith",
"name": "Admin_Group",
"user_count": 1,
"users": [
{
"id": "6fdd2a6d-6f4f-4157-8259-5d55e7dd1269",
"name": "John Doe",
"user_id": "johndoe"
}
]
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
4.1.18.2 - 1.1
get /v1/groups
Description
get groups list
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
| query | name optional | 그룹 이름 Example : Admin_Group | any of [string, null] | None |
| query | excluded_user_uuid optional | 사용자 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | any of [string, null] | None |
| query | excluded_account_id optional | Account ID Example : 1234ab567cd64769e8f9g490hi304891 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups?instance_id={instance_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.1"
Example HTTP response
Response 200
{
"count": 20,
"groups": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "John Doe",
"description": "Group for administrators",
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"instance_id": "ssoins-12345",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "Smith",
"name": "Admin_Group",
"user_count": 1,
"users": [
{
"id": "6fdd2a6d-6f4f-4157-8259-5d55e7dd1269",
"name": "John Doe",
"user_id": "johndoe"
}
]
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
4.1.18.3 - 1.0
get /v1/groups
Description
get groups list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
| query | name optional | 그룹 이름 Example : Admin_Group | any of [string, null] | None |
| query | excluded_user_uuid optional | 사용자 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | any of [string, null] | None |
| query | excluded_account_id optional | Account ID Example : 1234ab567cd64769e8f9g490hi304891 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups?instance_id={instance_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.0"
Example HTTP response
Response 200
{
"count": 20,
"groups": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "John Doe",
"description": "Group for administrators",
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"instance_id": "ssoins-12345",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "Smith",
"name": "Admin_Group",
"user_count": 1,
"users": [
{
"id": "6fdd2a6d-6f4f-4157-8259-5d55e7dd1269",
"name": "John Doe",
"user_id": "johndoe"
}
]
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
4.1.19 - ListGroupUsers
4.1.19.1 - 1.2
get /v1/groups/{group_id}/users
Description
get group users list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | 그룹 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
| query | user_id optional | 사용자 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupUsersPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}/users?instance_id={instance_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.2"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
],
"users": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"group_count": 2,
"groups": [
{
"created_at": "2025-07-03T12:05:11",
"created_by": "a8b5d675f25341cea41eb4cd1979aa95",
"id": "39520424-440c-41c0-9b9c-f22b2129f6f9",
"modified_at": "2025-07-03T12:05:11",
"modified_by": "a8b5d675f25341cea41eb4cd1979aa95",
"name": "admin"
},
{
"created_at": "2025-07-03T12:05:36",
"created_by": "a8b5d675f25341cea41eb4cd1979aa95",
"id": "80c53fe1-4e27-4cce-92be-151cf0f2873e",
"modified_at": "2025-07-07T05:16:58",
"modified_by": "941e76c4b9424cd9b0ac3a12d5f4335d",
"name": "test-group"
}
],
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "John Doe",
"user_id": "johndoe"
}
]
}
4.1.19.2 - 1.1
get /v1/groups/{group_id}/users
Description
get group users list
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | 그룹 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
| query | user_id optional | 사용자 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupUsersPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}/users?instance_id={instance_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.1"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
],
"users": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"group_count": 2,
"groups": [
{
"created_at": "2025-07-03T12:05:11",
"created_by": "a8b5d675f25341cea41eb4cd1979aa95",
"id": "39520424-440c-41c0-9b9c-f22b2129f6f9",
"modified_at": "2025-07-03T12:05:11",
"modified_by": "a8b5d675f25341cea41eb4cd1979aa95",
"name": "admin"
},
{
"created_at": "2025-07-03T12:05:36",
"created_by": "a8b5d675f25341cea41eb4cd1979aa95",
"id": "80c53fe1-4e27-4cce-92be-151cf0f2873e",
"modified_at": "2025-07-07T05:16:58",
"modified_by": "941e76c4b9424cd9b0ac3a12d5f4335d",
"name": "test-group"
}
],
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "John Doe",
"user_id": "johndoe"
}
]
}
4.1.19.3 - 1.0
get /v1/groups/{group_id}/users
Description
get group users list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | 그룹 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
| query | user_id optional | 사용자 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupUsersPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}/users?instance_id={instance_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.0"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
],
"users": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"group_count": 2,
"groups": [
{
"created_at": "2025-07-03T12:05:11",
"created_by": "a8b5d675f25341cea41eb4cd1979aa95",
"id": "39520424-440c-41c0-9b9c-f22b2129f6f9",
"modified_at": "2025-07-03T12:05:11",
"modified_by": "a8b5d675f25341cea41eb4cd1979aa95",
"name": "admin"
},
{
"created_at": "2025-07-03T12:05:36",
"created_by": "a8b5d675f25341cea41eb4cd1979aa95",
"id": "80c53fe1-4e27-4cce-92be-151cf0f2873e",
"modified_at": "2025-07-07T05:16:58",
"modified_by": "941e76c4b9424cd9b0ac3a12d5f4335d",
"name": "test-group"
}
],
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "John Doe",
"user_id": "johndoe"
}
]
}
4.1.20 - ListInstances
4.1.20.1 - 1.2
get /v1/instances
Description
get instances list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | InstancePageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/instances
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.2"
Example HTTP response
Response 200
{
"count": 20,
"instances": [],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
4.1.20.2 - 1.1
get /v1/instances
Description
get instances list
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | name optional | 인스턴스 이름 Example : My Instance | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | InstancePageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/instances
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.1"
Example HTTP response
Response 200
{
"count": 20,
"instances": [],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
4.1.20.3 - 1.0
get /v1/instances
Description
get instances list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | name optional | 인스턴스 이름 Example : My Instance | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | InstancePageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/instances
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.0"
Example HTTP response
Response 200
{
"count": 20,
"instances": [],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
4.1.21 - ListPermissionSetPolicies
4.1.21.1 - 1.2
get /v1/permission-sets/{permission_set_id}/policies
Description
get policies to a specific permission set
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | permission_set_id required | 권한 세트 ID Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 | string | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
| query | category optional | 정책 유형 Example : INLINE_POLICY | any of [enum (MANAGED_POLICY, CUSTOM_POLICY, INLINE_POLICY), null] | None |
| query | name optional | None Example : Permission Set | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PermissionSetPoliciesPageResponseV1Dot2 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/permission-sets/{permission_set_id}/policies?instance_id={instance_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.2"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"policies": [],
"size": 20,
"sort": [
"created_at:asc"
]
}
4.1.21.2 - 1.1
get /v1/permission-sets/{permission_set_id}/policies
Description
get policies to a specific permission set
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | permission_set_id required | 권한 세트 ID Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 | string | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
| query | category optional | 정책 유형 Example : INLINE_POLICY | any of [enum (MANAGED_POLICY, CUSTOMER_POLICY, INLINE_POLICY), null] | None |
| query | name optional | None Example : Permission Set | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PermissionSetPoliciesPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/permission-sets/{permission_set_id}/policies?instance_id={instance_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.1"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"policies": [],
"size": 20,
"sort": [
"created_at:asc"
]
}
4.1.21.3 - 1.0
get /v1/permission-sets/{permission_set_id}/policies
Description
get policies to a specific permission set
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | permission_set_id required | 권한 세트 ID Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 | string | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
| query | category optional | 정책 유형 Example : INLINE_POLICY | any of [enum (MANAGED_POLICY, CUSTOMER_POLICY, INLINE_POLICY), null] | None |
| query | name optional | None Example : Permission Set | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PermissionSetPoliciesPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/permission-sets/{permission_set_id}/policies?instance_id={instance_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.0"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"policies": [],
"size": 20,
"sort": [
"created_at:asc"
]
}
4.1.22 - ListPermissionSets
4.1.22.1 - 1.2
get /v1/permission-sets
Description
get permission sets list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
| query | name optional | 권한 세트 이름 Example : Permission Set | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PermissionSetDetailsPageResponseV1Dot2 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/permission-sets?instance_id={instance_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.2"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"permission_sets": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "",
"custom_policies": [
""
],
"description": "Permissions for administrators",
"id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
"inline_policies": [
""
],
"instance_id": "ssoins-12345",
"managed_policies": [
""
],
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "",
"name": "Permission Set",
"session_duration": 3600,
"srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
"state": "ACTIVE"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
4.1.22.2 - 1.1
get /v1/permission-sets
Description
get permission sets list
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
| query | name optional | 권한 세트 이름 Example : Permission Set | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PermissionSetsPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/permission-sets?instance_id={instance_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.1"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"permission_sets": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "",
"description": "Permissions for administrators",
"id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
"instance_id": "ssoins-12345",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "",
"name": "Permission Set",
"state": "ACTIVE"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
4.1.22.3 - 1.0
get /v1/permission-sets
Description
get permission sets list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
| query | name optional | 권한 세트 이름 Example : Permission Set | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PermissionSetsPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/permission-sets?instance_id={instance_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.0"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"permission_sets": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "",
"description": "Permissions for administrators",
"id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
"instance_id": "ssoins-12345",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "",
"name": "Permission Set",
"state": "ACTIVE"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
4.1.23 - ListUsers
4.1.23.1 - 1.2
get /v1/users
Description
get users list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
| query | user_id optional | 사용자 로그인 ID Example : johndoe | any of [string, null] | None |
| query | excluded_group_id optional | 그룹 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | any of [string, null] | None |
| query | excluded_account_id optional | Account ID Example : 1234ab567cd64769e8f9g490hi304891 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | UserPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/users?instance_id={instance_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.2"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
],
"users": [
{
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"name": "John Doe",
"user_id": "johndoe"
}
]
}
4.1.23.2 - 1.1
get /v1/users
Description
get users list
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
| query | user_id optional | 사용자 로그인 ID Example : johndoe | any of [string, null] | None |
| query | excluded_group_id optional | 그룹 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | any of [string, null] | None |
| query | excluded_account_id optional | Account ID Example : 1234ab567cd64769e8f9g490hi304891 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | UserPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/users?instance_id={instance_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.1"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
],
"users": [
{
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"name": "John Doe",
"user_id": "johndoe"
}
]
}
4.1.23.3 - 1.0
get /v1/users
Description
get users list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
| query | user_id optional | 사용자 로그인 ID Example : johndoe | any of [string, null] | None |
| query | excluded_group_id optional | 그룹 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | any of [string, null] | None |
| query | excluded_account_id optional | Account ID Example : 1234ab567cd64769e8f9g490hi304891 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | UserPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/users?instance_id={instance_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.0"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
],
"users": [
{
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"name": "John Doe",
"user_id": "johndoe"
}
]
}
4.1.24 - SetGroup
4.1.24.1 - 1.2
patch /v1/groups/{group_id}
Description
set a specific group
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | 그룹 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
| body | body required | GroupSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupSetResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.2"
Request body
{
"description": "Group for administrators",
"instance_id": "ssoins-12345",
"name": "Admin_Group"
}
Example HTTP response
Response 200
{
"group": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "John Doe",
"description": "Group for administrators",
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"instance_id": "ssoins-12345",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "Smith",
"name": "Admin_Group"
}
}
4.1.24.2 - 1.1
patch /v1/groups/{group_id}
Description
set a specific group
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | 그룹 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
| body | body required | GroupSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupSetResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.1"
Request body
{
"description": "Group for administrators",
"instance_id": "ssoins-12345",
"name": "Admin_Group"
}
Example HTTP response
Response 200
{
"group": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "John Doe",
"description": "Group for administrators",
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"instance_id": "ssoins-12345",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "Smith",
"name": "Admin_Group"
}
}
4.1.24.3 - 1.0
patch /v1/groups/{group_id}
Description
set a specific group
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | 그룹 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
| body | body required | GroupSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupSetResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.0"
Request body
{
"description": "Group for administrators",
"instance_id": "ssoins-12345",
"name": "Admin_Group"
}
Example HTTP response
Response 200
{
"group": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "John Doe",
"description": "Group for administrators",
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"instance_id": "ssoins-12345",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "Smith",
"name": "Admin_Group"
}
}
4.1.25 - SetInstance
4.1.25.1 - 1.2
patch /v1/instances/{instance_id}
Description
set a specific instance
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
| body | body required | InstanceSetRequest1Dot1 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | InstanceShowResponseV1Dot1 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/instances/{instance_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.2"
Request body
{
"description": "My Instance Description",
"identity_store_config": {
"bind_credential": "password",
"bind_dn": "CN=Administrator,CN=Users,DC=test,DC=add",
"component_id": "HYIK7LLKQL2MFK2K8Jb1ew",
"connection_url": "ldaps://test.subdomain.company.com:123",
"rdn_ldap_attribute": "cn",
"user_object_classes": "person, organizationalPerson, user",
"username_ldap_attribute": "sAMAccountName",
"users_dn": "OU=Employees,OU=Accounts,DC=sub,DC=org"
},
"identity_store_type": "IDENTITY_CENTER_DIRECTORY",
"name": "My Instance"
}
Example HTTP response
Response 200
{
"instance": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"delegated_account_id": "acc-2353",
"delegated_at": "2023-10-15 14:30:00",
"delegated_by": "sef2w3c8c29a449dbfa8681f8f1d78e2",
"description": "My Instance Description",
"id": "ssoins-12345",
"identity_store_config": {
"bind_credential": "password",
"bind_dn": "CN=Administrator,CN=Users,DC=test,DC=add",
"component_id": "HYIK7LLKQL2MFK2K8Jb1ew",
"connection_url": "ldaps://test.subdomain.company.com:123",
"rdn_ldap_attribute": "cn",
"user_object_classes": "person, organizationalPerson, user",
"username_ldap_attribute": "sAMAccountName",
"users_dn": "OU=Employees,OU=Accounts,DC=sub,DC=org"
},
"identity_store_id": "d-12345",
"identity_store_type": "ACTIVE_DIRECTORY",
"last_sync_at": "2025-08-06 10:30:00",
"last_sync_status": [
"CREATED",
"RUNNING",
"FINISHED",
"FAILED",
"NONE"
],
"master_account_id": "acc-12345",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "My Instance",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"region": "kr-west1",
"srn": "srn:identity-center::prj-01234:kr-west-1::instance/ins-01234",
"sso_start_url": "https://login.e.samsungsdscloud.com/d-12345",
"state": "ACTIVE"
}
}
4.1.25.2 - 1.1
patch /v1/instances/{instance_id}
Description
set a specific instance
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
| body | body required | InstanceSetRequest1Dot1 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | InstanceShowResponseV1Dot1 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/instances/{instance_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.1"
Request body
{
"description": "My Instance Description",
"identity_store_config": {
"bind_credential": "password",
"bind_dn": "CN=Administrator,CN=Users,DC=test,DC=add",
"component_id": "HYIK7LLKQL2MFK2K8Jb1ew",
"connection_url": "ldaps://test.subdomain.company.com:123",
"rdn_ldap_attribute": "cn",
"user_object_classes": "person, organizationalPerson, user",
"username_ldap_attribute": "sAMAccountName",
"users_dn": "OU=Employees,OU=Accounts,DC=sub,DC=org"
},
"identity_store_type": "IDENTITY_CENTER_DIRECTORY",
"name": "My Instance"
}
Example HTTP response
Response 200
{
"instance": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"delegated_account_id": "acc-2353",
"delegated_at": "2023-10-15 14:30:00",
"delegated_by": "sef2w3c8c29a449dbfa8681f8f1d78e2",
"description": "My Instance Description",
"id": "ssoins-12345",
"identity_store_config": {
"bind_credential": "password",
"bind_dn": "CN=Administrator,CN=Users,DC=test,DC=add",
"component_id": "HYIK7LLKQL2MFK2K8Jb1ew",
"connection_url": "ldaps://test.subdomain.company.com:123",
"rdn_ldap_attribute": "cn",
"user_object_classes": "person, organizationalPerson, user",
"username_ldap_attribute": "sAMAccountName",
"users_dn": "OU=Employees,OU=Accounts,DC=sub,DC=org"
},
"identity_store_id": "d-12345",
"identity_store_type": "ACTIVE_DIRECTORY",
"last_sync_at": "2025-08-06 10:30:00",
"last_sync_status": [
"CREATED",
"RUNNING",
"FINISHED",
"FAILED",
"NONE"
],
"master_account_id": "acc-12345",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "My Instance",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"region": "kr-west1",
"srn": "srn:identity-center::prj-01234:kr-west-1::instance/ins-01234",
"sso_start_url": "https://login.e.samsungsdscloud.com/d-12345",
"state": "ACTIVE"
}
}
4.1.26 - SetPermissionSet
4.1.26.1 - 1.2
patch /v1/permission-sets/{permission_set_id}
Description
set a specific permission set
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | permission_set_id required | 권한 세트 ID Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 | string | None |
| body | body required | PermissionSetSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PermissionSetDetailsV1Dot2 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/permission-sets/{permission_set_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.2"
Request body
{
"description": "My Instance Description",
"instance_id": "ssoins-12345",
"session_duration": 3600
}
Example HTTP response
Response 200
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "",
"custom_policies": [
""
],
"description": "Permissions for administrators",
"id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
"inline_policies": [
""
],
"instance_id": "ssoins-12345",
"managed_policies": [
""
],
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "",
"name": "Permission Set",
"session_duration": 3600,
"srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
"state": "ACTIVE"
}
4.1.26.2 - 1.1
patch /v1/permission-sets/{permission_set_id}
Description
set a specific permission set
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | permission_set_id required | 권한 세트 ID Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 | string | None |
| body | body required | PermissionSetSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PermissionSetDetails |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/permission-sets/{permission_set_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.1"
Request body
{
"description": "My Instance Description",
"instance_id": "ssoins-12345",
"session_duration": 3600
}
Example HTTP response
Response 200
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "",
"customer_policies": [
""
],
"description": "Permissions for administrators",
"id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
"inline_policies": [
""
],
"instance_id": "ssoins-12345",
"managed_policies": [
""
],
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "",
"name": "Permission Set",
"session_duration": 3600,
"srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
"state": "ACTIVE"
}
4.1.26.3 - 1.0
patch /v1/permission-sets/{permission_set_id}
Description
set a specific permission set
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | permission_set_id required | 권한 세트 ID Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 | string | None |
| body | body required | PermissionSetSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PermissionSetDetails |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/permission-sets/{permission_set_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.0"
Request body
{
"description": "My Instance Description",
"instance_id": "ssoins-12345",
"session_duration": 3600
}
Example HTTP response
Response 200
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "",
"customer_policies": [
""
],
"description": "Permissions for administrators",
"id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
"inline_policies": [
""
],
"instance_id": "ssoins-12345",
"managed_policies": [
""
],
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "",
"name": "Permission Set",
"session_duration": 3600,
"srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
"state": "ACTIVE"
}
4.1.27 - SetPermissionSetPolicies
4.1.27.1 - 1.2
put /v1/permission-sets/{permission_set_id}/policies
Description
set policies to a specific permission set
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | permission_set_id required | 권한 세트 ID Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 | string | None |
| body | body required | PermissionSetPoliciesSetRequestV1Dot2 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PermissionSetDetailsV1Dot2 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/permission-sets/{permission_set_id}/policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.2"
Request body
{
"custom_policies": [
""
],
"inline_policies": [
""
],
"instance_id": "ssoins-12345",
"managed_policies": [
""
]
}
Example HTTP response
Response 200
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "",
"custom_policies": [
""
],
"description": "Permissions for administrators",
"id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
"inline_policies": [
""
],
"instance_id": "ssoins-12345",
"managed_policies": [
""
],
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "",
"name": "Permission Set",
"session_duration": 3600,
"srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
"state": "ACTIVE"
}
4.1.27.2 - 1.1
put /v1/permission-sets/{permission_set_id}/policies
Description
set policies to a specific permission set
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | permission_set_id required | 권한 세트 ID Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 | string | None |
| body | body required | PermissionSetPoliciesSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PermissionSetDetails |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/permission-sets/{permission_set_id}/policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.1"
Request body
{
"customer_policies": [
""
],
"inline_policies": [
""
],
"instance_id": "ssoins-12345",
"managed_policies": [
""
]
}
Example HTTP response
Response 200
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "",
"customer_policies": [
""
],
"description": "Permissions for administrators",
"id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
"inline_policies": [
""
],
"instance_id": "ssoins-12345",
"managed_policies": [
""
],
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "",
"name": "Permission Set",
"session_duration": 3600,
"srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
"state": "ACTIVE"
}
4.1.27.3 - 1.0
put /v1/permission-sets/{permission_set_id}/policies
Description
set policies to a specific permission set
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | permission_set_id required | 권한 세트 ID Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 | string | None |
| body | body required | PermissionSetPoliciesSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | PermissionSetDetails |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/permission-sets/{permission_set_id}/policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.0"
Request body
{
"customer_policies": [
""
],
"inline_policies": [
""
],
"instance_id": "ssoins-12345",
"managed_policies": [
""
]
}
Example HTTP response
Response 200
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "",
"customer_policies": [
""
],
"description": "Permissions for administrators",
"id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
"inline_policies": [
""
],
"instance_id": "ssoins-12345",
"managed_policies": [
""
],
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "",
"name": "Permission Set",
"session_duration": 3600,
"srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
"state": "ACTIVE"
}
4.1.28 - SetUser
4.1.28.1 - 1.2
patch /v1/users/{user_uuid}
Description
set a specific user
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | user_uuid required | 사용자 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
| body | body required | UserSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | UserResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/users/{user_uuid}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.2"
Request body
{
"business_unit": "Business Unit A",
"department": "Department X",
"description": "Description of John Doe",
"email": "john.doe@example.com",
"employee_id": "emp-12345",
"instance_id": "ssoins-12345",
"manager": "Alice Smith",
"name": "John Doe",
"nation_id": "+82",
"phone_number": "010-1234-5678",
"tz_id": "Asia/Seoul"
}
Example HTTP response
Response 200
{
"user": {
"business_unit": "Business Unit A",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "John Doe",
"department": "Department X",
"description": "Description of John Doe",
"email": "john.doe@example.com",
"email_authenticated": false,
"employee_id": "emp-12345",
"groups": [],
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"instance_id": "ssoins-12345",
"last_login_at": "2024-12-19 01:09:05.000",
"last_password_update_at": "2025-11-24T08:14:51.694996",
"manager": "Alice Smith",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "Smith",
"name": "John Doe",
"nation_id": "+82",
"password": "",
"password_failed_count": 6,
"password_reuse_count": 6,
"phone_authenticated": false,
"phone_number": "010-1234-5678",
"temporary_password": "",
"tz_id": "Asia/Seoul",
"user_id": "johndoe"
}
}
4.1.28.2 - 1.1
patch /v1/users/{user_uuid}
Description
set a specific user
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | user_uuid required | 사용자 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
| body | body required | UserSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | UserResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/users/{user_uuid}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.1"
Request body
{
"business_unit": "Business Unit A",
"department": "Department X",
"description": "Description of John Doe",
"email": "john.doe@example.com",
"employee_id": "emp-12345",
"instance_id": "ssoins-12345",
"manager": "Alice Smith",
"name": "John Doe",
"nation_id": "+82",
"phone_number": "010-1234-5678",
"tz_id": "Asia/Seoul"
}
Example HTTP response
Response 200
{
"user": {
"business_unit": "Business Unit A",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "John Doe",
"department": "Department X",
"description": "Description of John Doe",
"email": "john.doe@example.com",
"email_authenticated": false,
"employee_id": "emp-12345",
"groups": [],
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"instance_id": "ssoins-12345",
"last_login_at": "2024-12-19 01:09:05.000",
"last_password_update_at": "2025-11-24T08:14:51.694996",
"manager": "Alice Smith",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "Smith",
"name": "John Doe",
"nation_id": "+82",
"password": "",
"password_failed_count": 6,
"password_reuse_count": 6,
"phone_authenticated": false,
"phone_number": "010-1234-5678",
"temporary_password": "",
"tz_id": "Asia/Seoul",
"user_id": "johndoe"
}
}
4.1.28.3 - 1.0
patch /v1/users/{user_uuid}
Description
set a specific user
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | user_uuid required | 사용자 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
| body | body required | UserSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | UserResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/users/{user_uuid}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.0"
Request body
{
"business_unit": "Business Unit A",
"department": "Department X",
"description": "Description of John Doe",
"email": "john.doe@example.com",
"employee_id": "emp-12345",
"instance_id": "ssoins-12345",
"manager": "Alice Smith",
"name": "John Doe",
"nation_id": "+82",
"phone_number": "010-1234-5678",
"tz_id": "Asia/Seoul"
}
Example HTTP response
Response 200
{
"user": {
"business_unit": "Business Unit A",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "John Doe",
"department": "Department X",
"description": "Description of John Doe",
"email": "john.doe@example.com",
"email_authenticated": false,
"employee_id": "emp-12345",
"groups": [],
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"instance_id": "ssoins-12345",
"last_login_at": "2024-12-19 01:09:05.000",
"last_password_update_at": "2025-11-24T08:14:51.694996",
"manager": "Alice Smith",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "Smith",
"name": "John Doe",
"nation_id": "+82",
"password": "",
"password_failed_count": 6,
"password_reuse_count": 6,
"phone_authenticated": false,
"phone_number": "010-1234-5678",
"temporary_password": "",
"tz_id": "Asia/Seoul",
"user_id": "johndoe"
}
}
4.1.29 - ShowGroup
4.1.29.1 - 1.2
get /v1/groups/{group_id}
Description
show a specific group
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | 그룹 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
| query | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}?instance_id={instance_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.2"
Example HTTP response
Response 200
{
"group": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "John Doe",
"description": "Group for administrators",
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"instance_id": "ssoins-12345",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "Smith",
"name": "Admin_Group",
"user_count": 1,
"users": [
{
"id": "6fdd2a6d-6f4f-4157-8259-5d55e7dd1269",
"name": "John Doe",
"user_id": "johndoe"
}
]
}
}
4.1.29.2 - 1.1
get /v1/groups/{group_id}
Description
show a specific group
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | 그룹 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
| query | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}?instance_id={instance_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.1"
Example HTTP response
Response 200
{
"group": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "John Doe",
"description": "Group for administrators",
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"instance_id": "ssoins-12345",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "Smith",
"name": "Admin_Group",
"user_count": 1,
"users": [
{
"id": "6fdd2a6d-6f4f-4157-8259-5d55e7dd1269",
"name": "John Doe",
"user_id": "johndoe"
}
]
}
}
4.1.29.3 - 1.0
get /v1/groups/{group_id}
Description
show a specific group
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | group_id required | 그룹 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
| query | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | GroupShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/groups/{group_id}?instance_id={instance_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.0"
Example HTTP response
Response 200
{
"group": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "John Doe",
"description": "Group for administrators",
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"instance_id": "ssoins-12345",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "Smith",
"name": "Admin_Group",
"user_count": 1,
"users": [
{
"id": "6fdd2a6d-6f4f-4157-8259-5d55e7dd1269",
"name": "John Doe",
"user_id": "johndoe"
}
]
}
}
4.1.30 - ShowInstance
4.1.30.1 - 1.2
get /v1/instances/{instance_id}
Description
show a specific instance
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | InstanceShowResponseAddResourceV1Dot1 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/instances/{instance_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.2"
Example HTTP response
Response 200
{
"instance": {
"account_id": "1234ab567cd64769e8f9g490hi304891",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "John Doe",
"delegated_account_id": "acc-2353",
"delegated_at": "2023-10-15 14:30:00",
"delegated_by": "sef2w3c8c29a449dbfa8681f8f1d78e2",
"description": "My Instance Description",
"id": "ssoins-12345",
"identity_store_config": {
"bind_credential": "password",
"bind_dn": "CN=Administrator,CN=Users,DC=test,DC=add",
"component_id": "HYIK7LLKQL2MFK2K8Jb1ew",
"connection_url": "ldaps://test.subdomain.company.com:123",
"rdn_ldap_attribute": "cn",
"user_object_classes": "person, organizationalPerson, user",
"username_ldap_attribute": "sAMAccountName",
"users_dn": "OU=Employees,OU=Accounts,DC=sub,DC=org"
},
"identity_store_id": "d-12345",
"identity_store_type": "ACTIVE_DIRECTORY",
"last_sync_at": "2025-08-06 10:30:00",
"last_sync_status": [
"CREATED",
"RUNNING",
"FINISHED",
"FAILED",
"NONE"
],
"master_account_id": "acc-12345",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "Smith",
"name": "My Instance",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"region": "kr-west1",
"resource_name": "resource-name-1",
"resource_type": "virtual-server",
"resource_type_display_name": "Virtual Server",
"service": "virtualserver",
"service_name": "Virtual Server",
"srn": "srn:identity-center::prj-01234:kr-west-1::instance/ins-01234",
"sso_start_url": "https://login.e.samsungsdscloud.com/d-12345",
"state": "ACTIVE"
}
}
4.1.30.2 - 1.1
get /v1/instances/{instance_id}
Description
show a specific instance
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | InstanceShowResponseAddResourceV1Dot1 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/instances/{instance_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.1"
Example HTTP response
Response 200
{
"instance": {
"account_id": "1234ab567cd64769e8f9g490hi304891",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "John Doe",
"delegated_account_id": "acc-2353",
"delegated_at": "2023-10-15 14:30:00",
"delegated_by": "sef2w3c8c29a449dbfa8681f8f1d78e2",
"description": "My Instance Description",
"id": "ssoins-12345",
"identity_store_config": {
"bind_credential": "password",
"bind_dn": "CN=Administrator,CN=Users,DC=test,DC=add",
"component_id": "HYIK7LLKQL2MFK2K8Jb1ew",
"connection_url": "ldaps://test.subdomain.company.com:123",
"rdn_ldap_attribute": "cn",
"user_object_classes": "person, organizationalPerson, user",
"username_ldap_attribute": "sAMAccountName",
"users_dn": "OU=Employees,OU=Accounts,DC=sub,DC=org"
},
"identity_store_id": "d-12345",
"identity_store_type": "ACTIVE_DIRECTORY",
"last_sync_at": "2025-08-06 10:30:00",
"last_sync_status": [
"CREATED",
"RUNNING",
"FINISHED",
"FAILED",
"NONE"
],
"master_account_id": "acc-12345",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "Smith",
"name": "My Instance",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"region": "kr-west1",
"resource_name": "resource-name-1",
"resource_type": "virtual-server",
"resource_type_display_name": "Virtual Server",
"service": "virtualserver",
"service_name": "Virtual Server",
"srn": "srn:identity-center::prj-01234:kr-west-1::instance/ins-01234",
"sso_start_url": "https://login.e.samsungsdscloud.com/d-12345",
"state": "ACTIVE"
}
}
4.1.31 - ShowPermissionSet
4.1.31.1 - 1.2
get /v1/permission-sets/{permission_set_id}
Description
show a specific permission set
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | permission_set_id required | 권한 세트 ID Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 | string | None |
| query | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ShowPermissionSetAddResourceV1Dot2 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/permission-sets/{permission_set_id}?instance_id={instance_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.2"
Example HTTP response
Response 200
{
"account_id": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "",
"custom_policies": [
""
],
"description": "Permissions for administrators",
"id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
"inline_policies": [
""
],
"instance_id": "ssoins-12345",
"managed_policies": [
""
],
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "",
"name": "Permission Set",
"resource_name": "",
"resource_type": "",
"resource_type_display_name": "",
"service": "",
"service_name": "",
"session_duration": 3600,
"srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
"state": "ACTIVE"
}
4.1.31.2 - 1.1
get /v1/permission-sets/{permission_set_id}
Description
show a specific permission set
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | permission_set_id required | 권한 세트 ID Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 | string | None |
| query | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ShowPermissionSetAddResource |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/permission-sets/{permission_set_id}?instance_id={instance_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.1"
Example HTTP response
Response 200
{
"account_id": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "",
"customer_policies": [
""
],
"description": "Permissions for administrators",
"id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
"inline_policies": [
""
],
"instance_id": "ssoins-12345",
"managed_policies": [
""
],
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "",
"name": "Permission Set",
"resource_name": "",
"resource_type": "",
"resource_type_display_name": "",
"service": "",
"service_name": "",
"session_duration": 3600,
"srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
"state": "ACTIVE"
}
4.1.31.3 - 1.0
get /v1/permission-sets/{permission_set_id}
Description
show a specific permission set
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | permission_set_id required | 권한 세트 ID Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 | string | None |
| query | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ShowPermissionSetAddResource |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/permission-sets/{permission_set_id}?instance_id={instance_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.0"
Example HTTP response
Response 200
{
"account_id": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "",
"customer_policies": [
""
],
"description": "Permissions for administrators",
"id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
"inline_policies": [
""
],
"instance_id": "ssoins-12345",
"managed_policies": [
""
],
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "",
"name": "Permission Set",
"resource_name": "",
"resource_type": "",
"resource_type_display_name": "",
"service": "",
"service_name": "",
"session_duration": 3600,
"srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
"state": "ACTIVE"
}
4.1.32 - ShowUser
4.1.32.1 - 1.2
get /v1/users/{user_uuid}
Description
show a specific user
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | user_uuid required | 사용자 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
| query | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | UserResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/users/{user_uuid}?instance_id={instance_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.2"
Example HTTP response
Response 200
{
"user": {
"business_unit": "Business Unit A",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "John Doe",
"department": "Department X",
"description": "Description of John Doe",
"email": "john.doe@example.com",
"email_authenticated": false,
"employee_id": "emp-12345",
"groups": [],
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"instance_id": "ssoins-12345",
"last_login_at": "2024-12-19 01:09:05.000",
"last_password_update_at": "2025-11-24T08:14:51.694996",
"manager": "Alice Smith",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "Smith",
"name": "John Doe",
"nation_id": "+82",
"password": "",
"password_failed_count": 6,
"password_reuse_count": 6,
"phone_authenticated": false,
"phone_number": "010-1234-5678",
"temporary_password": "",
"tz_id": "Asia/Seoul",
"user_id": "johndoe"
}
}
4.1.32.2 - 1.1
get /v1/users/{user_uuid}
Description
show a specific user
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260531 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | user_uuid required | 사용자 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
| query | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | UserResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/users/{user_uuid}?instance_id={instance_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.1"
Example HTTP response
Response 200
{
"user": {
"business_unit": "Business Unit A",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "John Doe",
"department": "Department X",
"description": "Description of John Doe",
"email": "john.doe@example.com",
"email_authenticated": false,
"employee_id": "emp-12345",
"groups": [],
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"instance_id": "ssoins-12345",
"last_login_at": "2024-12-19 01:09:05.000",
"last_password_update_at": "2025-11-24T08:14:51.694996",
"manager": "Alice Smith",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "Smith",
"name": "John Doe",
"nation_id": "+82",
"password": "",
"password_failed_count": 6,
"password_reuse_count": 6,
"phone_authenticated": false,
"phone_number": "010-1234-5678",
"temporary_password": "",
"tz_id": "Asia/Seoul",
"user_id": "johndoe"
}
}
4.1.32.3 - 1.0
get /v1/users/{user_uuid}
Description
show a specific user
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | user_uuid required | 사용자 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
| query | instance_id required | 인스턴스 ID Example : ssoins-12345 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | UserResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/users/{user_uuid}?instance_id={instance_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = iam-identity-center 1.0"
Example HTTP response
Response 200
{
"user": {
"business_unit": "Business Unit A",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"creator_name": "John Doe",
"department": "Department X",
"description": "Description of John Doe",
"email": "john.doe@example.com",
"email_authenticated": false,
"employee_id": "emp-12345",
"groups": [],
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"instance_id": "ssoins-12345",
"last_login_at": "2024-12-19 01:09:05.000",
"last_password_update_at": "2025-11-24T08:14:51.694996",
"manager": "Alice Smith",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"modifier_name": "Smith",
"name": "John Doe",
"nation_id": "+82",
"password": "",
"password_failed_count": 6,
"password_reuse_count": 6,
"phone_authenticated": false,
"phone_number": "010-1234-5678",
"temporary_password": "",
"tz_id": "Asia/Seoul",
"user_id": "johndoe"
}
}
4.2 - Models
4.2.1 - Account
| Name | Description | Schema | Default |
|---|---|---|---|
| target_account_email required | 할당된 계정 이메일 Example : target_account@example.com | string | |
| target_account_id required | 할당된 계정 ID Example : 3265ab469f0d406d83073da3e11e7a6c | string | |
| target_account_name required | 할당된 Account명 Example : target_account@example.com | string |
4.2.2 - AccountAssignment
| Name | Description | Schema | Default |
|---|---|---|---|
| instance_id required | 인스턴스 ID Example : ssoins-12345 | string | |
| permission_sets optional | array[AssignmentPermissionSet] | ||
| principal_id required | 주체 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | |
| principal_name required | 주체 이름 Example : GROUP0407 | string | |
| principal_type required | 주체 유형 Example : USER | enum (USER, GROUP) | |
| role_srn optional | 권한 세트 설명 Example : Permissions for administrators | any of [string, null] | |
| target_account_email required | 할당된 계정 이메일 Example : target_account@example.com | string | |
| target_account_id required | 할당된 계정 ID Example : 3265ab469f0d406d83073da3e11e7a6c | string | |
| target_account_name required | 할당된 Account명 Example : Admin Account | string |
4.2.3 - AccountAssignmentDeleteRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| instance_id required | 인스턴스 ID Example : ssoins-12345 | string | |
| only_user_removed optional | 직접 적용 제외 여부 Example : False | any of [boolean, null] | |
| target_account_id required | 할당된 계정 ID Example : 3265ab469f0d406d83073da3e11e7a6c | string |
4.2.4 - AccountAssignmentsCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| accounts optional | array[Account] | ||
| instance_id required | 인스턴스 ID Example : ssoins-12345 | string | |
| permission_sets optional | array[PermissionSetInfo] | ||
| principals optional | array[Principal] |
4.2.5 - AccountAssignmentsCreateRequestV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| accounts optional | array[Account] | ||
| instance_id required | 인스턴스 ID Example : ssoins-12345 | string | |
| permission_sets optional | array[PermissionSetInfoV1Dot2] | ||
| principals optional | array[Principal] |
4.2.6 - AccountAssignmentsCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_assignment_id optional | 할당 ID Example : b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8 | any of [string, null] | |
| permission_set_id required | 권한 세트 ID Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 | string | |
| principal_id optional | 주체 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | any of [string, null] | |
| principal_type optional | 주체 유형 Example : USER | any of [enum (USER, GROUP), null] | |
| role_srn optional | 권한 세트 설명 Example : Permissions for administrators | any of [string, null] | |
| target_account_id required | 할당된 계정 ID Example : 3265ab469f0d406d83073da3e11e7a6c | string |
4.2.7 - AccountAssignmentsCreateResponseV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| account_assignments required | array[AccountAssignmentSummaryModel] | ||
| count optional | 전체 개수 Example : 20 | any of [integer, null] | |
| links optional | links Example : [{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}] | any of [array[object], null] |
4.2.8 - AccountAssignmentsDeleteRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| account_assignment_ids optional | 할당 ID Example : ['b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8'] | any of [array[string], null] | |
| instance_id required | 인스턴스 ID Example : ssoins-12345 | string | |
| only_user_removed optional | 직접 적용 제외 여부 Example : False | any of [boolean, null] | |
| target_account_id required | 할당된 계정 ID Example : 3265ab469f0d406d83073da3e11e7a6c | string |
4.2.9 - AccountAssignmentsPageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_assignments required | array[AccountAssignment] | ||
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
4.2.10 - AccountAssignmentSummaryModel
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| permission_set_id required | 권한 세트 ID Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 | string | |
| principal_id required | 주체 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | |
| principal_type required | 주체 유형 Example : USER | enum (USER, GROUP) | |
| target_account_id required | 할당된 계정 ID Example : 3265ab469f0d406d83073da3e11e7a6c | string |
4.2.11 - AssignmentPermissionSet
| Name | Description | Schema | Default |
|---|---|---|---|
| account_assignment_id required | 할당 ID Example : b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8 | string | |
| permission_set_id required | 권한 세트 ID Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 | string | |
| permission_set_name required | 권한 세트 이름 Example : Permission Set | string | |
| permission_set_srn required | 권한 세트 SRN Example : srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId} | string |
4.2.12 - Group
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| creator_name required | 생성자 명 Example : John Doe | string | |
| description optional | 그룹 설명 Example : Group for administrators | any of [string, null] | |
| id required | 그룹 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | |
| instance_id required | 인스턴스 ID Example : ssoins-12345 | string | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| modifier_name required | 수정자 명 Example : Smith | string | |
| name required | 그룹 이름 Example : Admin_Group | string |
4.2.13 - GroupCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | 그룹 설명 Example : Group for administrators | any of [string, null] | |
| instance_id required | 인스턴스 ID Example : ssoins-12345 | string | |
| name required | 그룹 이름 Example : Admin_Group | string | |
| user_uuids optional | 그룹에 추가할 사용자 ID 목록 Example : ['138c2fc8c29a449dbfa8681f8f1d78e2'] | any of [array[string], null] |
4.2.14 - GroupDeleteBulkRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| group_ids required | 그룹 ID 목록 Example : ['group-12345', 'group-67890'] | array[string] | |
| instance_id required | 인스턴스 ID Example : ssoins-12345 | string |
4.2.15 - GroupDetail
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| creator_name required | 생성자 명 Example : John Doe | string | |
| description optional | 그룹 설명 Example : Group for administrators | any of [string, null] | |
| id required | 그룹 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | |
| instance_id required | 인스턴스 ID Example : ssoins-12345 | string | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| modifier_name required | 수정자 명 Example : Smith | string | |
| name required | 그룹 이름 Example : Admin_Group | string | |
| user_count optional | 그룹에 속한 사용자 수 Example : 1 | any of [integer, null] | |
| users optional | 그룹에 속한 사용자 목록 Example : [{'id': '6fdd2a6d-6f4f-4157-8259-5d55e7dd1269', 'name': 'John Doe', 'user_id': 'johndoe'}] | any of [array[User], null] |
4.2.16 - GroupPageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| groups required | array[GroupDetail] | ||
| page required | page Example : 0 | integer | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
4.2.17 - GroupRemoveResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| failed_ids required | 실패 사유 | array[RemoveFailCaused] | |
| success_ids required | 성공 ID 목록 | array[RemoveSuccess] |
4.2.18 - GroupSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | 그룹 설명 Example : Group for administrators | any of [string, null] | |
| instance_id required | 인스턴스 ID Example : ssoins-12345 | string | |
| name optional | 그룹 이름 Example : Admin_Group | any of [string, null] |
4.2.19 - GroupSetResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| group required | Group |
4.2.20 - GroupShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| group required | GroupDetail |
4.2.21 - GroupSummary
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | 그룹 이름 Example : Admin_Group | string |
4.2.22 - GroupUser
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| group_count optional | 사용자 속한 그룹 개수 Example : 2 | any of [integer, null] | |
| groups optional | 사용자 속한 그룹 목록 Example : [{'created_at': '2025-07-03T12:05:11', 'created_by': 'a8b5d675f25341cea41eb4cd1979aa95', 'id': '39520424-440c-41c0-9b9c-f22b2129f6f9', 'modified_at': '2025-07-03T12:05:11', 'modified_by': 'a8b5d675f25341cea41eb4cd1979aa95', 'name': 'admin'}, {'created_at': '2025-07-03T12:05:36', 'created_by': 'a8b5d675f25341cea41eb4cd1979aa95', 'id': '80c53fe1-4e27-4cce-92be-151cf0f2873e', 'modified_at': '2025-07-07T05:16:58', 'modified_by': '941e76c4b9424cd9b0ac3a12d5f4335d', 'name': 'test-group'}] | any of [array[GroupSummary], null] | |
| id required | 사용자 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | 사용자 실명 Example : John Doe | string | |
| user_id required | 사용자 로그인 ID Example : johndoe | string |
4.2.23 - GroupUsersPageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] | |
| users required | array[GroupUser] |
4.2.24 - GroupUsersRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| instance_id required | 인스턴스 ID Example : ssoins-12345 | string | |
| user_uuids required | 사용자 ID 목록 Example : ['user-12345', 'user-67890'] | array[string] |
4.2.25 - Instance
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| id required | 인스턴스 ID Example : ssoins-12345 | string | |
| master_account_id required | 관리자 계정 ID Example : acc-12345 | string | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| organization_id required | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | string | |
| region required | Region Example : kr-west1 | string | |
| srn required | 인스턴스 SRN Example : srn:identity-center::prj-01234:kr-west-1::instance/ins-01234 | string | |
| state optional | 상태 Example : ACTIVE | enum (ACTIVE, INACTIVE) | ACTIVE |
4.2.26 - InstanceBaseRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| instance_id required | 인스턴스 ID Example : ssoins-12345 | string |
4.2.27 - InstanceCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | 인스턴스 설명 Example : My Instance Description | any of [string, null] | |
| identity_store_config optional | 자격 증명 소스 설정 Example : {'bind_credential': 'password', 'bind_dn': 'CN=Administrator,CN=Users,DC=test,DC=add', 'connection_url': 'ldaps://test.subdomain.company.com:123', 'rdn_ldap_attribute': 'cn', 'user_object_classes': 'person, organizationalPerson, user', 'username_ldap_attribute': 'sAMAccountName', 'users_dn': 'OU=Employees,OU=Accounts,DC=sub,DC=org'} | any of [LdapConfigCreateRequest, null] | |
| identity_store_type optional | 자격 증명 소스 유형 Example : ACTIVE_DIRECTORY | enum (IDENTITY_CENTER_DIRECTORY, ACTIVE_DIRECTORY) | ACTIVE_DIRECTORY |
| name required | 인스턴스 이름 Example : My Instance | string |
4.2.28 - InstanceDetailAddResourceV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : 1234ab567cd64769e8f9g490hi304891 | any of [string, null] | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| creator_name required | 생성자 명 Example : John Doe | any of [string, null] | |
| delegated_account_id optional | 위임된 관리자 계정 ID Example : acc-2353 | any of [string, null] | |
| delegated_at optional | 위임 일시 Example : 2023-10-15 14:30:00 | any of [string (date-time), null] | |
| delegated_by optional | 위임자 ID Example : sef2w3c8c29a449dbfa8681f8f1d78e2 | any of [string, null] | |
| description optional | 인스턴스 설명 Example : My Instance Description | any of [string, null] | |
| id required | 인스턴스 ID Example : ssoins-12345 | string | |
| identity_store_config optional | 자격 증명 소스 설정 Example : {'bind_credential': 'password', 'bind_dn': 'CN=Administrator,CN=Users,DC=test,DC=add', 'component_id': 'HYIK7LLKQL2MFK2K8Jb1ew', 'connection_url': 'ldaps://test.subdomain.company.com:123', 'rdn_ldap_attribute': 'cn', 'user_object_classes': 'person, organizationalPerson, user', 'username_ldap_attribute': 'sAMAccountName', 'users_dn': 'OU=Employees,OU=Accounts,DC=sub,DC=org'} | any of [LdapConfig, null] | |
| identity_store_id required | 자격 증명 소스 ID Example : d-12345 | string | |
| identity_store_type optional | 자격 증명 소스 유형 Example : ACTIVE_DIRECTORY | enum (IDENTITY_CENTER_DIRECTORY, ACTIVE_DIRECTORY) | ACTIVE_DIRECTORY |
| last_sync_at optional | 마지막 동기화 날짜 Example : 2025-08-06 10:30:00 | any of [string, null] | |
| last_sync_status optional | 마지막 동기화 상태 Example : ['CREATED', 'RUNNING', 'FINISHED', 'FAILED', 'NONE'] | any of [enum (CREATED, RUNNING, FINISHED, FAILED, NONE), null] | |
| master_account_id required | 관리자 계정 ID Example : acc-12345 | string | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| modifier_name required | 수정자 명 Example : Smith | any of [string, null] | |
| name required | 인스턴스 이름 Example : My Instance | string | |
| organization_id required | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | string | |
| region required | Region Example : kr-west1 | string | |
| resource_name required | 자원명 Example : resource-name-1 | any of [string, null] | |
| resource_type required | 자원 유형 [instance | permission-set] Example : virtual-server | any of [string, null] |
| resource_type_display_name required | 자원 유형명 Example : Virtual Server | any of [string, null] | |
| service required | SERVICE Example : virtualserver | any of [string, null] | |
| service_name required | 서비스명 Example : Virtual Server | any of [string, null] | |
| srn required | 인스턴스 SRN Example : srn:identity-center::prj-01234:kr-west-1::instance/ins-01234 | string | |
| sso_start_url required | SSO 시작 URL Example : https://login.e.samsungsdscloud.com/d-12345 | string | |
| state optional | 상태 Example : ACTIVE | enum (ACTIVE, INACTIVE) | ACTIVE |
4.2.29 - InstanceDetailV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| delegated_account_id optional | 위임된 관리자 계정 ID Example : acc-2353 | any of [string, null] | |
| delegated_at optional | 위임 일시 Example : 2023-10-15 14:30:00 | any of [string (date-time), null] | |
| delegated_by optional | 위임자 ID Example : sef2w3c8c29a449dbfa8681f8f1d78e2 | any of [string, null] | |
| description optional | 인스턴스 설명 Example : My Instance Description | any of [string, null] | |
| id required | 인스턴스 ID Example : ssoins-12345 | string | |
| identity_store_config optional | 자격 증명 소스 설정 Example : {'bind_credential': 'password', 'bind_dn': 'CN=Administrator,CN=Users,DC=test,DC=add', 'component_id': 'HYIK7LLKQL2MFK2K8Jb1ew', 'connection_url': 'ldaps://test.subdomain.company.com:123', 'rdn_ldap_attribute': 'cn', 'user_object_classes': 'person, organizationalPerson, user', 'username_ldap_attribute': 'sAMAccountName', 'users_dn': 'OU=Employees,OU=Accounts,DC=sub,DC=org'} | any of [LdapConfig, null] | |
| identity_store_id required | 자격 증명 소스 ID Example : d-12345 | string | |
| identity_store_type optional | 자격 증명 소스 유형 Example : ACTIVE_DIRECTORY | enum (IDENTITY_CENTER_DIRECTORY, ACTIVE_DIRECTORY) | ACTIVE_DIRECTORY |
| last_sync_at optional | 마지막 동기화 날짜 Example : 2025-08-06 10:30:00 | any of [string, null] | |
| last_sync_status optional | 마지막 동기화 상태 Example : ['CREATED', 'RUNNING', 'FINISHED', 'FAILED', 'NONE'] | any of [enum (CREATED, RUNNING, FINISHED, FAILED, NONE), null] | |
| master_account_id required | 관리자 계정 ID Example : acc-12345 | string | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | 인스턴스 이름 Example : My Instance | string | |
| organization_id required | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | string | |
| region required | Region Example : kr-west1 | string | |
| srn required | 인스턴스 SRN Example : srn:identity-center::prj-01234:kr-west-1::instance/ins-01234 | string | |
| sso_start_url required | SSO 시작 URL Example : https://login.e.samsungsdscloud.com/d-12345 | string | |
| state optional | 상태 Example : ACTIVE | enum (ACTIVE, INACTIVE) | ACTIVE |
4.2.30 - InstancePageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| instances optional | array[Instance] | ||
| page required | page Example : 0 | integer | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
4.2.31 - InstanceSetRequest1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | 인스턴스 설명 Example : My Instance Description | any of [string, null] | |
| identity_store_config optional | 자격 증명 소스 설정 Example : {'bind_credential': 'password', 'bind_dn': 'CN=Administrator,CN=Users,DC=test,DC=add', 'component_id': 'HYIK7LLKQL2MFK2K8Jb1ew', 'connection_url': 'ldaps://test.subdomain.company.com:123', 'rdn_ldap_attribute': 'cn', 'user_object_classes': 'person, organizationalPerson, user', 'username_ldap_attribute': 'sAMAccountName', 'users_dn': 'OU=Employees,OU=Accounts,DC=sub,DC=org'} | any of [LdapConfig, null] | |
| identity_store_type optional | 자격 증명 소스 유형 Example : IDENTITY_CENTER_DIRECTORY | any of [enum (IDENTITY_CENTER_DIRECTORY, ACTIVE_DIRECTORY), null] | |
| name optional | 인스턴스 이름 Example : My InstancePattern : ^[a-zA-Z0-9 \+\-\=\,\.\_:/@]*$ | any of [string, null] |
4.2.32 - InstanceShowResponseAddResourceV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| instance required | InstanceDetailAddResourceV1Dot1 |
4.2.33 - InstanceShowResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| instance required | InstanceDetailV1Dot1 |
4.2.34 - LdapConfig
| Name | Description | Schema | Default |
|---|---|---|---|
| bind_credential optional | Bind 비밀번호 Example : passwordMinimum length : 1Maximum length : 128 | string | |
| bind_dn optional | Bind DN Example : CN=Administrator,CN=Users,DC=test,DC=addMinimum length : 1Maximum length : 255 | string | |
| component_id optional | 컴포넌트 ID Example : HYIK7LLKQL2MFK2K8Jb1ew | any of [string, null] | |
| connection_url optional | LDAP 서버 URL Example : ldaps://test.subdomain.company.com:123Minimum length : 1Maximum length : 255 | string | |
| rdn_ldap_attribute optional | RDN LDAP 속성 Example : cnMinimum length : 1Maximum length : 64 | string | |
| user_object_classes optional | 사용자 객체 클래스 Example : person, organizationalPerson, userMinimum length : 1Maximum length : 100 | string | |
| username_ldap_attribute optional | 사용자 이름 LDAP 속성 Example : sAMAccountNameMinimum length : 1Maximum length : 64 | string | |
| users_dn optional | 사용자 DN Example : OU=Employees,OU=Accounts,DC=sub,DC=orgMinimum length : 1Maximum length : 255 | string |
4.2.35 - LdapConfigCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| bind_credential optional | Bind 비밀번호 Example : passwordMinimum length : 1Maximum length : 128 | string | |
| bind_dn optional | Bind DN Example : CN=Administrator,CN=Users,DC=test,DC=addMinimum length : 1Maximum length : 255 | string | |
| connection_url optional | LDAP 서버 URL Example : ldaps://test.subdomain.company.com:123Minimum length : 1Maximum length : 255 | string | |
| rdn_ldap_attribute optional | RDN LDAP 속성 Example : cnMinimum length : 1Maximum length : 64 | string | |
| user_object_classes optional | 사용자 객체 클래스 Example : person, organizationalPerson, userMinimum length : 1Maximum length : 100 | string | |
| username_ldap_attribute optional | 사용자 이름 LDAP 속성 Example : sAMAccountNameMinimum length : 1Maximum length : 64 | string | |
| users_dn optional | 사용자 DN Example : OU=Employees,OU=Accounts,DC=sub,DC=orgMinimum length : 1Maximum length : 255 | string |
4.2.36 - ManagedPolicy
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | 설명 Example : description | any of [string, null] | |
| id required | 정책 ID Example : 37f2e31ff86b415698d7e8eeafab445d | string | |
| name required | 기본 정책명 Example : PolicyName | string |
4.2.37 - PermissionSetCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| customer_policies optional | 고객 관리 정책 | array[string] | |
| description optional | 인스턴스 설명 Example : My Instance Description | any of [string, null] | |
| inline_policies optional | 인라인 정책 | array[object] | |
| instance_id required | 인스턴스 ID Example : ssoins-12345 | string | |
| managed_policies optional | 관리 정책 | array[ManagedPolicy] | |
| name required | 인스턴스 이름 Example : My Instance | string | |
| session_duration required | 최대 세션 지속 시간 Example : 3600 | integer |
4.2.38 - PermissionSetCreateRequestV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| custom_policies optional | 고객 관리 정책 | array[string] | |
| description optional | 인스턴스 설명 Example : My Instance Description | any of [string, null] | |
| inline_policies optional | 인라인 정책 | array[object] | |
| instance_id required | 인스턴스 ID Example : ssoins-12345 | string | |
| managed_policies optional | 관리 정책 | array[ManagedPolicy] | |
| name required | 인스턴스 이름 Example : My Instance | string | |
| session_duration required | 최대 세션 지속 시간 Example : 3600 | integer |
4.2.39 - PermissionSetDetails
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| creator_name required | 생성자 명 Example : | string | |
| customer_policies optional | 고객 관리 정책 | array[string] | |
| description optional | 권한 세트 설명 Example : Permissions for administrators | any of [string, null] | |
| id required | 권한 세트 ID Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 | string | |
| inline_policies optional | 인라인 정책 | array[object] | |
| instance_id required | 인스턴스 ID Example : ssoins-12345 | string | |
| managed_policies optional | 관리 정책 | array[object] | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| modifier_name required | 수정자 명 Example : | string | |
| name required | 권한 세트 이름 Example : Permission Set | string | |
| session_duration required | 최대 세션 지속 시간 Example : 3600 | integer | |
| srn required | 권한 세트 SRN Example : srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId} | string | |
| state optional | 상태 Example : ACTIVE | enum (ACTIVE, INACTIVE) | ACTIVE |
4.2.40 - PermissionSetDetailsPageResponseV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| permission_sets required | array[PermissionSetDetailsV1Dot2] | ||
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
4.2.41 - PermissionSetDetailsV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| creator_name required | 생성자 명 Example : | string | |
| custom_policies optional | 고객 관리 정책 | array[string] | |
| description optional | 권한 세트 설명 Example : Permissions for administrators | any of [string, null] | |
| id required | 권한 세트 ID Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 | string | |
| inline_policies optional | 인라인 정책 | array[object] | |
| instance_id required | 인스턴스 ID Example : ssoins-12345 | string | |
| managed_policies optional | 관리 정책 | array[object] | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| modifier_name required | 수정자 명 Example : | string | |
| name required | 권한 세트 이름 Example : Permission Set | string | |
| session_duration required | 최대 세션 지속 시간 Example : 3600 | integer | |
| srn required | 권한 세트 SRN Example : srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId} | string | |
| state optional | 상태 Example : ACTIVE | enum (ACTIVE, INACTIVE) | ACTIVE |
4.2.42 - PermissionSetInfo
| Name | Description | Schema | Default |
|---|---|---|---|
| customer_policies optional | 고객 관리 정책 | array[string] | |
| inline_policies optional | 인라인 정책 | array[object] | |
| managed_policies optional | 관리 정책 | array[object] | |
| permission_set_id required | 권한 세트 ID Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 | string | |
| permission_set_name required | 권한 세트 이름 Example : Permission Set | string | |
| permission_set_srn required | 권한 세트 SRN Example : srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId} | string | |
| session_duration required | 최대 세션 지속 시간 Example : 3600 | integer |
4.2.43 - PermissionSetInfoV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| custom_policies optional | 고객 관리 정책 | array[string] | |
| inline_policies optional | 인라인 정책 | array[object] | |
| managed_policies optional | 관리 정책 | array[object] | |
| permission_set_id required | 권한 세트 ID Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 | string | |
| permission_set_name required | 권한 세트 이름 Example : Permission Set | string | |
| permission_set_srn required | 권한 세트 SRN Example : srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId} | string | |
| session_duration required | 최대 세션 지속 시간 Example : 3600 | integer |
4.2.44 - PermissionSetPoliciesDeleteRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| instance_id required | 인스턴스 ID Example : ssoins-12345 | string | |
| policy_ids required | array[string] |
4.2.45 - PermissionSetPoliciesPageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| policies optional | array[Policy] | ||
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
4.2.46 - PermissionSetPoliciesPageResponseV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| policies optional | array[PolicyV1Dot2] | ||
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
4.2.47 - PermissionSetPoliciesSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| customer_policies optional | 고객 관리 정책 Example : | any of [array[string], null] | |
| inline_policies optional | 인라인 정책 Example : | any of [array[object], null] | |
| instance_id required | 인스턴스 ID Example : ssoins-12345 | string | |
| managed_policies optional | 관리 정책 Example : | any of [array[object], null] |
4.2.48 - PermissionSetPoliciesSetRequestV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| custom_policies optional | 고객 관리 정책 Example : | any of [array[string], null] | |
| inline_policies optional | 인라인 정책 Example : | any of [array[object], null] | |
| instance_id required | 인스턴스 ID Example : ssoins-12345 | string | |
| managed_policies optional | 관리 정책 Example : | any of [array[object], null] |
4.2.49 - PermissionSets
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| creator_name required | 생성자 명 Example : | string | |
| description optional | 권한 세트 설명 Example : Permissions for administrators | any of [string, null] | |
| id required | 권한 세트 ID Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 | string | |
| instance_id required | 인스턴스 ID Example : ssoins-12345 | string | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| modifier_name required | 수정자 명 Example : | string | |
| name required | 권한 세트 이름 Example : Permission Set | string | |
| state optional | 상태 Example : ACTIVE | enum (ACTIVE, INACTIVE) | ACTIVE |
4.2.50 - PermissionSetSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | 인스턴스 설명 Example : My Instance Description | any of [string, null] | |
| instance_id required | 인스턴스 ID Example : ssoins-12345 | string | |
| session_duration optional | 최대 세션 지속 시간 Example : 3600 | any of [integer, null] |
4.2.51 - PermissionSetsPageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| permission_sets required | array[PermissionSets] | ||
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
4.2.52 - Policy
| Name | Description | Schema | Default |
|---|---|---|---|
| category required | 정책 유형 Example : INLINE_POLICY | enum (MANAGED_POLICY, CUSTOMER_POLICY, INLINE_POLICY) | |
| contents optional | JSON Document Example : | any of [object, array[object], null] | |
| id required | 정책 ID Example : 37f2e31ff86b415698d7e8eeafab445d | string | |
| name optional | 기본 정책명 Example : PolicyName | any of [string, null] | |
| permission_set_id optional | 권한 세트 ID Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 | any of [string, null] |
4.2.53 - PolicyV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| category required | 정책 유형 Example : INLINE_POLICY | enum (MANAGED_POLICY, CUSTOM_POLICY, INLINE_POLICY) | |
| contents optional | JSON Document Example : | any of [object, array[object], null] | |
| id required | 정책 ID Example : 37f2e31ff86b415698d7e8eeafab445d | string | |
| name optional | 기본 정책명 Example : PolicyName | any of [string, null] | |
| permission_set_id optional | 권한 세트 ID Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 | any of [string, null] |
4.2.54 - Principal
| Name | Description | Schema | Default |
|---|---|---|---|
| principal_id required | 주체 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | |
| principal_type required | 주체 유형 Example : USER | enum (USER, GROUP) |
4.2.55 - RemoveFailCaused
| Name | Description | Schema | Default |
|---|---|---|---|
| error_code optional | error code Example : NOT_FOUND | string | - |
| failed_caused optional | 실패 사유 Example : NotFoundError | string | - |
| failed_id optional | ID Example : 7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e | string | - |
| failed_name optional | 이름 Example : | string |
4.2.56 - RemoveSuccess
| Name | Description | Schema | Default |
|---|---|---|---|
| success_id optional | ID Example : 7f8c9d2a1e5b4c7f9a0d3e6b2f4c8d1e | string | - |
| success_name optional | 이름 Example : test | string | - |
4.2.57 - ShowPermissionSetAddResource
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id optional | Example : | any of [string, null] | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| creator_name required | 생성자 명 Example : | string | |
| customer_policies optional | 고객 관리 정책 | array[string] | |
| description optional | 권한 세트 설명 Example : Permissions for administrators | any of [string, null] | |
| id required | 권한 세트 ID Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 | string | |
| inline_policies optional | 인라인 정책 | array[object] | |
| instance_id required | 인스턴스 ID Example : ssoins-12345 | string | |
| managed_policies optional | 관리 정책 | array[object] | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| modifier_name required | 수정자 명 Example : | string | |
| name required | 권한 세트 이름 Example : Permission Set | string | |
| resource_name optional | Example : | any of [string, null] | |
| resource_type optional | Example : | any of [string, null] | |
| resource_type_display_name optional | Example : | any of [string, null] | |
| service optional | Example : | any of [string, null] | |
| service_name optional | Example : | any of [string, null] | |
| session_duration required | 최대 세션 지속 시간 Example : 3600 | integer | |
| srn required | 권한 세트 SRN Example : srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId} | string | |
| state optional | 상태 Example : ACTIVE | enum (ACTIVE, INACTIVE) | ACTIVE |
4.2.58 - ShowPermissionSetAddResourceV1Dot2
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id optional | Example : | any of [string, null] | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| creator_name required | 생성자 명 Example : | string | |
| custom_policies optional | 고객 관리 정책 | array[string] | |
| description optional | 권한 세트 설명 Example : Permissions for administrators | any of [string, null] | |
| id required | 권한 세트 ID Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1 | string | |
| inline_policies optional | 인라인 정책 | array[object] | |
| instance_id required | 인스턴스 ID Example : ssoins-12345 | string | |
| managed_policies optional | 관리 정책 | array[object] | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| modifier_name required | 수정자 명 Example : | string | |
| name required | 권한 세트 이름 Example : Permission Set | string | |
| resource_name optional | Example : | any of [string, null] | |
| resource_type optional | Example : | any of [string, null] | |
| resource_type_display_name optional | Example : | any of [string, null] | |
| service optional | Example : | any of [string, null] | |
| service_name optional | Example : | any of [string, null] | |
| session_duration required | 최대 세션 지속 시간 Example : 3600 | integer | |
| srn required | 권한 세트 SRN Example : srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId} | string | |
| state optional | 상태 Example : ACTIVE | enum (ACTIVE, INACTIVE) | ACTIVE |
4.2.59 - User
| Name | Description | Schema | Default |
|---|---|---|---|
| id required | 사용자 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | |
| name required | 사용자 실명 Example : John Doe | string | |
| user_id required | 사용자 로그인 ID Example : johndoe | string |
4.2.60 - UserCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| business_unit optional | 사업부 Example : Business Unit A | any of [string, null] | |
| department optional | 부서 Example : Department X | any of [string, null] | |
| description optional | 사용자 설명 Example : Description of John Doe | any of [string, null] | |
| email optional | 사용자 이메일 Example : john.doe@example.com | any of [string, null] | |
| employee_id optional | 사번 Example : emp-12345 | any of [string, null] | |
| group_ids optional | 사용자 속한 그룹 목록 Example : ['39520424-440c-41c0-9b9c-f22b2129f6f9', '80c53fe1-4e27-4cce-92be-151cf0f2873e'] | array[string] | |
| instance_id required | 인스턴스 ID Example : ssoins-12345 | string | |
| manager optional | 관리자 Example : Alice Smith | any of [string, null] | |
| name required | 사용자 실명 Example : John Doe | string | |
| nation_id optional | 국가 ID Example : +82 | any of [string, null] | |
| password optional | 비밀번호 Example : | any of [string, null] | |
| phone_number optional | 휴대폰 번호 Example : 010-1234-5678 | any of [string, null] | |
| temporary_password optional | 임시 비밀번호 여부 Example : True | boolean | True |
| user_id required | 사용자 로그인 ID Example : johndoe | string |
4.2.61 - UserDeleteBulkRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| instance_id required | 인스턴스 ID Example : ssoins-12345 | string | |
| user_uuids required | 사용자 ID 목록 Example : ['user-12345', 'user-67890'] | array[string] |
4.2.62 - UserDetail
| Name | Description | Schema | Default |
|---|---|---|---|
| business_unit optional | 사업부 Example : Business Unit A | any of [string, null] | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| creator_name optional | 생성자 명 Example : John Doe | string | - |
| department optional | 부서 Example : Department X | any of [string, null] | |
| description optional | 사용자 설명 Example : Description of John Doe | any of [string, null] | |
| email optional | 사용자 이메일 Example : john.doe@example.com | any of [string, null] | |
| email_authenticated optional | 이메일 인증 여부 Example : False | boolean | |
| employee_id optional | 사번 Example : emp-12345 | any of [string, null] | |
| groups optional | 그룹 목록 | any of [array[Group], null] | |
| id required | 사용자 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | |
| instance_id required | 인스턴스 ID Example : ssoins-12345 | string | |
| last_login_at optional | 마지막 로그인 일시 Example : 2024-12-19 01:09:05.000 | any of [string (date-time), null] | |
| last_password_update_at optional | 최근 비밀번호 변경 일시 Example : 2025-11-24T08:14:51.694996 | any of [string (date-time), null] | |
| manager optional | 관리자 Example : Alice Smith | any of [string, null] | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| modifier_name optional | 수정자 명 Example : Smith | string | - |
| name required | 사용자 실명 Example : John Doe | string | |
| nation_id optional | 국가 ID Example : +82 | any of [string, null] | |
| password optional | 비밀번호 Example : | any of [string, null] | |
| password_failed_count optional | 비밀번호 실패 횟수 Example : 6 | any of [integer, null] | |
| password_reuse_count optional | 비밀번호 재사용 제한 횟수 Example : 6 | any of [integer, null] | |
| phone_authenticated optional | 휴대폰 인증 여부 Example : False | boolean | |
| phone_number optional | 휴대폰 번호 Example : 010-1234-5678 | any of [string, null] | |
| temporary_password required | 임시 비밀번호 여부 Example : | boolean | |
| tz_id optional | 타임존 ID Example : Asia/Seoul | any of [string, null] | |
| user_id required | 사용자 로그인 ID Example : johndoe | string |
4.2.63 - UserPageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] | |
| users required | array[User] |
4.2.64 - UserRemoveResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| failed_ids required | 실패 사유 | array[RemoveFailCaused] | |
| success_ids required | 성공 ID 목록 | array[RemoveSuccess] |
4.2.65 - UserResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| user required | UserDetail |
4.2.66 - UserSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| business_unit optional | 사업부 Example : Business Unit A | any of [string, null] | |
| department optional | 부서 Example : Department X | any of [string, null] | |
| description optional | 사용자 설명 Example : Description of John Doe | any of [string, null] | |
| email optional | 사용자 이메일 Example : john.doe@example.com | any of [string, null] | |
| employee_id optional | 사번 Example : emp-12345 | any of [string, null] | |
| instance_id required | 인스턴스 ID Example : ssoins-12345 | string | |
| manager optional | 관리자 Example : Alice Smith | any of [string, null] | |
| name optional | 사용자 실명 Example : John Doe | any of [string, null] | |
| nation_id optional | 국가 ID Example : +82 | any of [string, null] | |
| phone_number optional | 휴대폰 번호 Example : 010-1234-5678 | any of [string, null] | |
| tz_id optional | 타임존 ID Example : Asia/Seoul | any of [string, null] |
5 - Logging&Audit
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.
본 가이드는 Logging&Audit 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | DEPRECATED | 20260223 |
| 1.1 | CURRENT | - |
OpenAPI URL
https://loggingaudit.{region}.{environment}.samsungsdscloud.com
Environment and Region List
| environment | region |
|---|---|
| s | kr-west1 |
| s | kr-east1 |
| g | kr-south1 |
| g | kr-south2 |
| g | kr-south3 |
| e | kr-west1 |
| e | kr-east1 |
5.1 - APIs
5.1.1 - CreateTrail
5.1.1.1 - 1.1
post /v1/trails
Description
create a trail
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | TrailCreateRequestV1dot1 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | TrailShowResponseV1dot1 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/trails
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loggingaudit 1.1"
Request body
{
"account_id": "ACCOUNT_ID-ABCDEF1234",
"bucket_name": "TestBucket00",
"bucket_region": "RegionOne",
"log_archive_account_id": "ACCOUNT_ID-ABCDEF1234",
"log_type_total_yn": "N",
"log_verification_yn": "N",
"organization_trail_yn": "N",
"region_names": [],
"region_total_yn": "Y",
"resource_type_total_yn": "Y",
"tag_create_requests": [
{
"key": "11",
"value": "22"
}
],
"target_log_types": [],
"target_resource_types": [],
"target_users": [],
"trail_description": "This is a test trail",
"trail_name": "TestTrail01",
"trail_save_type": "JSON",
"user_total_yn": "Y"
}
Example HTTP response
Response 201
{
"trail": {
"account_id": "ACCOUNT_ID-ABCDEF1234",
"account_name": "Test Account",
"bucket_name": "Bucket001",
"bucket_region": "RegionOne",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"created_user_id": "kim.samsung@samsung.com",
"del_yn": "N",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"log_archive_account_id": "ACCOUNT_ID-ABCDEF1234",
"log_type_total_yn": "Y",
"log_verification_yn": "N",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"organization_trail_yn": "Y",
"region_names": [],
"region_total_yn": "Y",
"resource_type_total_yn": "Y",
"state": "ACTIVE",
"target_log_types": [],
"target_resource_types": [],
"target_users": [],
"trail_batch_end_at": "2025-11-07T09:00:00Z",
"trail_batch_first_start_at": "2025-10-28T10:00:00Z",
"trail_batch_last_state": "success",
"trail_batch_start_at": "2025-11-07T09:00:00Z",
"trail_batch_success_at": "2025-11-07T09:00:00Z",
"trail_description": "test trail",
"trail_name": "Trail-0001",
"trail_save_type": "JSON",
"user_total_yn": "Y"
}
}
5.1.1.2 - 1.0
post /v1/trails
Description
create a trail
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | TrailCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | TrailShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/trails
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loggingaudit 1.0"
Request body
{
"account_id": "ACCOUNT_ID-ABCDEF1234",
"bucket_name": "TestBucket00",
"bucket_region": "RegionOne",
"log_type_total_yn": "N",
"log_verification_yn": "N",
"region_names": [],
"region_total_yn": "Y",
"resource_type_total_yn": "Y",
"tag_create_requests": [
{
"key": "11",
"value": "22"
}
],
"target_log_types": [],
"target_resource_types": [],
"target_users": [],
"trail_description": "This is a test trail",
"trail_name": "TestTrail01",
"trail_save_type": "JSON",
"user_total_yn": "Y"
}
Example HTTP response
Response 201
{
"trail": {
"account_id": "ACCOUNT_ID-ABCDEF1234",
"account_name": "Test Account",
"bucket_name": "Bucket001",
"bucket_region": "RegionOne",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"created_user_id": "kim.samsung@samsung.com",
"del_yn": "N",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"log_type_total_yn": "Y",
"log_verification_yn": "N",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"region_names": [],
"region_total_yn": "Y",
"resource_type_total_yn": "Y",
"state": "ACTIVE",
"target_log_types": [],
"target_resource_types": [],
"target_users": [],
"trail_batch_end_at": "2025-11-07T09:00:00Z",
"trail_batch_first_start_at": "2025-10-28T10:00:00Z",
"trail_batch_last_state": "success",
"trail_batch_start_at": "2025-11-07T09:00:00Z",
"trail_batch_success_at": "2025-11-07T09:00:00Z",
"trail_description": "test trail",
"trail_name": "Trail-0001",
"trail_save_type": "JSON",
"user_total_yn": "Y"
}
}
5.1.2 - DeleteTrail
5.1.2.1 - 1.1
delete /v1/trails/{trail_id}
Description
delete a specific trail
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | trail_id required | Trail ID Example : | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/trails/{trail_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loggingaudit 1.1"
Example HTTP response
Response 202
5.1.2.2 - 1.0
delete /v1/trails/{trail_id}
Description
delete a specific trail
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | trail_id required | Trail ID Example : | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 204 | No Content | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/trails/{trail_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loggingaudit 1.0"
Example HTTP response
Response 202
5.1.3 - DownloadLogs
5.1.3.1 - 1.1
post /v1/logs/download
Description
download log file
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | LogDownloadRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | LogDownloadResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/logs/download
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loggingaudit 1.1"
Request body
{
"end_at": "2025-11-07T10:00:00Z",
"file_type": "JSON",
"product_name": "",
"region": "",
"resource_name": "",
"resource_type": "",
"root_resource_id": "",
"start_at": "2025-08-09T10:00:00Z",
"status": "",
"time_zone_info": "Asia/Seoul",
"user_name": ""
}
Example HTTP response
Response 200
{
"file": [
{
"EventTopic": "",
"RegionName": "",
"ResourceId": "",
"ResourceName": "",
"ResourceType": "",
"WorkInfo": "",
"WorkResult": "",
"WorkTime": "",
"WorkerEmail": "",
"WorkerID": "",
"WorkerName": ""
}
]
}
5.1.3.2 - 1.0
post /v1/logs/download
Description
download log file
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | LogDownloadRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | LogDownloadResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/logs/download
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loggingaudit 1.0"
Request body
{
"end_at": "2025-11-07T10:00:00Z",
"file_type": "JSON",
"product_name": "",
"region": "",
"resource_name": "",
"resource_type": "",
"root_resource_id": "",
"start_at": "2025-08-09T10:00:00Z",
"status": "",
"time_zone_info": "Asia/Seoul",
"user_name": ""
}
Example HTTP response
Response 200
{
"file": [
{
"EventTopic": "",
"RegionName": "",
"ResourceId": "",
"ResourceName": "",
"ResourceType": "",
"WorkInfo": "",
"WorkResult": "",
"WorkTime": "",
"WorkerEmail": "",
"WorkerID": "",
"WorkerName": ""
}
]
}
5.1.4 - ListLogs
5.1.4.1 - 1.1
get /v1/logs
Description
get log list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | start_at required | Query start date Example : 2025-08-09T10:00:00Z | any of [string, null] | None |
| query | end_at required | Query finish date Example : 2025-11-07T10:00:00Z | any of [string, null] | None |
| query | resource_id optional | Resource ID Example : | any of [string, null] | None |
| query | resource_name optional | Resource name Example : | any of [string, null] | None |
| query | resource_type optional | Resource type Example : | any of [string, null] | None |
| query | product_name optional | Product name Example : | any of [string, null] | None |
| query | product_type optional | Product type Example : | any of [string, null] | None |
| query | status optional | Task result Example : | any of [string, null] | None |
| query | event_type optional | Event type Example : | any of [string, null] | None |
| query | user_id optional | User ID Example : | any of [string, null] | None |
| query | user_name optional | Username Example : | any of [string, null] | None |
| query | region optional | Region name Example : | any of [string, null] | None |
| query | root_resource_id optional | Root resource ID Example : | any of [string, null] | None |
| query | service_type optional | Service type Example : | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | LogListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/logs?start_at={start_at}&end_at={end_at}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loggingaudit 1.1"
Example HTTP response
Response 200
{
"count": 20,
"logs": [
{
"account_id": "ACCOUNT_ID-ABCDEF1234",
"event_name": "scp-extension.event.create",
"event_type": "scp-extension.event.create",
"id": "ID-A1B2C3D4E5F6G7H8I9J0",
"product_name": "scp-extension",
"product_type": "scp-extension",
"region": "RegionOne",
"request_user_name": "Hong Gildong",
"resource_id": "RESOURCE_ID-ABCDEF1234",
"resource_name": "RESOURCE_NAME-ABCDEF1234",
"resource_type": "scp-extension",
"role_name": "Tester",
"status": "Success",
"timestamp": "2025-11-07T10:00:00Z",
"type": "ROLE",
"user_id": "USER_ID-ABCDEF1234"
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
5.1.4.2 - 1.0
get /v1/logs
Description
get log list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | start_at required | Query start date Example : 2025-08-09T10:00:00Z | any of [string, null] | None |
| query | end_at required | Query finish date Example : 2025-11-07T10:00:00Z | any of [string, null] | None |
| query | resource_id optional | Resource ID Example : | any of [string, null] | None |
| query | resource_name optional | Resource name Example : | any of [string, null] | None |
| query | resource_type optional | Resource type Example : | any of [string, null] | None |
| query | product_name optional | Product name Example : | any of [string, null] | None |
| query | product_type optional | Product type Example : | any of [string, null] | None |
| query | status optional | Task result Example : | any of [string, null] | None |
| query | event_type optional | Event type Example : | any of [string, null] | None |
| query | user_id optional | User ID Example : | any of [string, null] | None |
| query | user_name optional | Username Example : | any of [string, null] | None |
| query | region optional | Region name Example : | any of [string, null] | None |
| query | root_resource_id optional | Root resource ID Example : | any of [string, null] | None |
| query | service_type optional | Service type Example : | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | LogListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/logs?start_at={start_at}&end_at={end_at}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loggingaudit 1.0"
Example HTTP response
Response 200
{
"count": 20,
"logs": [
{
"account_id": "ACCOUNT_ID-ABCDEF1234",
"event_name": "scp-extension.event.create",
"event_type": "scp-extension.event.create",
"id": "ID-A1B2C3D4E5F6G7H8I9J0",
"product_name": "scp-extension",
"product_type": "scp-extension",
"region": "RegionOne",
"request_user_name": "Hong Gildong",
"resource_id": "RESOURCE_ID-ABCDEF1234",
"resource_name": "RESOURCE_NAME-ABCDEF1234",
"resource_type": "scp-extension",
"role_name": "Tester",
"status": "Success",
"timestamp": "2025-11-07T10:00:00Z",
"type": "ROLE",
"user_id": "USER_ID-ABCDEF1234"
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
5.1.5 - ListTrails
5.1.5.1 - 1.1
get /v1/trails
Description
get trails list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | trail_name optional | Trail name Example : | any of [string, null] | None |
| query | bucket_name optional | Bucket name Example : | any of [string, null] | None |
| query | state optional | Trail state Example : | any of [string, null] | None |
| query | resource_type optional | Resource type Example : | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TrailListResponseV1dot1 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/trails
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loggingaudit 1.1"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
],
"trails": [
{
"account_id": "ACCOUNT_ID-ABCDEF1234",
"account_name": "Test Account",
"bucket_name": "Bucket001",
"bucket_region": "RegionOne",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"created_user_id": "kim.samsung@samsung.com",
"del_yn": "N",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"log_archive_account_id": "ACCOUNT_ID-ABCDEF1234",
"log_type_total_yn": "Y",
"log_verification_yn": "N",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"organization_trail_yn": "Y",
"region_names": [],
"region_total_yn": "Y",
"resource_type_total_yn": "Y",
"state": "ACTIVE",
"target_log_types": [],
"target_resource_types": [],
"target_users": [],
"trail_batch_end_at": "2025-11-07T09:00:00Z",
"trail_batch_first_start_at": "2025-10-28T10:00:00Z",
"trail_batch_last_state": "success",
"trail_batch_start_at": "2025-11-07T09:00:00Z",
"trail_batch_success_at": "2025-11-07T09:00:00Z",
"trail_description": "test trail",
"trail_name": "Trail-0001",
"trail_save_type": "JSON",
"user_total_yn": "Y"
}
]
}
5.1.5.2 - 1.0
get /v1/trails
Description
get trails list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | trail_name optional | Trail name Example : | any of [string, null] | None |
| query | bucket_name optional | Bucket name Example : | any of [string, null] | None |
| query | state optional | Trail state Example : | any of [string, null] | None |
| query | resource_type optional | Resource type Example : | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TrailListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/trails
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loggingaudit 1.0"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
],
"trails": [
{
"account_id": "ACCOUNT_ID-ABCDEF1234",
"account_name": "Test Account",
"bucket_name": "Bucket001",
"bucket_region": "RegionOne",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"created_user_id": "kim.samsung@samsung.com",
"del_yn": "N",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"log_type_total_yn": "Y",
"log_verification_yn": "N",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"region_names": [],
"region_total_yn": "Y",
"resource_type_total_yn": "Y",
"state": "ACTIVE",
"target_log_types": [],
"target_resource_types": [],
"target_users": [],
"trail_batch_end_at": "2025-11-07T09:00:00Z",
"trail_batch_first_start_at": "2025-10-28T10:00:00Z",
"trail_batch_last_state": "success",
"trail_batch_start_at": "2025-11-07T09:00:00Z",
"trail_batch_success_at": "2025-11-07T09:00:00Z",
"trail_description": "test trail",
"trail_name": "Trail-0001",
"trail_save_type": "JSON",
"user_total_yn": "Y"
}
]
}
5.1.6 - SetTrail
5.1.6.1 - 1.1
put /v1/trails/{trail_id}
Description
set a specific trail
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | trail_id required | Trail ID Example : | any of [string, null] | None |
| body | body required | TrailSetRequestV1dot1 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | TrailShowResponseV1dot1 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/trails/{trail_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loggingaudit 1.1"
Request body
{
"log_type_total_yn": "N",
"log_verification_yn": "N",
"organization_trail_yn": "Y",
"region_names": [],
"region_total_yn": "Y",
"resource_type_total_yn": "Y",
"target_log_types": [],
"target_resource_types": [],
"target_users": [],
"trail_description": "This is a test trail",
"trail_save_type": "JSON",
"user_total_yn": "Y"
}
Example HTTP response
Response 202
{
"trail": {
"account_id": "ACCOUNT_ID-ABCDEF1234",
"account_name": "Test Account",
"bucket_name": "Bucket001",
"bucket_region": "RegionOne",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"created_user_id": "kim.samsung@samsung.com",
"del_yn": "N",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"log_archive_account_id": "ACCOUNT_ID-ABCDEF1234",
"log_type_total_yn": "Y",
"log_verification_yn": "N",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"organization_trail_yn": "Y",
"region_names": [],
"region_total_yn": "Y",
"resource_type_total_yn": "Y",
"state": "ACTIVE",
"target_log_types": [],
"target_resource_types": [],
"target_users": [],
"trail_batch_end_at": "2025-11-07T09:00:00Z",
"trail_batch_first_start_at": "2025-10-28T10:00:00Z",
"trail_batch_last_state": "success",
"trail_batch_start_at": "2025-11-07T09:00:00Z",
"trail_batch_success_at": "2025-11-07T09:00:00Z",
"trail_description": "test trail",
"trail_name": "Trail-0001",
"trail_save_type": "JSON",
"user_total_yn": "Y"
}
}
5.1.6.2 - 1.0
put /v1/trails/{trail_id}
Description
set a specific trail
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | trail_id required | Trail ID Example : | any of [string, null] | None |
| body | body required | TrailSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | TrailShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/trails/{trail_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loggingaudit 1.0"
Request body
{
"log_type_total_yn": "N",
"log_verification_yn": "N",
"region_names": [],
"region_total_yn": "Y",
"resource_type_total_yn": "Y",
"target_log_types": [],
"target_resource_types": [],
"target_users": [],
"trail_description": "This is a test trail",
"trail_save_type": "JSON",
"user_total_yn": "Y"
}
Example HTTP response
Response 202
{
"trail": {
"account_id": "ACCOUNT_ID-ABCDEF1234",
"account_name": "Test Account",
"bucket_name": "Bucket001",
"bucket_region": "RegionOne",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"created_user_id": "kim.samsung@samsung.com",
"del_yn": "N",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"log_type_total_yn": "Y",
"log_verification_yn": "N",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"region_names": [],
"region_total_yn": "Y",
"resource_type_total_yn": "Y",
"state": "ACTIVE",
"target_log_types": [],
"target_resource_types": [],
"target_users": [],
"trail_batch_end_at": "2025-11-07T09:00:00Z",
"trail_batch_first_start_at": "2025-10-28T10:00:00Z",
"trail_batch_last_state": "success",
"trail_batch_start_at": "2025-11-07T09:00:00Z",
"trail_batch_success_at": "2025-11-07T09:00:00Z",
"trail_description": "test trail",
"trail_name": "Trail-0001",
"trail_save_type": "JSON",
"user_total_yn": "Y"
}
}
5.1.7 - ShowLog
5.1.7.1 - 1.1
get /v1/logs/{logging_id}
Description
show a specific log
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | logging_id required | Log ID Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | LogShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/logs/{logging_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loggingaudit 1.1"
Example HTTP response
Response 200
{
"log": {
"account_id": "ACCOUNT_ID-ABCDEF1234",
"details": "",
"event_name": "scp-extension.event.create",
"event_type": "scp-extension.event.create",
"id": "ID-A1B2C3D4E5F6G7H8I9J0",
"product_name": "scp-extension",
"product_type": "scp-extension",
"region": "RegionOne",
"request_user_name": "Hong Gildong",
"resource_id": "RESOURCE_ID-ABCDEF1234",
"resource_name": "RESOURCE_NAME-ABCDEF1234",
"resource_type": "scp-extension",
"role_name": "Tester",
"status": "Success",
"timestamp": "2025-11-07T10:00:00Z",
"type": "ROLE",
"user_id": "USER_ID-ABCDEF1234"
}
}
5.1.7.2 - 1.0
get /v1/logs/{logging_id}
Description
show a specific log
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | logging_id required | Log ID Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | LogShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/logs/{logging_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loggingaudit 1.0"
Example HTTP response
Response 200
{
"log": {
"account_id": "ACCOUNT_ID-ABCDEF1234",
"details": "",
"event_name": "scp-extension.event.create",
"event_type": "scp-extension.event.create",
"id": "ID-A1B2C3D4E5F6G7H8I9J0",
"product_name": "scp-extension",
"product_type": "scp-extension",
"region": "RegionOne",
"request_user_name": "Hong Gildong",
"resource_id": "RESOURCE_ID-ABCDEF1234",
"resource_name": "RESOURCE_NAME-ABCDEF1234",
"resource_type": "scp-extension",
"role_name": "Tester",
"status": "Success",
"timestamp": "2025-11-07T10:00:00Z",
"type": "ROLE",
"user_id": "USER_ID-ABCDEF1234"
}
}
5.1.8 - ShowTrail
5.1.8.1 - 1.1
get /v1/trails/{trail_id}
Description
show a specific trail
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | trail_id required | Trail ID Example : | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TrailShowResponseV1dot1 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/trails/{trail_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loggingaudit 1.1"
Example HTTP response
Response 200
{
"trail": {
"account_id": "ACCOUNT_ID-ABCDEF1234",
"account_name": "Test Account",
"bucket_name": "Bucket001",
"bucket_region": "RegionOne",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"created_user_id": "kim.samsung@samsung.com",
"del_yn": "N",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"log_archive_account_id": "ACCOUNT_ID-ABCDEF1234",
"log_type_total_yn": "Y",
"log_verification_yn": "N",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"organization_trail_yn": "Y",
"region_names": [],
"region_total_yn": "Y",
"resource_type_total_yn": "Y",
"state": "ACTIVE",
"target_log_types": [],
"target_resource_types": [],
"target_users": [],
"trail_batch_end_at": "2025-11-07T09:00:00Z",
"trail_batch_first_start_at": "2025-10-28T10:00:00Z",
"trail_batch_last_state": "success",
"trail_batch_start_at": "2025-11-07T09:00:00Z",
"trail_batch_success_at": "2025-11-07T09:00:00Z",
"trail_description": "test trail",
"trail_name": "Trail-0001",
"trail_save_type": "JSON",
"user_total_yn": "Y"
}
}
5.1.8.2 - 1.0
get /v1/trails/{trail_id}
Description
show a specific trail
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | trail_id required | Trail ID Example : | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TrailShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/trails/{trail_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loggingaudit 1.0"
Example HTTP response
Response 200
{
"trail": {
"account_id": "ACCOUNT_ID-ABCDEF1234",
"account_name": "Test Account",
"bucket_name": "Bucket001",
"bucket_region": "RegionOne",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"created_user_id": "kim.samsung@samsung.com",
"del_yn": "N",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"log_type_total_yn": "Y",
"log_verification_yn": "N",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"region_names": [],
"region_total_yn": "Y",
"resource_type_total_yn": "Y",
"state": "ACTIVE",
"target_log_types": [],
"target_resource_types": [],
"target_users": [],
"trail_batch_end_at": "2025-11-07T09:00:00Z",
"trail_batch_first_start_at": "2025-10-28T10:00:00Z",
"trail_batch_last_state": "success",
"trail_batch_start_at": "2025-11-07T09:00:00Z",
"trail_batch_success_at": "2025-11-07T09:00:00Z",
"trail_description": "test trail",
"trail_name": "Trail-0001",
"trail_save_type": "JSON",
"user_total_yn": "Y"
}
}
5.1.9 - StartTrail
5.1.9.1 - 1.1
post /v1/trails/{trail_id}/start
Description
start a specific trail
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | trail_id required | Trail ID Example : | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TrailShowResponseV1dot1 |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/trails/{trail_id}/start
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loggingaudit 1.1"
Example HTTP response
Response 200
{
"trail": {
"account_id": "ACCOUNT_ID-ABCDEF1234",
"account_name": "Test Account",
"bucket_name": "Bucket001",
"bucket_region": "RegionOne",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"created_user_id": "kim.samsung@samsung.com",
"del_yn": "N",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"log_archive_account_id": "ACCOUNT_ID-ABCDEF1234",
"log_type_total_yn": "Y",
"log_verification_yn": "N",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"organization_trail_yn": "Y",
"region_names": [],
"region_total_yn": "Y",
"resource_type_total_yn": "Y",
"state": "ACTIVE",
"target_log_types": [],
"target_resource_types": [],
"target_users": [],
"trail_batch_end_at": "2025-11-07T09:00:00Z",
"trail_batch_first_start_at": "2025-10-28T10:00:00Z",
"trail_batch_last_state": "success",
"trail_batch_start_at": "2025-11-07T09:00:00Z",
"trail_batch_success_at": "2025-11-07T09:00:00Z",
"trail_description": "test trail",
"trail_name": "Trail-0001",
"trail_save_type": "JSON",
"user_total_yn": "Y"
}
}
5.1.9.2 - 1.0
post /v1/trails/{trail_id}/start
Description
start a specific trail
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | trail_id required | Trail ID Example : | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TrailShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/trails/{trail_id}/start
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loggingaudit 1.0"
Example HTTP response
Response 200
{
"trail": {
"account_id": "ACCOUNT_ID-ABCDEF1234",
"account_name": "Test Account",
"bucket_name": "Bucket001",
"bucket_region": "RegionOne",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"created_user_id": "kim.samsung@samsung.com",
"del_yn": "N",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"log_type_total_yn": "Y",
"log_verification_yn": "N",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"region_names": [],
"region_total_yn": "Y",
"resource_type_total_yn": "Y",
"state": "ACTIVE",
"target_log_types": [],
"target_resource_types": [],
"target_users": [],
"trail_batch_end_at": "2025-11-07T09:00:00Z",
"trail_batch_first_start_at": "2025-10-28T10:00:00Z",
"trail_batch_last_state": "success",
"trail_batch_start_at": "2025-11-07T09:00:00Z",
"trail_batch_success_at": "2025-11-07T09:00:00Z",
"trail_description": "test trail",
"trail_name": "Trail-0001",
"trail_save_type": "JSON",
"user_total_yn": "Y"
}
}
5.1.10 - StopTrail
5.1.10.1 - 1.1
post /v1/trails/{trail_id}/stop
Description
stop a specific trail
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | trail_id required | Trail ID Example : | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TrailShowResponseV1dot1 |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/trails/{trail_id}/stop
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loggingaudit 1.1"
Example HTTP response
Response 200
{
"trail": {
"account_id": "ACCOUNT_ID-ABCDEF1234",
"account_name": "Test Account",
"bucket_name": "Bucket001",
"bucket_region": "RegionOne",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"created_user_id": "kim.samsung@samsung.com",
"del_yn": "N",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"log_archive_account_id": "ACCOUNT_ID-ABCDEF1234",
"log_type_total_yn": "Y",
"log_verification_yn": "N",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"organization_trail_yn": "Y",
"region_names": [],
"region_total_yn": "Y",
"resource_type_total_yn": "Y",
"state": "ACTIVE",
"target_log_types": [],
"target_resource_types": [],
"target_users": [],
"trail_batch_end_at": "2025-11-07T09:00:00Z",
"trail_batch_first_start_at": "2025-10-28T10:00:00Z",
"trail_batch_last_state": "success",
"trail_batch_start_at": "2025-11-07T09:00:00Z",
"trail_batch_success_at": "2025-11-07T09:00:00Z",
"trail_description": "test trail",
"trail_name": "Trail-0001",
"trail_save_type": "JSON",
"user_total_yn": "Y"
}
}
5.1.10.2 - 1.0
post /v1/trails/{trail_id}/stop
Description
stop a specific trail
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | trail_id required | Trail ID Example : | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TrailShowResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/trails/{trail_id}/stop
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = loggingaudit 1.0"
Example HTTP response
Response 200
{
"trail": {
"account_id": "ACCOUNT_ID-ABCDEF1234",
"account_name": "Test Account",
"bucket_name": "Bucket001",
"bucket_region": "RegionOne",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"created_user_id": "kim.samsung@samsung.com",
"del_yn": "N",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"log_type_total_yn": "Y",
"log_verification_yn": "N",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"region_names": [],
"region_total_yn": "Y",
"resource_type_total_yn": "Y",
"state": "ACTIVE",
"target_log_types": [],
"target_resource_types": [],
"target_users": [],
"trail_batch_end_at": "2025-11-07T09:00:00Z",
"trail_batch_first_start_at": "2025-10-28T10:00:00Z",
"trail_batch_last_state": "success",
"trail_batch_start_at": "2025-11-07T09:00:00Z",
"trail_batch_success_at": "2025-11-07T09:00:00Z",
"trail_description": "test trail",
"trail_name": "Trail-0001",
"trail_save_type": "JSON",
"user_total_yn": "Y"
}
}
5.2 - Models
5.2.1 - Log
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id optional | Account ID Example : ACCOUNT_ID-ABCDEF1234 | any of [string, null] | |
| event_name optional | Event name Example : scp-extension.event.create | any of [string, null] | |
| event_type optional | Event type Example : scp-extension.event.create | any of [string, null] | |
| id optional | Log ID Example : ID-A1B2C3D4E5F6G7H8I9J0 | any of [string, null] | |
| product_name optional | Product name Example : scp-extension | any of [string, null] | |
| product_type optional | Product type Example : scp-extension | any of [string, null] | |
| region optional | Region name Example : RegionOne | any of [string, null] | |
| request_user_name optional | Username Example : Hong Gildong | any of [string, null] | |
| resource_id optional | Resource ID Example : RESOURCE_ID-ABCDEF1234 | any of [string, null] | |
| resource_name optional | Resource name Example : RESOURCE_NAME-ABCDEF1234 | any of [string, null] | |
| resource_type optional | Resource type Example : scp-extension | any of [string, null] | |
| role_name optional | Username Example : Tester | any of [string, null] | |
| status optional | Task result Example : Success | any of [string, null] | |
| timestamp optional | Timestamp Example : 2025-11-07T10:00:00Z | any of [string, null] | |
| type optional | User ID Example : ROLE | any of [string, null] | |
| user_id optional | User ID Example : USER_ID-ABCDEF1234 | any of [string, null] |
5.2.2 - LogDetails
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id optional | Account ID Example : ACCOUNT_ID-ABCDEF1234 | any of [string, null] | |
| details optional | Audit detail contents(JSON String) Example : | any of [object, null] | |
| event_name optional | Event name Example : scp-extension.event.create | any of [string, null] | |
| event_type optional | Event type Example : scp-extension.event.create | any of [string, null] | |
| id optional | Log ID Example : ID-A1B2C3D4E5F6G7H8I9J0 | any of [string, null] | |
| product_name optional | Product name Example : scp-extension | any of [string, null] | |
| product_type optional | Product type Example : scp-extension | any of [string, null] | |
| region optional | Region name Example : RegionOne | any of [string, null] | |
| request_user_name optional | Username Example : Hong Gildong | any of [string, null] | |
| resource_id optional | Resource ID Example : RESOURCE_ID-ABCDEF1234 | any of [string, null] | |
| resource_name optional | Resource name Example : RESOURCE_NAME-ABCDEF1234 | any of [string, null] | |
| resource_type optional | Resource type Example : scp-extension | any of [string, null] | |
| role_name optional | Username Example : Tester | any of [string, null] | |
| status optional | Task result Example : Success | any of [string, null] | |
| timestamp optional | Timestamp Example : 2025-11-07T10:00:00Z | any of [string, null] | |
| type optional | User ID Example : ROLE | any of [string, null] | |
| user_id optional | User ID Example : USER_ID-ABCDEF1234 | any of [string, null] |
5.2.3 - LogDownloadDetailResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| EventTopic optional | Event type Example : | any of [string, null] | |
| RegionName optional | Region name Example : | any of [string, null] | |
| ResourceId optional | Resource ID Example : | any of [string, null] | |
| ResourceName optional | Resource name Example : | any of [string, null] | |
| ResourceType optional | Resource type Example : | any of [string, null] | |
| WorkInfo optional | Event name Example : | any of [string, null] | |
| WorkResult optional | Task result Example : | any of [string, null] | |
| WorkTime optional | Work time Example : | any of [string, null] | |
| WorkerEmail optional | Worker email Example : | any of [string, null] | |
| WorkerID optional | Worker ID Example : | any of [string, null] | |
| WorkerName optional | Worker name Example : | any of [string, null] |
5.2.4 - LogDownloadRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| end_at required | Query finish date Example : 2025-11-07T10:00:00Z | string | |
| file_type required | Download file type Example : JSON | string | |
| product_name optional | Product name Example : | any of [string, null] | |
| region optional | Region name Example : | any of [string, null] | |
| resource_name optional | Resource name Example : | any of [string, null] | |
| resource_type optional | Resource type Example : | any of [string, null] | |
| root_resource_id optional | Root resource ID Example : | any of [string, null] | |
| start_at required | Query start date Example : 2025-08-09T10:00:00Z | string | |
| status optional | Task result Example : | any of [string, null] | |
| time_zone_info required | Timezone info Example : Asia/Seoul | string | |
| user_name optional | Username Example : | any of [string, null] |
5.2.5 - LogDownloadResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| file required | array[LogDownloadDetailResponse] |
5.2.6 - LogListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| logs required | array[Log] | ||
| page required | page Example : 0 | integer | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
5.2.7 - LogShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| log required | LogDetails |
5.2.8 - Trail
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id optional | Account ID Example : ACCOUNT_ID-ABCDEF1234 | any of [string, null] | |
| account_name optional | Account name Example : Test Account | any of [string, null] | |
| bucket_name required | Bucket name Example : Bucket001 | string | |
| bucket_region required | Bucket region Example : RegionOne | string | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| created_user_id optional | Created user ID Example : kim.samsung@samsung.com | any of [string, null] | |
| del_yn optional | Delete y/n Example : N | any of [string, null] | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| log_type_total_yn optional | Target log type total y/n Example : Y | any of [string, null] | |
| log_verification_yn optional | Log verification y/n Example : N | any of [string, null] | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| region_names optional | Region name list | array[object] | |
| region_total_yn optional | Target region total y/n Example : Y | any of [string, null] | |
| resource_type_total_yn optional | Target resource type total y/n Example : Y | any of [string, null] | |
| state optional | Trail state Example : ACTIVE | any of [string, null] | |
| target_log_types optional | Target log type list | array[object] | |
| target_resource_types optional | Target resource type list | array[object] | |
| target_users optional | Target user list | array[object] | |
| trail_batch_end_at optional | Trail batch end date Example : 2025-11-07T09:00:00Z | any of [string (date-time), null] | |
| trail_batch_first_start_at optional | Trail batch first start date Example : 2025-10-28T10:00:00Z | any of [string (date-time), null] | |
| trail_batch_last_state optional | Trail batch last state Example : success | any of [string, null] | |
| trail_batch_start_at optional | Trail batch start date Example : 2025-11-07T09:00:00Z | any of [string (date-time), null] | |
| trail_batch_success_at optional | Trail batch success date Example : 2025-11-07T09:00:00Z | any of [string (date-time), null] | |
| trail_description optional | Trail description Example : test trail | any of [string, null] | |
| trail_name required | Trail name Example : Trail-0001 | string | |
| trail_save_type required | Trail save type Example : JSON | string | |
| user_total_yn optional | Target user total y/n Example : Y | any of [string, null] |
5.2.9 - Trail1dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id optional | Account ID Example : ACCOUNT_ID-ABCDEF1234 | any of [string, null] | |
| account_name optional | Account name Example : Test Account | any of [string, null] | |
| bucket_name required | Bucket name Example : Bucket001 | string | |
| bucket_region required | Bucket region Example : RegionOne | string | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| created_user_id optional | Created user ID Example : kim.samsung@samsung.com | any of [string, null] | |
| del_yn optional | Delete y/n Example : N | any of [string, null] | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| log_archive_account_id optional | Log Archive Account ID Example : ACCOUNT_ID-ABCDEF1234 | any of [string, null] | |
| log_type_total_yn optional | Target log type total y/n Example : Y | any of [string, null] | |
| log_verification_yn optional | Log verification y/n Example : N | any of [string, null] | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| organization_trail_yn optional | Organization trail y/n Example : Y | any of [string, null] | |
| region_names optional | Region name list | array[object] | |
| region_total_yn optional | Target region total y/n Example : Y | any of [string, null] | |
| resource_type_total_yn optional | Target resource type total y/n Example : Y | any of [string, null] | |
| state optional | Trail state Example : ACTIVE | any of [string, null] | |
| target_log_types optional | Target log type list | array[object] | |
| target_resource_types optional | Target resource type list | array[object] | |
| target_users optional | Target user list | array[object] | |
| trail_batch_end_at optional | Trail batch end date Example : 2025-11-07T09:00:00Z | any of [string (date-time), null] | |
| trail_batch_first_start_at optional | Trail batch first start date Example : 2025-10-28T10:00:00Z | any of [string (date-time), null] | |
| trail_batch_last_state optional | Trail batch last state Example : success | any of [string, null] | |
| trail_batch_start_at optional | Trail batch start date Example : 2025-11-07T09:00:00Z | any of [string (date-time), null] | |
| trail_batch_success_at optional | Trail batch success date Example : 2025-11-07T09:00:00Z | any of [string (date-time), null] | |
| trail_description optional | Trail description Example : test trail | any of [string, null] | |
| trail_name required | Trail name Example : Trail-0001 | string | |
| trail_save_type required | Trail save type Example : JSON | string | |
| user_total_yn optional | Target user total y/n Example : Y | any of [string, null] |
5.2.10 - TrailCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : ACCOUNT_ID-ABCDEF1234 | string | |
| bucket_name required | Bucket name Example : TestBucket00Minimum length : 1 | string | |
| bucket_region required | Bucket region Example : RegionOneMinimum length : 1 | string | |
| log_type_total_yn optional | Target log type total y/n Example : N | any of [string, null] | |
| log_verification_yn optional | Log verification y/n Example : N | any of [string, null] | N |
| region_names optional | Region name list | array[object] | |
| region_total_yn optional | Target region total y/n Example : Y | any of [string, null] | Y |
| resource_type_total_yn optional | Target resource type total y/n Example : Y | any of [string, null] | Y |
| tag_create_requests optional | Tag create requests Example : [{'key': '11', 'value': '22'}] | any of [array[object[string]], null] | |
| target_log_types optional | Target log type list | array[object] | |
| target_resource_types optional | Target resource type list | array[object] | |
| target_users optional | Target user list | array[object] | |
| trail_description optional | Trail description Example : This is a test trail | any of [string, null] | |
| trail_name required | Trail name Example : TestTrail01Pattern : ^[a-zA-Z0-9\-ㄱ-ㅎㅏ-ㅣ가-힣\s]*$Minimum length : 5Maximum length : 26 | string | |
| trail_save_type required | Trail save type Example : JSONPattern : ^(CSV|JSON)$Minimum length : 1 | string | |
| user_total_yn optional | Target user total y/n Example : Y | any of [string, null] | Y |
5.2.11 - TrailCreateRequestV1dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : ACCOUNT_ID-ABCDEF1234 | string | |
| bucket_name required | Bucket name Example : TestBucket00Minimum length : 1 | string | |
| bucket_region required | Bucket region Example : RegionOneMinimum length : 1 | string | |
| log_archive_account_id optional | Log Archive Account ID. Only for Organization Trail.(organization_trail_yn = y) Example : ACCOUNT_ID-ABCDEF1234 | any of [string, null] | |
| log_type_total_yn optional | Target log type total y/n Example : N | any of [string, null] | |
| log_verification_yn optional | Log verification y/n Example : N | any of [string, null] | N |
| organization_trail_yn optional | Organization trail y/n Example : N | any of [string, null] | N |
| region_names optional | Region name list | array[object] | |
| region_total_yn optional | Target region total y/n Example : Y | any of [string, null] | Y |
| resource_type_total_yn optional | Target resource type total y/n Example : Y | any of [string, null] | Y |
| tag_create_requests optional | Tag create requests Example : [{'key': '11', 'value': '22'}] | any of [array[object[string]], null] | |
| target_log_types optional | Target log type list | array[object] | |
| target_resource_types optional | Target resource type list | array[object] | |
| target_users optional | Target user list | array[object] | |
| trail_description optional | Trail description Example : This is a test trail | any of [string, null] | |
| trail_name required | Trail name Example : TestTrail01Pattern : ^[a-zA-Z0-9\-ㄱ-ㅎㅏ-ㅣ가-힣\s]*$Minimum length : 5Maximum length : 26 | string | |
| trail_save_type required | Trail save type Example : JSONPattern : ^(CSV|JSON)$Minimum length : 1 | string | |
| user_total_yn optional | Target user total y/n Example : Y | any of [string, null] | Y |
5.2.12 - TrailListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] | |
| trails required | array[Trail] |
5.2.13 - TrailListResponseV1dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] | |
| trails required | array[Trail1dot1] |
5.2.14 - TrailSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| log_type_total_yn optional | Target log type total y/n Example : N | any of [string, null] | |
| log_verification_yn optional | Log verification y/n Example : N | any of [string, null] | |
| region_names optional | Region name list Example : | any of [array[object], null] | |
| region_total_yn optional | Target region total y/n Example : Y | any of [string, null] | |
| resource_type_total_yn optional | Target resource type total y/n Example : Y | any of [string, null] | |
| target_log_types optional | Target log type list Example : | any of [array[object], null] | |
| target_resource_types optional | Target resource type list Example : | any of [array[object], null] | |
| target_users optional | Target user list Example : | any of [array[object], null] | |
| trail_description optional | Trail description Example : This is a test trail | any of [string, null] | |
| trail_save_type optional | Trail save type Example : JSONPattern : ^(CSV|JSON)$ | any of [string, null] | |
| user_total_yn optional | Target user total y/n Example : Y | any of [string, null] |
5.2.15 - TrailSetRequestV1dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| log_type_total_yn optional | Target log type total y/n Example : N | any of [string, null] | |
| log_verification_yn optional | Log verification y/n Example : N | any of [string, null] | |
| organization_trail_yn optional | Organization trail y/n Example : Y | any of [string, null] | |
| region_names optional | Region name list Example : | any of [array[object], null] | |
| region_total_yn optional | Target region total y/n Example : Y | any of [string, null] | |
| resource_type_total_yn optional | Target resource type total y/n Example : Y | any of [string, null] | |
| target_log_types optional | Target log type list Example : | any of [array[object], null] | |
| target_resource_types optional | Target resource type list Example : | any of [array[object], null] | |
| target_users optional | Target user list Example : | any of [array[object], null] | |
| trail_description optional | Trail description Example : This is a test trail | any of [string, null] | |
| trail_save_type optional | Trail save type Example : JSONPattern : ^(CSV|JSON)$ | any of [string, null] | |
| user_total_yn optional | Target user total y/n Example : Y | any of [string, null] |
5.2.16 - TrailShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| trail required | Trail |
5.2.17 - TrailShowResponseV1dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| trail required | Trail1dot1 |
6 - Network Logging
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다. 본 가이드는 Network Logging 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
OpenAPI URL
https://network-logging.{region}.{environment}.samsungsdscloud.com
Environment and Region List
| environment | region |
|---|---|
| s | kr-west1 |
| s | kr-east1 |
| g | kr-south1 |
| g | kr-south2 |
| g | kr-south3 |
| e | kr-west1 |
| e | kr-east1 |
6.1 - APIs
6.1.1 - Create Network Logging Storage
6.1.1.1 - 1.0
post /v1/network-logging/storages
Description
Network Logging Storage 생성한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | NetworkLoggingStorageCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | NetworkLoggingStorageShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/network-logging/storages
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = network-logging 1.0"
Request body
{
"bucket_name": "",
"resource_type": "FIREWALL"
}
Example HTTP response
Response 201
{
"network_logging_storage": {
"account_id": "",
"bucket_name": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"resource_type": "FIREWALL"
}
}
6.1.2 - Delete Network Logging Storage
6.1.2.1 - 1.0
delete /v1/network-logging/storages/{network_logging_storage_id}
Description
Network Logging Storage 삭제한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | network_logging_storage_id required | Network Logging Storage ID Example : | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/network-logging/storages/{network_logging_storage_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = network-logging 1.0"
Example HTTP response
Response 204
6.1.3 - List Network Logging Configurations
6.1.3.1 - 1.0
get /v1/network-logging/configurations
Description
Network Logging Configuration 목록 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | with_count optional | with count Example : true | any of [string, null] | None |
| query | limit optional | 한도 Example : 20 | any of [integer, null] | None |
| query | marker optional | 마커 Example : 607e0938521643b5b4b266f343fae693 | any of [string, null] | None |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | resource_id optional | 리소스 ID Example : | string | None |
| query | resource_name optional | 리소스 이름 Example : | string | None |
| query | resource_type required | 리소스 타입 Example : | enum (FIREWALL, SECURITY_GROUP, NAT) | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | NetworkLoggingConfigurationListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/network-logging/configurations?resource_type={resource_type}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = network-logging 1.0"
Example HTTP response
Response 200
{
"count": 20,
"links": [
{
"href": "http://scp.samsungsdscloud.com/v1/notices",
"rel": "self"
}
],
"network_logging_configurations": [
{
"account_id": "",
"bucket_name": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"down_interface": "",
"id": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"resource_id": "",
"resource_name": "",
"resource_type": "FIREWALL",
"security_group_log_id": "",
"up_interface": ""
}
]
}
6.1.4 - List Network Logging Storages
6.1.4.1 - 1.0
get /v1/network-logging/storages
Description
Network Logging Storage 목록 조회한다.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | with_count optional | with count Example : true | any of [string, null] | None |
| query | limit optional | 한도 Example : 20 | any of [integer, null] | None |
| query | marker optional | 마커 Example : 607e0938521643b5b4b266f343fae693 | any of [string, null] | None |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | resource_type required | 리소스 타입 Example : | enum (FIREWALL, SECURITY_GROUP, NAT) | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | NetworkLoggingStorageListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/network-logging/storages?resource_type={resource_type}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = network-logging 1.0"
Example HTTP response
Response 200
{
"count": 20,
"links": [
{
"href": "http://scp.samsungsdscloud.com/v1/notices",
"rel": "self"
}
],
"network_logging_storages": [
{
"account_id": "",
"bucket_name": "",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"id": "",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"resource_type": "FIREWALL"
}
]
}
6.2 - Models
6.2.1 - NetworkLoggingConfiguration
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : | string | |
| bucket_name required | 저장소 버킷 이름 Example : | string | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| down_interface optional | 하향 인터페이스 Example : | any of [string, null] | |
| id required | Network Logging Configuration ID Example : | string | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| resource_id required | 리소스 ID Example : | string | |
| resource_name required | 리소스 이름 Example : | string | |
| resource_type required | 리소스 타입 Example : FIREWALL | enum (FIREWALL, SECURITY_GROUP, NAT) | |
| security_group_log_id optional | Security Group 로그 ID Example : | any of [string, null] | |
| up_interface optional | 상향 인터페이스 Example : | any of [string, null] |
6.2.2 - NetworkLoggingConfigurationListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count optional | 전체 개수 Example : 20 | any of [integer, null] | |
| links optional | links Example : [{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}] | any of [array[object], null] | |
| network_logging_configurations required | array[NetworkLoggingConfiguration] |
6.2.3 - NetworkLoggingStorage
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : | string | |
| bucket_name required | 저장소 버킷 이름 Example : | string | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| id required | Network Logging Storage ID Example : | string | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| resource_type required | 리소스 타입 Example : FIREWALL | enum (FIREWALL, SECURITY_GROUP, NAT) |
6.2.4 - NetworkLoggingStorageCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| bucket_name required | 저장소 버킷 이름 Example : | string | |
| resource_type required | 리소스 타입 Example : FIREWALL | enum (FIREWALL, SECURITY_GROUP, NAT) |
6.2.5 - NetworkLoggingStorageListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count optional | 전체 개수 Example : 20 | any of [integer, null] | |
| links optional | links Example : [{'href': 'http://scp.samsungsdscloud.com/v1/notices', 'rel': 'self'}] | any of [array[object], null] | |
| network_logging_storages required | array[NetworkLoggingStorage] |
6.2.6 - NetworkLoggingStorageShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| network_logging_storage required | NetworkLoggingStorage |
7 - Organization
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.
본 가이드는 Organization 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | DEPRECATED | 20251231 |
| 1.1 | CURRENT | - |
OpenAPI URL
https://organization.{environment}.samsungsdscloud.com
Environment and Region List
| environment | region |
|---|---|
| s | kr-west1 |
| s | kr-east1 |
| g | kr-south1 |
| g | kr-south2 |
| g | kr-south3 |
| e | kr-west1 |
| e | kr-east1 |
7.1 - APIs
7.1.1 - AcceptInvitation
7.1.1.1 - 1.1
put /v1/invitations/{invitation_id}/accept
Description
accept a specific invitation
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | invitation_id required | 초대 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | InvitationAcceptResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/invitations/{invitation_id}/accept
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.1"
Example HTTP response
Response 200
{
"failed_id": {
"error_code": "Invitation.AlreadySentError",
"failed_caused": "Account b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 is not found",
"failed_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"failed_name": "My Organization"
},
"master_account_email": "score@samsung.com",
"success_id": {
"success_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"success_name": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5"
}
}
7.1.1.2 - 1.0
put /v1/invitations/{invitation_id}/accept
Description
accept a specific invitation
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | invitation_id required | 초대 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | InvitationAcceptResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/invitations/{invitation_id}/accept
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.0"
Example HTTP response
Response 200
{
"failed_id": {
"error_code": "Invitation.AlreadySentError",
"failed_caused": "Account b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 is not found",
"failed_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"failed_name": "My Organization"
},
"master_account_email": "score@samsung.com",
"success_id": {
"success_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"success_name": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5"
}
}
7.1.2 - AttachPolicyBindings
7.1.2.1 - 1.1
post /v1/assignments/policy-bindings
Description
attach policy bindings
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | PolicyAttachRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ControlPolicyAssignmentResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/assignments/policy-bindings
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.1"
Request body
{
"entity": "POLICY",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"policy_ids": [
"f98e76d54c32b10a9z8y7x6w5v4u3"
],
"target_ids": [
"ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5"
]
}
Example HTTP response
Response 200
{
"failed_ids": [
{
"error_code": "Conflict",
"failed_caused": "Account 482d111a302547fbbd11ee0141ea23bb is not found",
"failed_id": "ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5"
}
],
"success_ids": [
"ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5"
]
}
7.1.2.2 - 1.0
post /v1/assignments/policy-bindings
Description
attach policy bindings
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | PolicyAttachRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ControlPolicyAssignmentResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/assignments/policy-bindings
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.0"
Request body
{
"entity": "POLICY",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"policy_ids": [
"f98e76d54c32b10a9z8y7x6w5v4u3"
],
"target_ids": [
"ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5"
]
}
Example HTTP response
Response 200
{
"failed_ids": [
{
"error_code": "Conflict",
"failed_caused": "Account 482d111a302547fbbd11ee0141ea23bb is not found",
"failed_id": "ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5"
}
],
"success_ids": [
"ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5"
]
}
7.1.3 - CancelInvitations
7.1.3.1 - 1.1
put /v1/invitations/cancel
Description
cancel invitations
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | InvitationCancelRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | InvitationCancelResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/invitations/cancel
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.1"
Request body
{
"ids": [
"138c2fc8c29a449dbfa8681f8f1d78e2"
],
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5"
}
Example HTTP response
Response 200
{
"success_ids": [
"138c2fc8c29a449dbfa8681f8f1d78e2"
]
}
7.1.3.2 - 1.0
put /v1/invitations/cancel
Description
cancel invitations
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | InvitationCancelRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | InvitationCancelResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/invitations/cancel
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.0"
Request body
{
"ids": [
"138c2fc8c29a449dbfa8681f8f1d78e2"
],
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5"
}
Example HTTP response
Response 200
{
"success_ids": [
"138c2fc8c29a449dbfa8681f8f1d78e2"
]
}
7.1.4 - CreateAccount
7.1.4.1 - 1.1
post /v1/organization-accounts
Description
create a account
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | OrganizationUserCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | AccountCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/organization-accounts
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.1"
Request body
{
"login_id": "log-archive@samsung.com",
"name": "score-account",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"role_name": "OrganizationAccountAccessRole"
}
Example HTTP response
Response 201
{
"failed": {
"error_code": "Organization.AccountNotRemovable",
"failed_caused": "Account b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 is not found"
},
"success": {
"success_id": "b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0",
"success_name": "score-account"
}
}
7.1.4.2 - 1.0
post /v1/organization-accounts
Description
create a account
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | OrganizationUserCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | AccountCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/organization-accounts
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.0"
Request body
{
"login_id": "log-archive@samsung.com",
"name": "score-account",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"role_name": "OrganizationAccountAccessRole"
}
Example HTTP response
Response 201
{
"failed": {
"error_code": "Organization.AccountNotRemovable",
"failed_caused": "Account b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 is not found"
},
"success": {
"success_id": "b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0",
"success_name": "score-account"
}
}
7.1.5 - CreateDelegationPolicy
7.1.5.1 - 1.1
post /v1/delegation-policies
Description
create a delegation policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | DelegationPolicyCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | DelegationPolicyShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/delegation-policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.1"
Request body
{
"document": {
"Statement": [
{
"Action": [
"organization:CreateServiceControlPolicy",
"organization:DeleteServiceControlPolicies",
"organization:SetServiceControlPolicy",
"organization:ShowServiceControlPolicy",
"organization:ListServiceControlPolicies",
"organization:ShowAccount",
"organization:ListAccounts",
"organization:ListOrganizationUnits",
"organization:ListOrganizationInvitations",
"organization:ListParents",
"organization:ListPoliciesForTarget",
"organization:ListTargetsForPolicy",
"organization:AttachPolicyBindings",
"organization:RemovePolicyBindings",
"organization:ShowDelegatePolicy"
],
"Effect": "Allow",
"Principal": {
"scp": [
"srn:dev2::f045159f40c64125a1fe61bd71d1c14c:::iam:user/e3a6e3f99c1040639e9a3c8f8b7427df"
]
},
"Resource": [
"*"
],
"Sid": "statement1"
}
],
"Version": "2024-07-01"
},
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5"
}
Example HTTP response
Response 201
{
"policy": {
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"document": {
"Statement": [
{
"Action": [
"organization:CreateServiceControlPolicy",
"organization:DeleteServiceControlPolicies",
"organization:SetServiceControlPolicy",
"organization:ShowServiceControlPolicy",
"organization:ListServiceControlPolicies",
"organization:ShowAccount",
"organization:ListAccounts",
"organization:ListOrganizationUnits",
"organization:ListOrganizationInvitations",
"organization:ListParents",
"organization:ListPoliciesForTarget",
"organization:ListTargetsForPolicy",
"organization:AttachPolicyBindings",
"organization:RemovePolicyBindings",
"organization:ShowDelegatePolicy"
],
"Effect": "Allow",
"Principal": {
"scp": [
"srn:dev2::f045159f40c64125a1fe61bd71d1c14c:::iam:user/e3a6e3f99c1040639e9a3c8f8b7427df"
]
},
"Resource": [
"*"
],
"Sid": "statement1"
}
],
"Version": "2024-07-01"
},
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5"
}
}
7.1.5.2 - 1.0
post /v1/delegation-policies
Description
create a delegation policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | DelegationPolicyCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | DelegationPolicyShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/delegation-policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.0"
Request body
{
"document": {
"Statement": [
{
"Action": [
"organization:CreateServiceControlPolicy",
"organization:DeleteServiceControlPolicies",
"organization:SetServiceControlPolicy",
"organization:ShowServiceControlPolicy",
"organization:ListServiceControlPolicies",
"organization:ShowAccount",
"organization:ListAccounts",
"organization:ListOrganizationUnits",
"organization:ListOrganizationInvitations",
"organization:ListParents",
"organization:ListPoliciesForTarget",
"organization:ListTargetsForPolicy",
"organization:AttachPolicyBindings",
"organization:RemovePolicyBindings",
"organization:ShowDelegatePolicy"
],
"Effect": "Allow",
"Principal": {
"scp": [
"srn:dev2::f045159f40c64125a1fe61bd71d1c14c:::iam:user/e3a6e3f99c1040639e9a3c8f8b7427df"
]
},
"Resource": [
"*"
],
"Sid": "statement1"
}
],
"Version": "2024-07-01"
},
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5"
}
Example HTTP response
Response 201
{
"policy": {
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"document": {
"Statement": [
{
"Action": [
"organization:CreateServiceControlPolicy",
"organization:DeleteServiceControlPolicies",
"organization:SetServiceControlPolicy",
"organization:ShowServiceControlPolicy",
"organization:ListServiceControlPolicies",
"organization:ShowAccount",
"organization:ListAccounts",
"organization:ListOrganizationUnits",
"organization:ListOrganizationInvitations",
"organization:ListParents",
"organization:ListPoliciesForTarget",
"organization:ListTargetsForPolicy",
"organization:AttachPolicyBindings",
"organization:RemovePolicyBindings",
"organization:ShowDelegatePolicy"
],
"Effect": "Allow",
"Principal": {
"scp": [
"srn:dev2::f045159f40c64125a1fe61bd71d1c14c:::iam:user/e3a6e3f99c1040639e9a3c8f8b7427df"
]
},
"Resource": [
"*"
],
"Sid": "statement1"
}
],
"Version": "2024-07-01"
},
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5"
}
}
7.1.6 - CreateInvitation
7.1.6.1 - 1.1
post /v1/invitations
Description
create an invitation
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | InvitationCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | InvitationCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/invitations
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.1"
Request body
{
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"target_login_ids": [
"score-1@samsung.com"
]
}
Example HTTP response
Response 201
{
"failed_ids": [
{
"error_code": "Invitation.AlreadySentError",
"failed_caused": "Account b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 is not found",
"failed_id": [
"score-1@samsung.com"
]
}
],
"success_ids": [
"log-archive@samsung.com"
]
}
7.1.6.2 - 1.0
post /v1/invitations
Description
create an invitation
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | InvitationCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | InvitationCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/invitations
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.0"
Request body
{
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"target_login_ids": [
"score-1@samsung.com"
]
}
Example HTTP response
Response 201
{
"failed_ids": [
{
"error_code": "Invitation.AlreadySentError",
"failed_caused": "Account b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 is not found",
"failed_id": [
"score-1@samsung.com"
]
}
],
"success_ids": [
"log-archive@samsung.com"
]
}
7.1.7 - CreateOrganization
7.1.7.1 - 1.1
post /v1/organizations
Description
create a organization
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | OrganizationCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | OrganizationShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/organizations
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.1"
Request body
{
"name": "My Organization"
}
Example HTTP response
Response 201
{
"organization": {
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"creator_name": "John Doe na",
"delegation_account_id": "124e7d6c5b4a3z2y1x0w9v8u7t6s5r",
"id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"master_account_email": "admin@example.com",
"master_account_id": "9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"modifier_name": "Alice",
"name": "My Organization",
"root_unit_id": "r-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r",
"srn": "srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/organization/o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"use_scp_yn": true
}
}
7.1.7.2 - 1.0
post /v1/organizations
Description
create a organization
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | OrganizationCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | OrganizationShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/organizations
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.0"
Request body
{
"name": "My Organization"
}
Example HTTP response
Response 201
{
"organization": {
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"creator_name": "John Doe na",
"delegation_account_id": "124e7d6c5b4a3z2y1x0w9v8u7t6s5r",
"id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"master_account_email": "admin@example.com",
"master_account_id": "9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"modifier_name": "Alice",
"name": "My Organization",
"root_unit_id": "r-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r",
"srn": "srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/organization/o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"use_scp_yn": true
}
}
7.1.8 - CreateOrganizationUnit
7.1.8.1 - 1.1
post /v1/organization-units
Description
create an organization unit
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | OrganizationUnitCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | OrganizationUnitCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/organization-units
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.1"
Request body
{
"description": "에스코어 조직 단위",
"name": "score-organization-unit",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"parent_unit_id": "ou-fc8c29a138d78e24bf1fa86812fc8b",
"policy_ids": [
"f98e76d54c32b10a9z8y7x6w5v4u3"
]
}
Example HTTP response
Response 201
{
"organization_unit": {
"control_policies": [
{
"policy_id": "f98e76d54c32b10a9z8y7x6w5v4u3",
"policy_name": "test-policy-name"
}
],
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"creator_name": "John Doe na",
"depth": 1,
"description": "에스코어 조직 단위",
"id": "ou-c29a138f8f1d78e24dbfa8681fc2fc8",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"modifier_name": "Alice",
"name": "score-organization-unit",
"parent_unit_id": "ou-fc8c29a138d78e24bf1fa86812fc8b",
"service_name": "Organization",
"srn": "srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/ou/ou-c29a138f8f1d78e24dbfa8681fc2fc8",
"type": "OU"
}
}
7.1.8.2 - 1.0
post /v1/organization-units
Description
create an organization unit
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | OrganizationUnitCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | OrganizationUnitCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/organization-units
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.0"
Request body
{
"description": "에스코어 조직 단위",
"name": "score-organization-unit",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"parent_unit_id": "ou-fc8c29a138d78e24bf1fa86812fc8b",
"policy_ids": [
"f98e76d54c32b10a9z8y7x6w5v4u3"
]
}
Example HTTP response
Response 201
{
"organization_unit": {
"control_policies": [
{
"policy_id": "f98e76d54c32b10a9z8y7x6w5v4u3",
"policy_name": "test-policy-name"
}
],
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"creator_name": "John Doe na",
"depth": 1,
"description": "에스코어 조직 단위",
"id": "ou-c29a138f8f1d78e24dbfa8681fc2fc8",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"modifier_name": "Alice",
"name": "score-organization-unit",
"parent_unit_id": "ou-fc8c29a138d78e24bf1fa86812fc8b",
"service_name": "Organization",
"srn": "srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/ou/ou-c29a138f8f1d78e24dbfa8681fc2fc8",
"type": "OU"
}
}
7.1.9 - CreateServiceControlPolicy
7.1.9.1 - 1.1
post /v1/service-control-policies
Description
create a service control policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ServiceControlPolicyCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | ServiceControlPolicyShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/service-control-policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.1"
Request body
{
"description": "This is an example policy.",
"document": {
"Statement": [
{
"Action": [
"*"
],
"Effect": "Allow",
"Resource": [
"*"
],
"Sid": "statement1"
}
],
"Version": "2024-07-01"
},
"name": "MyPolicy",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"type": "MANAGED"
}
Example HTTP response
Response 201
{
"policy": {
"category": "SCP",
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"creator_name": "John Doe na",
"description": "This is an example policy.",
"document": {
"Statement": [
{
"Action": [
"*"
],
"Effect": "Allow",
"Resource": [
"*"
],
"Sid": "statement1"
}
],
"Version": "2024-07-01"
},
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"modifier_name": "Alice",
"name": "MyPolicy",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"service_name": "Organization",
"source": "ORGANIZATION",
"srn": "srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/service-control-policy/138c2fc8c29a449dbfa8681f8f1d78e2",
"state": "ACTIVE",
"type": "MANAGED"
}
}
7.1.9.2 - 1.0
post /v1/service-control-policies
Description
create a service control policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ServiceControlPolicyCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | ServiceControlPolicyShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/service-control-policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.0"
Request body
{
"description": "This is an example policy.",
"document": {
"Statement": [
{
"Action": [
"*"
],
"Effect": "Allow",
"Resource": [
"*"
],
"Sid": "statement1"
}
],
"Version": "2024-07-01"
},
"name": "MyPolicy",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"type": "MANAGED"
}
Example HTTP response
Response 201
{
"policy": {
"category": "SCP",
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"creator_name": "John Doe na",
"description": "This is an example policy.",
"document": {
"Statement": [
{
"Action": [
"*"
],
"Effect": "Allow",
"Resource": [
"*"
],
"Sid": "statement1"
}
],
"Version": "2024-07-01"
},
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"modifier_name": "Alice",
"name": "MyPolicy",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"service_name": "Organization",
"source": "ORGANIZATION",
"srn": "srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/service-control-policy/138c2fc8c29a449dbfa8681f8f1d78e2",
"state": "ACTIVE",
"type": "MANAGED"
}
}
7.1.10 - DeclineInvitation
7.1.10.1 - 1.1
put /v1/invitations/{invitation_id}/decline
Description
decline a specific invitation
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | invitation_id required | 초대 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | InvitationShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/invitations/{invitation_id}/decline
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.1"
Example HTTP response
Response 200
{
"invitation": {
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"expired_time": "2024-04-30T12:34:56.789Z",
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"master_account_id": "9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"requested_time": "2024-04-17T12:34:56.789Z",
"state": "REFUSED",
"target_account_id": "338c2fc8c29a449dbfa8681f8f1d78e5"
}
}
7.1.10.2 - 1.0
put /v1/invitations/{invitation_id}/decline
Description
decline a specific invitation
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | invitation_id required | 초대 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | InvitationShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/invitations/{invitation_id}/decline
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.0"
Example HTTP response
Response 200
{
"invitation": {
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"expired_time": "2024-04-30T12:34:56.789Z",
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"master_account_id": "9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"requested_time": "2024-04-17T12:34:56.789Z",
"state": "REFUSED",
"target_account_id": "338c2fc8c29a449dbfa8681f8f1d78e5"
}
}
7.1.11 - DeleteDelegationPolicy
7.1.11.1 - 1.1
delete /v1/delegation-policies
Description
delete a specific delegation policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | organization_id optional | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/delegation-policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.1"
Example HTTP response
Response 204
7.1.11.2 - 1.0
delete /v1/delegation-policies
Description
delete a specific delegation policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | organization_id optional | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/delegation-policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.0"
Example HTTP response
Response 204
7.1.12 - DeleteOrganization
7.1.12.1 - 1.1
delete /v1/organizations/{organization_id}
Description
delete a specific organization
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | organization_id required | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | OrganizationDeleteResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/organizations/{organization_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.1"
Example HTTP response
Response 200
{
"failed": {
"error_code": "Organization.delete.MemberAccountIsExist",
"failed_caused": "Payment method registration required.",
"failed_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5"
},
"success": "My Organization"
}
7.1.12.2 - 1.0
delete /v1/organizations/{organization_id}
Description
delete a specific organization
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | organization_id required | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | OrganizationDeleteResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/organizations/{organization_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.0"
Example HTTP response
Response 200
{
"failed": {
"error_code": "Organization.delete.MemberAccountIsExist",
"failed_caused": "Payment method registration required.",
"failed_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5"
},
"success": "My Organization"
}
7.1.13 - DeleteOrganizationUnits
7.1.13.1 - 1.1
delete /v1/organization-units
Description
delete organization units
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | OrganizationUnitDeleteRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | OrganizationUnitDeleteResponse |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/organization-units
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.1"
Request body
{
"ids": [
"ou-c29a138f8f1d78e24dbfa8681fc2fc8"
],
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5"
}
Example HTTP response
Response 200
{
"failed_ids": [
{
"error_code": "Organization.UnitNotRemovable",
"failed_caused": "Account b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 is not found",
"failed_id": "ou-abc1f2h1j0l9n8p7r6t5v4x3z2y1w0"
}
],
"success_ids": [
"ou-c29a138f8f1d78e24dbfa8681fc2fc8"
]
}
7.1.13.2 - 1.0
delete /v1/organization-units
Description
delete organization units
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | OrganizationUnitDeleteRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | OrganizationUnitDeleteResponse |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/organization-units
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.0"
Request body
{
"ids": [
"ou-c29a138f8f1d78e24dbfa8681fc2fc8"
],
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5"
}
Example HTTP response
Response 200
{
"failed_ids": [
{
"error_code": "Organization.UnitNotRemovable",
"failed_caused": "Account b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 is not found",
"failed_id": "ou-abc1f2h1j0l9n8p7r6t5v4x3z2y1w0"
}
],
"success_ids": [
"ou-c29a138f8f1d78e24dbfa8681fc2fc8"
]
}
7.1.14 - DeleteServiceControlPolicies
7.1.14.1 - 1.1
delete /v1/service-control-policies
Description
delete service control policies
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ServiceControlPolicyDeleteRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServiceControlPolicyDeleteResponse |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/service-control-policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.1"
Request body
{
"ids": [
"138c2fc8c29a449dbfa8681f8f1d78e2"
],
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5"
}
Example HTTP response
Response 200
{
"failed_ids": [
{
"binding_targets": [
{
"id": "ou-c29a138f8f1d78e24dbfa8681fc2fc8 또는 b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0",
"name": "score-organization-unit 또는 score-account",
"type": "OU"
}
],
"error_code": "Policy.PolicyInUseError",
"failed_caused": "The specified policy is in use and cannot be deleted.",
"failed_id": "138c2fc8c29a449dbfa8681f8f1d78e2"
}
],
"success_ids": [
""
]
}
7.1.14.2 - 1.0
delete /v1/service-control-policies
Description
delete service control policies
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ServiceControlPolicyDeleteRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServiceControlPolicyDeleteResponse |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/service-control-policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.0"
Request body
{
"ids": [
"138c2fc8c29a449dbfa8681f8f1d78e2"
],
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5"
}
Example HTTP response
Response 200
{
"failed_ids": [
{
"binding_targets": [
{
"id": "ou-c29a138f8f1d78e24dbfa8681fc2fc8 또는 b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0",
"name": "score-organization-unit 또는 score-account",
"type": "OU"
}
],
"error_code": "Policy.PolicyInUseError",
"failed_caused": "The specified policy is in use and cannot be deleted.",
"failed_id": "138c2fc8c29a449dbfa8681f8f1d78e2"
}
],
"success_ids": [
""
]
}
7.1.15 - LeaveOrganization
7.1.15.1 - 1.1
delete /v1/organizations/{organization_id}/membership
Description
leave a specific organization
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | organization_id required | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | OrganizationLeaveResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/organizations/{organization_id}/membership
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.1"
Example HTTP response
Response 200
{
"failed": {
"error_code": "Organization.AccountNotRemovable",
"failed_caused": "Payment method registration required.",
"failed_id": "b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0",
"failed_name": "My Organization"
},
"success": {
"success_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"success_name": "My Organization"
}
}
7.1.15.2 - 1.0
delete /v1/organizations/{organization_id}/membership
Description
leave a specific organization
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | organization_id required | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | OrganizationLeaveResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/organizations/{organization_id}/membership
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.0"
Example HTTP response
Response 200
{
"failed": {
"error_code": "Organization.AccountNotRemovable",
"failed_caused": "Payment method registration required.",
"failed_id": "b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0",
"failed_name": "My Organization"
},
"success": {
"success_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"success_name": "My Organization"
}
}
7.1.16 - ListAccountInvitations
7.1.16.1 - 1.1
get /v1/account-invitations
Description
get account invitation list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AccountInvitationResponse |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/account-invitations
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.1"
Example HTTP response
Response 200
{
"account_invitations": [
{
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"expired_time": "2024-04-30T12:34:56.789Z",
"id": "0a36e0746dbf4908acf0357829701381",
"master_account_email": "admin@example.com",
"master_account_id": "9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r",
"master_account_login_id": "log-archive@samsung.com",
"master_account_name": "CoreKim",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"organization_name": "My Organization",
"requested_time": "2024-04-17T12:34:56.789Z",
"state": "INVITING",
"target_account_id": "338c2fc8c29a449dbfa8681f8f1d78e5"
}
],
"count": 5
}
7.1.16.2 - 1.0
get /v1/account-invitations
Description
get account invitation list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AccountInvitationResponse |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/account-invitations
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.0"
Example HTTP response
Response 200
{
"account_invitations": [
{
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"expired_time": "2024-04-30T12:34:56.789Z",
"id": "0a36e0746dbf4908acf0357829701381",
"master_account_email": "admin@example.com",
"master_account_id": "9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r",
"master_account_login_id": "log-archive@samsung.com",
"master_account_name": "CoreKim",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"organization_name": "My Organization",
"requested_time": "2024-04-17T12:34:56.789Z",
"state": "INVITING",
"target_account_id": "338c2fc8c29a449dbfa8681f8f1d78e5"
}
],
"count": 5
}
7.1.17 - ListAccounts
7.1.17.1 - 1.1
get /v1/organization-accounts
Description
get accounts list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | organization_id optional | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | any of [string, null] | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | id optional | 조직 계정 ID Example : b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 | any of [string, null] | None |
| query | name optional | 계정명 Example : score-account | any of [string, null] | None |
| query | email optional | 계정 이메일 Example : score@samsung.com | any of [string, null] | None |
| query | login_id optional | 로그인 ID Example : log-archive@samsung.com | any of [string, null] | None |
| query | joined_start_date optional | 가입 조회 시작 일시 Example : 2024-05-17T12:34:56.789Z | any of [string, null] | None |
| query | joined_end_date optional | 가입 조회 종료 일시 Example : 2024-05-17T12:34:56.789Z | any of [string, null] | None |
| query | joined_method optional | 가입 방법 Example : INVITED | any of [enum (INVITED, CREATED, CLOUD_CONTROL), null] | None |
| query | exclude_policy_id optional | 제외할 정책 ID Example : 238c2fc8c29a449dbfa8681f8f1d78e2 | any of [string, null] | None |
| query | parent_unit_id optional | ROOT 또는 부모 조직 단위 ID Example : ou-fc8c29a138d78e24bf1fa86812fc8b | any of [string, null] | None |
| query | parent_unit_name optional | ROOT 또는 부모 조직 단위명 Example : parent-unit-name | any of [string, null] | None |
| query | type optional | 계정 유형 Example : MEMBER | any of [enum (MANAGEMENT, DELEGATION, MEMBER, NONE, LOG_ARCHIVE, AUDIT), null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AccountPageResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/organization-accounts
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.1"
Example HTTP response
Response 200
{
"accounts": [
{
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"email": "score@samsung.com",
"id": "0a36e0746dbf4908acf0357829701381",
"joined_method": "INVITED",
"joined_time": "2024-05-17T12:34:56.789Z",
"login_id": "log-archive@samsung.com",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"name": "score-account",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"parent_unit_id": "ou-fc8c29a138d78e24bf1fa86812fc8b",
"parent_unit_name": "parent-unit-name",
"state": "ACTIVE",
"type": "MEMBER"
}
],
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
7.1.17.2 - 1.0
get /v1/organization-accounts
Description
get accounts list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | organization_id optional | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | any of [string, null] | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | id optional | 조직 계정 ID Example : b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 | any of [string, null] | None |
| query | name optional | 계정명 Example : score-account | any of [string, null] | None |
| query | email optional | 계정 이메일 Example : score@samsung.com | any of [string, null] | None |
| query | login_id optional | 로그인 ID Example : log-archive@samsung.com | any of [string, null] | None |
| query | joined_start_date optional | 가입 조회 시작 일시 Example : 2024-05-17T12:34:56.789Z | any of [string, null] | None |
| query | joined_end_date optional | 가입 조회 종료 일시 Example : 2024-05-17T12:34:56.789Z | any of [string, null] | None |
| query | joined_method optional | 가입 방법 Example : INVITED | any of [enum (INVITED, CREATED, CLOUD_CONTROL), null] | None |
| query | exclude_policy_id optional | 제외할 정책 ID Example : 238c2fc8c29a449dbfa8681f8f1d78e2 | any of [string, null] | None |
| query | parent_unit_id optional | ROOT 또는 부모 조직 단위 ID Example : ou-fc8c29a138d78e24bf1fa86812fc8b | any of [string, null] | None |
| query | parent_unit_name optional | ROOT 또는 부모 조직 단위명 Example : parent-unit-name | any of [string, null] | None |
| query | type optional | 계정 유형 Example : MEMBER | any of [enum (MANAGEMENT, DELEGATION, MEMBER, NONE, LOG_ARCHIVE, AUDIT), null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AccountPageResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/organization-accounts
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.0"
Example HTTP response
Response 200
{
"accounts": [
{
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"email": "score@samsung.com",
"id": "0a36e0746dbf4908acf0357829701381",
"joined_method": "INVITED",
"joined_time": "2024-05-17T12:34:56.789Z",
"login_id": "log-archive@samsung.com",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"name": "score-account",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"parent_unit_id": "ou-fc8c29a138d78e24bf1fa86812fc8b",
"parent_unit_name": "parent-unit-name",
"state": "ACTIVE",
"type": "MEMBER"
}
],
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
7.1.18 - ListOrganizationInvitations
7.1.18.1 - 1.1
get /v1/organization-invitations
Description
get organization invitation list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | organization_id optional | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | any of [string, null] | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | account_id optional | 관리자 계정명 Example : 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r | any of [string, null] | None |
| query | account_name optional | 관리자 계정명 Example : CoreKim | any of [string, null] | None |
| query | account_email optional | 관리자 계정 이메일 Example : admin@example.com | any of [string, null] | None |
| query | state optional | 초대 상태 Example : INVITING | any of [enum (INVITING, REFUSED, INVITED, CANCELED, EXPIRED), null] | None |
| query | login_id optional | 로그인 ID Example : log-archive@samsung.com | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | OrganizationInvitationPageResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/organization-invitations
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.1"
Example HTTP response
Response 200
{
"count": 20,
"organization_invitations": [
{
"account_email": "admin@example.com",
"account_name": "CoreKim",
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"id": "0a36e0746dbf4908acf0357829701381",
"login_id": "log-archive@samsung.com",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"state": "INVITING",
"target_account_id": "9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r"
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
7.1.18.2 - 1.0
get /v1/organization-invitations
Description
get organization invitation list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | organization_id optional | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | any of [string, null] | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | account_id optional | 관리자 계정명 Example : 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r | any of [string, null] | None |
| query | account_name optional | 관리자 계정명 Example : CoreKim | any of [string, null] | None |
| query | account_email optional | 관리자 계정 이메일 Example : admin@example.com | any of [string, null] | None |
| query | state optional | 초대 상태 Example : INVITING | any of [enum (INVITING, REFUSED, INVITED, CANCELED, EXPIRED), null] | None |
| query | login_id optional | 로그인 ID Example : log-archive@samsung.com | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | OrganizationInvitationPageResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/organization-invitations
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.0"
Example HTTP response
Response 200
{
"count": 20,
"organization_invitations": [
{
"account_email": "admin@example.com",
"account_name": "CoreKim",
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"id": "0a36e0746dbf4908acf0357829701381",
"login_id": "log-archive@samsung.com",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"state": "INVITING",
"target_account_id": "9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r"
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
7.1.19 - ListOrganizations
7.1.19.1 - 1.1
get /v1/organizations
Description
get organizations list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | organization_id optional | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | any of [string, null] | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | name optional | 조직 이름 Example : My Organization | any of [string, null] | None |
| query | master_account_id optional | 조직 계정 ID Example : b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | OrganizationPageResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/organizations
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.1"
Example HTTP response
Response 200
{
"count": 20,
"organizations": [
{
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"delegation_account_id": "124e7d6c5b4a3z2y1x0w9v8u7t6s5r",
"id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"master_account_id": "9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"name": "My Organization",
"root_unit_id": "r-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r",
"use_scp_yn": true
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
7.1.19.2 - 1.0
get /v1/organizations
Description
get organizations list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | organization_id optional | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | any of [string, null] | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | name optional | 조직 이름 Example : My Organization | any of [string, null] | None |
| query | master_account_id optional | 조직 계정 ID Example : b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | OrganizationPageResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/organizations
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.0"
Example HTTP response
Response 200
{
"count": 20,
"organizations": [
{
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"delegation_account_id": "124e7d6c5b4a3z2y1x0w9v8u7t6s5r",
"id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"master_account_id": "9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"name": "My Organization",
"root_unit_id": "r-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r",
"use_scp_yn": true
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
7.1.20 - ListOrganizationUnits
7.1.20.1 - 1.1
get /v1/organization-units
Description
get organization unit list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | organization_id optional | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | any of [string, null] | None |
| query | parent_unit_id required | ROOT 또는 부모 조직 단위 ID Example : ou-fc8c29a138d78e24bf1fa86812fc8b | string | None |
| query | name optional | 조직 단위명 Example : score-organization-unit | any of [string, null] | None |
| query | exclude_policy_id optional | 제외할 정책 ID Example : 238c2fc8c29a449dbfa8681f8f1d78e2 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | OrganizationUnitListResponseV1dot1 |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/organization-units?parent_unit_id={parent_unit_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.1"
Example HTTP response
Response 200
{
"organization_units": [
{
"created_at": "2024-12-19 01:09:05.000",
"depth": 1,
"email": "score@samsung.com",
"id": "ou-c29a138f8f1d78e24dbfa8681fc2fc8",
"joined_method": "INVITED",
"joined_time": "2024-05-17T12:34:56.789Z",
"login_id": "log-archive@samsung.com",
"name": "score-organization-unit",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"parent_unit_id": "ou-fc8c29a138d78e24bf1fa86812fc8b",
"parent_unit_name": "parent-unit-name",
"type": "MEMBER"
}
]
}
7.1.20.2 - 1.0
get /v1/organization-units
Description
get organization unit list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | organization_id optional | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | any of [string, null] | None |
| query | parent_unit_id required | ROOT 또는 부모 조직 단위 ID Example : ou-fc8c29a138d78e24bf1fa86812fc8b | string | None |
| query | name optional | 조직 단위명 Example : score-organization-unit | any of [string, null] | None |
| query | exclude_policy_id optional | 제외할 정책 ID Example : 238c2fc8c29a449dbfa8681f8f1d78e2 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | OrganizationUnitListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/organization-units?parent_unit_id={parent_unit_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.0"
Example HTTP response
Response 200
{
"organization_units": [
{
"created_at": "2024-12-19 01:09:05.000",
"depth": 1,
"email": "score@samsung.com",
"id": "ou-c29a138f8f1d78e24dbfa8681fc2fc8",
"joined_method": "INVITED",
"joined_time": "2024-05-17T12:34:56.789Z",
"login_id": "log-archive@samsung.com",
"name": "score-organization-unit",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"parent_unit_id": "ou-fc8c29a138d78e24bf1fa86812fc8b",
"type": "MEMBER"
}
]
}
7.1.21 - ListParents
7.1.21.1 - 1.1
get /v1/organization-units/{unit_id}/parents
Description
get organization unit parent list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | unit_id required | 조직 단위 ID Example : ou-c29a138f8f1d78e24dbfa8681fc2fc8 | string | None |
| query | organization_id optional | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | OrganizationUnitParentsResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/organization-units/{unit_id}/parents
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.1"
Example HTTP response
Response 200
{
"parents": [
{
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"creator_name": "John Doe na",
"depth": 1,
"description": "에스코어 조직 단위",
"id": "ou-c29a138f8f1d78e24dbfa8681fc2fc8",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"modifier_name": "Alice",
"name": "score-organization-unit",
"parent_unit_id": "ou-fc8c29a138d78e24bf1fa86812fc8b",
"service_name": "Organization",
"srn": "srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/ou/ou-c29a138f8f1d78e24dbfa8681fc2fc8",
"type": "OU"
}
]
}
7.1.21.2 - 1.0
get /v1/organization-units/{unit_id}/parents
Description
get organization unit parent list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | unit_id required | 조직 단위 ID Example : ou-c29a138f8f1d78e24dbfa8681fc2fc8 | string | None |
| query | organization_id optional | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | OrganizationUnitParentsResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/organization-units/{unit_id}/parents
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.0"
Example HTTP response
Response 200
{
"parents": [
{
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"creator_name": "John Doe na",
"depth": 1,
"description": "에스코어 조직 단위",
"id": "ou-c29a138f8f1d78e24dbfa8681fc2fc8",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"modifier_name": "Alice",
"name": "score-organization-unit",
"parent_unit_id": "ou-fc8c29a138d78e24bf1fa86812fc8b",
"service_name": "Organization",
"srn": "srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/ou/ou-c29a138f8f1d78e24dbfa8681fc2fc8",
"type": "OU"
}
]
}
7.1.22 - ListPoliciesForTarget
7.1.22.1 - 1.1
get /v1/assignments/policies
Description
list policies for target
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | organization_id optional | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | any of [string, null] | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | target_id required | 타겟 ID Example : ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 | string | None |
| query | policy_category optional | 정책 카테고리 Example : SCP | any of [enum (SCP, RCP, TAG, DGP), null] | SCP |
| query | name optional | 제어 정책 이름 Example : test-policy-name | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ListPoliciesForTargetResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/assignments/policies?target_id={target_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.1"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"policies": [
{
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"id": "0a36e0746dbf4908acf0357829701381",
"link_types": {
"DIRECTED": [
{
"target_id": "1a2b3c4d5e6f7g8h9i0j1k2l3m4n5",
"target_name": "example-target",
"target_type": "OU"
}
],
"INHERITED": [
{
"target_id": "2a2b3c4d5e6f7g8h9i0j1k2l3m4n5",
"target_name": "root",
"target_type": "ROOT"
}
]
},
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"policy_name": "test-policy-name",
"policy_type": "SYSTEM_MANAGED",
"source": "ORGANIZATION"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
7.1.22.2 - 1.0
get /v1/assignments/policies
Description
list policies for target
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | organization_id optional | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | any of [string, null] | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | target_id required | 타겟 ID Example : ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 | string | None |
| query | policy_category optional | 정책 카테고리 Example : SCP | any of [enum (SCP, RCP, TAG, DGP), null] | SCP |
| query | name optional | 제어 정책 이름 Example : test-policy-name | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ListPoliciesForTargetResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/assignments/policies?target_id={target_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.0"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"policies": [
{
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"id": "0a36e0746dbf4908acf0357829701381",
"link_types": {
"DIRECTED": [
{
"target_id": "1a2b3c4d5e6f7g8h9i0j1k2l3m4n5",
"target_name": "example-target",
"target_type": "OU"
}
],
"INHERITED": [
{
"target_id": "2a2b3c4d5e6f7g8h9i0j1k2l3m4n5",
"target_name": "root",
"target_type": "ROOT"
}
]
},
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"policy_name": "test-policy-name",
"policy_type": "SYSTEM_MANAGED",
"source": "ORGANIZATION"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
7.1.23 - ListServiceControlPolicies
7.1.23.1 - 1.1
get /v1/service-control-policies
Description
get service control policies list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | organization_id required | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | string | None |
| query | id optional | 서비스 제어 정책 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | any of [string, null] | None |
| query | name optional | 서비스 제어 정책 이름 Example : MyPolicy | any of [array[string], string, null] | None |
| query | type optional | 서비스 제어 정책 유형 Example : MANAGED | any of [enum (SYSTEM_MANAGED, USER_DEFINED), null] | None |
| query | exclude_target_id optional | 제외 대상 ID Example : 112c2fc8c29a449dbfa8681f8f1d7442 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServiceControlPolicyPageResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/service-control-policies?organization_id={organization_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.1"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"policies": [
{
"category": "SCP",
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"creator_name": "John Doe na",
"description": "This is an example policy.",
"document": {
"Statement": [
{
"Action": [
"*"
],
"Effect": "Allow",
"Resource": [
"*"
],
"Sid": "statement1"
}
],
"Version": "2024-07-01"
},
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"modifier_name": "Alice",
"name": "MyPolicy",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"source": "ORGANIZATION",
"state": "ACTIVE",
"type": "MANAGED"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
7.1.23.2 - 1.0
get /v1/service-control-policies
Description
get service control policies list
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | organization_id required | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | string | None |
| query | id optional | 서비스 제어 정책 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | any of [string, null] | None |
| query | name optional | 서비스 제어 정책 이름 Example : MyPolicy | any of [array[string], string, null] | None |
| query | type optional | 서비스 제어 정책 유형 Example : MANAGED | any of [enum (SYSTEM_MANAGED, USER_DEFINED), null] | None |
| query | exclude_target_id optional | 제외 대상 ID Example : 112c2fc8c29a449dbfa8681f8f1d7442 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServiceControlPolicyPageResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/service-control-policies?organization_id={organization_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.0"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"policies": [
{
"category": "SCP",
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"creator_name": "John Doe na",
"description": "This is an example policy.",
"document": {
"Statement": [
{
"Action": [
"*"
],
"Effect": "Allow",
"Resource": [
"*"
],
"Sid": "statement1"
}
],
"Version": "2024-07-01"
},
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"modifier_name": "Alice",
"name": "MyPolicy",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"source": "ORGANIZATION",
"state": "ACTIVE",
"type": "MANAGED"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
7.1.24 - ListTargetsForPolicy
7.1.24.1 - 1.1
get /v1/assignments/targets
Description
list targets for policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | organization_id optional | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | any of [string, null] | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | policy_id required | 제어 정책 ID Example : f98e76d54c32b10a9z8y7x6w5v4u3 | string | None |
| query | policy_category optional | 정책 카테고리 Example : SCP | any of [enum (SCP, RCP, TAG, DGP), null] | SCP |
| query | target_type required | 타겟 유형 Example : OU | enum (ROOT, ACCOUNT, OU) | None |
| query | name optional | 타겟명 Example : example-target | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ListTargetsForPolicyResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/assignments/targets?policy_id={policy_id}&target_type={target_type}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.1"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
],
"targets": [
{
"control_policies": [
{
"policy_id": "f98e76d54c32b10a9z8y7x6w5v4u3",
"policy_name": "test-policy-name"
}
],
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"id": "0a36e0746dbf4908acf0357829701381",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"target_name": "example-target"
}
]
}
7.1.24.2 - 1.0
get /v1/assignments/targets
Description
list targets for policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | organization_id optional | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | any of [string, null] | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | policy_id required | 제어 정책 ID Example : f98e76d54c32b10a9z8y7x6w5v4u3 | string | None |
| query | policy_category optional | 정책 카테고리 Example : SCP | any of [enum (SCP, RCP, TAG, DGP), null] | SCP |
| query | target_type required | 타겟 유형 Example : OU | enum (ROOT, ACCOUNT, OU) | None |
| query | name optional | 타겟명 Example : example-target | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ListTargetsForPolicyResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/assignments/targets?policy_id={policy_id}&target_type={target_type}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.0"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
],
"targets": [
{
"control_policies": [
{
"policy_id": "f98e76d54c32b10a9z8y7x6w5v4u3",
"policy_name": "test-policy-name"
}
],
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"id": "0a36e0746dbf4908acf0357829701381",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"target_name": "example-target"
}
]
}
7.1.25 - MoveAccount
7.1.25.1 - 1.1
put /v1/organization-accounts/parent
Description
move a specific account to a different OU
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | MoveAccountRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AccountMoveResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/organization-accounts/parent
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.1"
Request body
{
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"parent_unit_id": "ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5",
"target_account_ids": [
"b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0"
]
}
Example HTTP response
Response 200
{
"success_ids": [
{
"success_id": "b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0",
"success_name": "score-account",
"target_id": "ou-c29a138f8f1d78e24dbfa8681fc2fc8",
"target_name": "score-organization-unit"
}
]
}
7.1.25.2 - 1.0
put /v1/organization-accounts/parent
Description
move a specific account to a different OU
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | MoveAccountRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AccountMoveResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/organization-accounts/parent
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.0"
Request body
{
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"parent_unit_id": "ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5",
"target_account_ids": [
"b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0"
]
}
Example HTTP response
Response 200
{
"success_ids": [
{
"success_id": "b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0",
"success_name": "score-account",
"target_id": "ou-c29a138f8f1d78e24dbfa8681fc2fc8",
"target_name": "score-organization-unit"
}
]
}
7.1.26 - RemoveAccounts
7.1.26.1 - 1.1
delete /v1/organization-accounts
Description
Remove accounts from organization
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | RemoveAccountsRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AccountRemoveResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/organization-accounts
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.1"
Request body
{
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"target_account_ids": [
"b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0"
]
}
Example HTTP response
Response 200
{
"failed_ids": [
{
"error_code": "Organization.AccountNotRemovable",
"failed_caused": "Account b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 is not found",
"failed_id": "1a5xz23h1j0l9n8p7r6t5v4x3z2y1w0",
"failed_name": "score-account"
}
],
"success_ids": [
{
"success_id": "b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0",
"success_name": "score-account"
}
]
}
7.1.26.2 - 1.0
delete /v1/organization-accounts
Description
Remove accounts from organization
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | RemoveAccountsRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AccountRemoveResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/organization-accounts
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.0"
Request body
{
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"target_account_ids": [
"b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0"
]
}
Example HTTP response
Response 200
{
"failed_ids": [
{
"error_code": "Organization.AccountNotRemovable",
"failed_caused": "Account b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 is not found",
"failed_id": "1a5xz23h1j0l9n8p7r6t5v4x3z2y1w0",
"failed_name": "score-account"
}
],
"success_ids": [
{
"success_id": "b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0",
"success_name": "score-account"
}
]
}
7.1.27 - RemovePolicyBindings
7.1.27.1 - 1.1
delete /v1/assignments/policy-bindings
Description
remove policy bindings
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | PolicyRemoveRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ControlPolicyAssignmentResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/assignments/policy-bindings
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.1"
Request body
{
"entity": "POLICY",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"policy_ids": [
"f98e76d54c32b10a9z8y7x6w5v4u3"
],
"target_ids": [
"ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5"
]
}
Example HTTP response
Response 200
{
"failed_ids": [
{
"error_code": "Conflict",
"failed_caused": "Account 482d111a302547fbbd11ee0141ea23bb is not found",
"failed_id": "ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5"
}
],
"success_ids": [
"ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5"
]
}
7.1.27.2 - 1.0
delete /v1/assignments/policy-bindings
Description
remove policy bindings
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | PolicyRemoveRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ControlPolicyAssignmentResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/assignments/policy-bindings
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.0"
Request body
{
"entity": "POLICY",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"policy_ids": [
"f98e76d54c32b10a9z8y7x6w5v4u3"
],
"target_ids": [
"ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5"
]
}
Example HTTP response
Response 200
{
"failed_ids": [
{
"error_code": "Conflict",
"failed_caused": "Account 482d111a302547fbbd11ee0141ea23bb is not found",
"failed_id": "ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5"
}
],
"success_ids": [
"ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5"
]
}
7.1.28 - SetDelegationPolicy
7.1.28.1 - 1.1
put /v1/delegation-policies
Description
set a specific delegation policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | DelegationPolicySetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | DelegationPolicyShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/delegation-policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.1"
Request body
{
"document": {
"Statement": [
{
"Action": [
"organization:CreateServiceControlPolicy",
"organization:DeleteServiceControlPolicies",
"organization:SetServiceControlPolicy",
"organization:ShowServiceControlPolicy",
"organization:ListServiceControlPolicies",
"organization:ShowAccount",
"organization:ListAccounts",
"organization:ListOrganizationUnits",
"organization:ListOrganizationInvitations",
"organization:ListParents",
"organization:ListPoliciesForTarget",
"organization:ListTargetsForPolicy",
"organization:AttachPolicyBindings",
"organization:RemovePolicyBindings",
"organization:ShowDelegatePolicy"
],
"Effect": "Allow",
"Principal": {
"scp": [
"srn:dev2::f045159f40c64125a1fe61bd71d1c14c:::iam:user/e3a6e3f99c1040639e9a3c8f8b7427df"
]
},
"Resource": [
"*"
],
"Sid": "statement1"
}
],
"Version": "2024-07-01"
},
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5"
}
Example HTTP response
Response 200
{
"policy": {
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"document": {
"Statement": [
{
"Action": [
"organization:CreateServiceControlPolicy",
"organization:DeleteServiceControlPolicies",
"organization:SetServiceControlPolicy",
"organization:ShowServiceControlPolicy",
"organization:ListServiceControlPolicies",
"organization:ShowAccount",
"organization:ListAccounts",
"organization:ListOrganizationUnits",
"organization:ListOrganizationInvitations",
"organization:ListParents",
"organization:ListPoliciesForTarget",
"organization:ListTargetsForPolicy",
"organization:AttachPolicyBindings",
"organization:RemovePolicyBindings",
"organization:ShowDelegatePolicy"
],
"Effect": "Allow",
"Principal": {
"scp": [
"srn:dev2::f045159f40c64125a1fe61bd71d1c14c:::iam:user/e3a6e3f99c1040639e9a3c8f8b7427df"
]
},
"Resource": [
"*"
],
"Sid": "statement1"
}
],
"Version": "2024-07-01"
},
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5"
}
}
7.1.28.2 - 1.0
put /v1/delegation-policies
Description
set a specific delegation policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | DelegationPolicySetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | DelegationPolicyShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/delegation-policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.0"
Request body
{
"document": {
"Statement": [
{
"Action": [
"organization:CreateServiceControlPolicy",
"organization:DeleteServiceControlPolicies",
"organization:SetServiceControlPolicy",
"organization:ShowServiceControlPolicy",
"organization:ListServiceControlPolicies",
"organization:ShowAccount",
"organization:ListAccounts",
"organization:ListOrganizationUnits",
"organization:ListOrganizationInvitations",
"organization:ListParents",
"organization:ListPoliciesForTarget",
"organization:ListTargetsForPolicy",
"organization:AttachPolicyBindings",
"organization:RemovePolicyBindings",
"organization:ShowDelegatePolicy"
],
"Effect": "Allow",
"Principal": {
"scp": [
"srn:dev2::f045159f40c64125a1fe61bd71d1c14c:::iam:user/e3a6e3f99c1040639e9a3c8f8b7427df"
]
},
"Resource": [
"*"
],
"Sid": "statement1"
}
],
"Version": "2024-07-01"
},
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5"
}
Example HTTP response
Response 200
{
"policy": {
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"document": {
"Statement": [
{
"Action": [
"organization:CreateServiceControlPolicy",
"organization:DeleteServiceControlPolicies",
"organization:SetServiceControlPolicy",
"organization:ShowServiceControlPolicy",
"organization:ListServiceControlPolicies",
"organization:ShowAccount",
"organization:ListAccounts",
"organization:ListOrganizationUnits",
"organization:ListOrganizationInvitations",
"organization:ListParents",
"organization:ListPoliciesForTarget",
"organization:ListTargetsForPolicy",
"organization:AttachPolicyBindings",
"organization:RemovePolicyBindings",
"organization:ShowDelegatePolicy"
],
"Effect": "Allow",
"Principal": {
"scp": [
"srn:dev2::f045159f40c64125a1fe61bd71d1c14c:::iam:user/e3a6e3f99c1040639e9a3c8f8b7427df"
]
},
"Resource": [
"*"
],
"Sid": "statement1"
}
],
"Version": "2024-07-01"
},
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5"
}
}
7.1.29 - SetOrganization
7.1.29.1 - 1.1
put /v1/organizations/{organization_id}
Description
set a specific organization
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | organization_id required | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | string | None |
| body | body required | OrganizationSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | OrganizationShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/organizations/{organization_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.1"
Request body
{
"delegation_account_id": "124e7d6c5b4a3z2y1x0w9v8u7t6s5r",
"name": "My Organization",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"use_scp_yn": true
}
Example HTTP response
Response 200
{
"organization": {
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"creator_name": "John Doe na",
"delegation_account_id": "124e7d6c5b4a3z2y1x0w9v8u7t6s5r",
"id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"master_account_email": "admin@example.com",
"master_account_id": "9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"modifier_name": "Alice",
"name": "My Organization",
"root_unit_id": "r-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r",
"srn": "srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/organization/o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"use_scp_yn": true
}
}
7.1.29.2 - 1.0
put /v1/organizations/{organization_id}
Description
set a specific organization
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | organization_id required | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | string | None |
| body | body required | OrganizationSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | OrganizationShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/organizations/{organization_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.0"
Request body
{
"delegation_account_id": "124e7d6c5b4a3z2y1x0w9v8u7t6s5r",
"name": "My Organization",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"use_scp_yn": true
}
Example HTTP response
Response 200
{
"organization": {
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"creator_name": "John Doe na",
"delegation_account_id": "124e7d6c5b4a3z2y1x0w9v8u7t6s5r",
"id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"master_account_email": "admin@example.com",
"master_account_id": "9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"modifier_name": "Alice",
"name": "My Organization",
"root_unit_id": "r-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r",
"srn": "srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/organization/o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"use_scp_yn": true
}
}
7.1.30 - SetOrganizationUnit
7.1.30.1 - 1.1
put /v1/organization-units/{unit_id}
Description
set a specific organization unit
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | unit_id required | 조직 단위 ID Example : ou-c29a138f8f1d78e24dbfa8681fc2fc8 | string | None |
| body | body required | OrganizationUnitSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | OrganizationUnitShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/organization-units/{unit_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.1"
Request body
{
"description": "에스코어 조직 단위",
"name": "score-organization-unit",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5"
}
Example HTTP response
Response 200
{
"organization_unit": {
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"creator_name": "John Doe na",
"depth": 1,
"description": "에스코어 조직 단위",
"id": "ou-c29a138f8f1d78e24dbfa8681fc2fc8",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"modifier_name": "Alice",
"name": "score-organization-unit",
"parent_unit_id": "ou-fc8c29a138d78e24bf1fa86812fc8b",
"service_name": "Organization",
"srn": "srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/ou/ou-c29a138f8f1d78e24dbfa8681fc2fc8",
"type": "OU"
}
}
7.1.30.2 - 1.0
put /v1/organization-units/{unit_id}
Description
set a specific organization unit
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | unit_id required | 조직 단위 ID Example : ou-c29a138f8f1d78e24dbfa8681fc2fc8 | string | None |
| body | body required | OrganizationUnitSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | OrganizationUnitShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/organization-units/{unit_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.0"
Request body
{
"description": "에스코어 조직 단위",
"name": "score-organization-unit",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5"
}
Example HTTP response
Response 200
{
"organization_unit": {
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"creator_name": "John Doe na",
"depth": 1,
"description": "에스코어 조직 단위",
"id": "ou-c29a138f8f1d78e24dbfa8681fc2fc8",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"modifier_name": "Alice",
"name": "score-organization-unit",
"parent_unit_id": "ou-fc8c29a138d78e24bf1fa86812fc8b",
"service_name": "Organization",
"srn": "srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/ou/ou-c29a138f8f1d78e24dbfa8681fc2fc8",
"type": "OU"
}
}
7.1.31 - SetServiceControlPolicy
7.1.31.1 - 1.1
put /v1/service-control-policies/{policy_id}
Description
set a specific service control policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | policy_id required | 서비스 제어 정책 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
| body | body required | ServiceControlPolicySetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServiceControlPolicyShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/service-control-policies/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.1"
Request body
{
"description": "This is an example policy.",
"document": {
"Statement": [
{
"Action": [
"*"
],
"Effect": "Allow",
"Resource": [
"*"
],
"Sid": "statement1"
}
],
"Version": "2024-07-01"
},
"name": "MyPolicy",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5"
}
Example HTTP response
Response 200
{
"policy": {
"category": "SCP",
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"creator_name": "John Doe na",
"description": "This is an example policy.",
"document": {
"Statement": [
{
"Action": [
"*"
],
"Effect": "Allow",
"Resource": [
"*"
],
"Sid": "statement1"
}
],
"Version": "2024-07-01"
},
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"modifier_name": "Alice",
"name": "MyPolicy",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"service_name": "Organization",
"source": "ORGANIZATION",
"srn": "srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/service-control-policy/138c2fc8c29a449dbfa8681f8f1d78e2",
"state": "ACTIVE",
"type": "MANAGED"
}
}
7.1.31.2 - 1.0
put /v1/service-control-policies/{policy_id}
Description
set a specific service control policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | policy_id required | 서비스 제어 정책 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
| body | body required | ServiceControlPolicySetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServiceControlPolicyShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/service-control-policies/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.0"
Request body
{
"description": "This is an example policy.",
"document": {
"Statement": [
{
"Action": [
"*"
],
"Effect": "Allow",
"Resource": [
"*"
],
"Sid": "statement1"
}
],
"Version": "2024-07-01"
},
"name": "MyPolicy",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5"
}
Example HTTP response
Response 200
{
"policy": {
"category": "SCP",
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"creator_name": "John Doe na",
"description": "This is an example policy.",
"document": {
"Statement": [
{
"Action": [
"*"
],
"Effect": "Allow",
"Resource": [
"*"
],
"Sid": "statement1"
}
],
"Version": "2024-07-01"
},
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"modifier_name": "Alice",
"name": "MyPolicy",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"service_name": "Organization",
"source": "ORGANIZATION",
"srn": "srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/service-control-policy/138c2fc8c29a449dbfa8681f8f1d78e2",
"state": "ACTIVE",
"type": "MANAGED"
}
}
7.1.32 - ShowAccount
7.1.32.1 - 1.1
get /v1/organization-accounts/{account_id}
Description
show a specific account
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | account_id required | 조직 계정 ID Example : b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 | string | None |
| query | organization_id optional | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | any of [string, null] | None |
| query | lazy_policy optional | 연결된 정책 조회 여부 Example : True | any of [boolean, null] | True |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AccountShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/organization-accounts/{account_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.1"
Example HTTP response
Response 200
{
"account": {
"control_policies": [
{
"policy_id": "f98e76d54c32b10a9z8y7x6w5v4u3",
"policy_name": "test-policy-name"
}
],
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"creator_name": "John Doe na",
"email": "score@samsung.com",
"id": "0a36e0746dbf4908acf0357829701381",
"joined_method": "INVITED",
"joined_time": "2024-05-17T12:34:56.789Z",
"login_id": "log-archive@samsung.com",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"modifier_name": "Alice",
"name": "score-account",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"parent_unit_id": "ou-fc8c29a138d78e24bf1fa86812fc8b",
"parent_unit_name": "parent-unit-name",
"srn": "srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/account/b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0",
"state": "ACTIVE",
"type": "MEMBER"
}
}
7.1.32.2 - 1.0
get /v1/organization-accounts/{account_id}
Description
show a specific account
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | account_id required | 조직 계정 ID Example : b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 | string | None |
| query | organization_id optional | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | any of [string, null] | None |
| query | lazy_policy optional | 연결된 정책 조회 여부 Example : True | any of [boolean, null] | True |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AccountShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/organization-accounts/{account_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.0"
Example HTTP response
Response 200
{
"account": {
"control_policies": [
{
"policy_id": "f98e76d54c32b10a9z8y7x6w5v4u3",
"policy_name": "test-policy-name"
}
],
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"creator_name": "John Doe na",
"email": "score@samsung.com",
"id": "0a36e0746dbf4908acf0357829701381",
"joined_method": "INVITED",
"joined_time": "2024-05-17T12:34:56.789Z",
"login_id": "log-archive@samsung.com",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"modifier_name": "Alice",
"name": "score-account",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"parent_unit_id": "ou-fc8c29a138d78e24bf1fa86812fc8b",
"parent_unit_name": "parent-unit-name",
"srn": "srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/account/b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0",
"state": "ACTIVE",
"type": "MEMBER"
}
}
7.1.33 - ShowDelegationPolicy
7.1.33.1 - 1.1
get /v1/delegation-policies
Description
show a specific delegation policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | organization_id optional | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | DelegationPolicyShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/delegation-policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.1"
Example HTTP response
Response 200
{
"policy": {
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"document": {
"Statement": [
{
"Action": [
"organization:CreateServiceControlPolicy",
"organization:DeleteServiceControlPolicies",
"organization:SetServiceControlPolicy",
"organization:ShowServiceControlPolicy",
"organization:ListServiceControlPolicies",
"organization:ShowAccount",
"organization:ListAccounts",
"organization:ListOrganizationUnits",
"organization:ListOrganizationInvitations",
"organization:ListParents",
"organization:ListPoliciesForTarget",
"organization:ListTargetsForPolicy",
"organization:AttachPolicyBindings",
"organization:RemovePolicyBindings",
"organization:ShowDelegatePolicy"
],
"Effect": "Allow",
"Principal": {
"scp": [
"srn:dev2::f045159f40c64125a1fe61bd71d1c14c:::iam:user/e3a6e3f99c1040639e9a3c8f8b7427df"
]
},
"Resource": [
"*"
],
"Sid": "statement1"
}
],
"Version": "2024-07-01"
},
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5"
}
}
7.1.33.2 - 1.0
get /v1/delegation-policies
Description
show a specific delegation policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | organization_id optional | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | DelegationPolicyShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/delegation-policies
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.0"
Example HTTP response
Response 200
{
"policy": {
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"document": {
"Statement": [
{
"Action": [
"organization:CreateServiceControlPolicy",
"organization:DeleteServiceControlPolicies",
"organization:SetServiceControlPolicy",
"organization:ShowServiceControlPolicy",
"organization:ListServiceControlPolicies",
"organization:ShowAccount",
"organization:ListAccounts",
"organization:ListOrganizationUnits",
"organization:ListOrganizationInvitations",
"organization:ListParents",
"organization:ListPoliciesForTarget",
"organization:ListTargetsForPolicy",
"organization:AttachPolicyBindings",
"organization:RemovePolicyBindings",
"organization:ShowDelegatePolicy"
],
"Effect": "Allow",
"Principal": {
"scp": [
"srn:dev2::f045159f40c64125a1fe61bd71d1c14c:::iam:user/e3a6e3f99c1040639e9a3c8f8b7427df"
]
},
"Resource": [
"*"
],
"Sid": "statement1"
}
],
"Version": "2024-07-01"
},
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5"
}
}
7.1.34 - ShowOrganization
7.1.34.1 - 1.1
get /v1/organizations/{organization_id}
Description
show a specific organization
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | organization_id required | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | OrganizationShowResponse |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/organizations/{organization_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.1"
Example HTTP response
Response 200
{
"organization": {
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"creator_name": "John Doe na",
"delegation_account_id": "124e7d6c5b4a3z2y1x0w9v8u7t6s5r",
"id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"master_account_email": "admin@example.com",
"master_account_id": "9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"modifier_name": "Alice",
"name": "My Organization",
"root_unit_id": "r-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r",
"srn": "srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/organization/o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"use_scp_yn": true
}
}
7.1.34.2 - 1.0
get /v1/organizations/{organization_id}
Description
show a specific organization
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | organization_id required | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | OrganizationShowResponse |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/organizations/{organization_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.0"
Example HTTP response
Response 200
{
"organization": {
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"creator_name": "John Doe na",
"delegation_account_id": "124e7d6c5b4a3z2y1x0w9v8u7t6s5r",
"id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"master_account_email": "admin@example.com",
"master_account_id": "9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"modifier_name": "Alice",
"name": "My Organization",
"root_unit_id": "r-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r",
"srn": "srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/organization/o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"use_scp_yn": true
}
}
7.1.35 - ShowOrganizationUnit
7.1.35.1 - 1.1
get /v1/organization-units/{unit_id}
Description
show a specific organization unit
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | unit_id required | 조직 단위 ID Example : ou-c29a138f8f1d78e24dbfa8681fc2fc8 | string | None |
| query | organization_id optional | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | OrganizationUnitShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/organization-units/{unit_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.1"
Example HTTP response
Response 200
{
"organization_unit": {
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"creator_name": "John Doe na",
"depth": 1,
"description": "에스코어 조직 단위",
"id": "ou-c29a138f8f1d78e24dbfa8681fc2fc8",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"modifier_name": "Alice",
"name": "score-organization-unit",
"parent_unit_id": "ou-fc8c29a138d78e24bf1fa86812fc8b",
"service_name": "Organization",
"srn": "srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/ou/ou-c29a138f8f1d78e24dbfa8681fc2fc8",
"type": "OU"
}
}
7.1.35.2 - 1.0
get /v1/organization-units/{unit_id}
Description
show a specific organization unit
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | unit_id required | 조직 단위 ID Example : ou-c29a138f8f1d78e24dbfa8681fc2fc8 | string | None |
| query | organization_id optional | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | OrganizationUnitShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/organization-units/{unit_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.0"
Example HTTP response
Response 200
{
"organization_unit": {
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"creator_name": "John Doe na",
"depth": 1,
"description": "에스코어 조직 단위",
"id": "ou-c29a138f8f1d78e24dbfa8681fc2fc8",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"modifier_name": "Alice",
"name": "score-organization-unit",
"parent_unit_id": "ou-fc8c29a138d78e24bf1fa86812fc8b",
"service_name": "Organization",
"srn": "srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/ou/ou-c29a138f8f1d78e24dbfa8681fc2fc8",
"type": "OU"
}
}
7.1.36 - ShowServiceControlPolicy
7.1.36.1 - 1.1
get /v1/service-control-policies/{policy_id}
Description
show a specific service control policy
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | policy_id required | 서비스 제어 정책 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
| query | organization_id optional | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServiceControlPolicyShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/service-control-policies/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.1"
Example HTTP response
Response 200
{
"policy": {
"category": "SCP",
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"creator_name": "John Doe na",
"description": "This is an example policy.",
"document": {
"Statement": [
{
"Action": [
"*"
],
"Effect": "Allow",
"Resource": [
"*"
],
"Sid": "statement1"
}
],
"Version": "2024-07-01"
},
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"modifier_name": "Alice",
"name": "MyPolicy",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"service_name": "Organization",
"source": "ORGANIZATION",
"srn": "srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/service-control-policy/138c2fc8c29a449dbfa8681f8f1d78e2",
"state": "ACTIVE",
"type": "MANAGED"
}
}
7.1.36.2 - 1.0
get /v1/service-control-policies/{policy_id}
Description
show a specific service control policy
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20251231 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | policy_id required | 서비스 제어 정책 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
| query | organization_id optional | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServiceControlPolicyShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/service-control-policies/{policy_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = organization 1.0"
Example HTTP response
Response 200
{
"policy": {
"category": "SCP",
"created_at": "2024-12-19 01:09:05.000",
"created_by": "c23fb561c689455993874fa5d5ed4a2f",
"creator_name": "John Doe na",
"description": "This is an example policy.",
"document": {
"Statement": [
{
"Action": [
"*"
],
"Effect": "Allow",
"Resource": [
"*"
],
"Sid": "statement1"
}
],
"Version": "2024-07-01"
},
"id": "138c2fc8c29a449dbfa8681f8f1d78e2",
"modified_at": "2023-10-15 14:30:00",
"modified_by": "c23fb561c689455993874fa5d5ed4a2f",
"modifier_name": "Alice",
"name": "MyPolicy",
"organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5",
"service_name": "Organization",
"source": "ORGANIZATION",
"srn": "srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/service-control-policy/138c2fc8c29a449dbfa8681f8f1d78e2",
"state": "ACTIVE",
"type": "MANAGED"
}
}
7.2 - Models
7.2.1 - AccountCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| failed optional | 계정 생성 실패 정보 | any of [CreateAccountFailCaused, null] | |
| success optional | 계정 생성 성공 정보 | any of [CreateAccountSuccess, null] |
7.2.2 - AccountInvitation
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | 생성 일시 Example : 2024-12-19 01:09:05.000 | string (date-time) | |
| created_by required | 생성자 Example : c23fb561c689455993874fa5d5ed4a2f | string | |
| expired_time required | 초대 만료 일시 Example : 2024-04-30T12:34:56.789Z | string (date-time) | |
| id required | ID Example : 0a36e0746dbf4908acf0357829701381 | string | |
| master_account_email optional | 관리자 계정 이메일 Example : admin@example.com | any of [string, null] | |
| master_account_id required | 관리자 계정명 Example : 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r | string | |
| master_account_login_id optional | 로그인 ID Example : log-archive@samsung.com | any of [string, null] | |
| master_account_name optional | 관리자 계정명 Example : CoreKim | any of [string, null] | |
| modified_at required | 수정 일시 Example : 2023-10-15 14:30:00 | string (date-time) | |
| modified_by required | 수정자 Example : c23fb561c689455993874fa5d5ed4a2f | string | |
| organization_id required | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | string | |
| organization_name required | 조직 이름 Example : My Organization | string | |
| requested_time required | 초대 요청 일시 Example : 2024-04-17T12:34:56.789Z | string (date-time) | |
| state required | 초대 상태 Example : INVITING | enum (INVITING, REFUSED, INVITED, CANCELED, EXPIRED) | |
| target_account_id required | 초대 수신자 계정 ID Example : 338c2fc8c29a449dbfa8681f8f1d78e5 | string |
7.2.3 - AccountInvitationResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_invitations required | 받은 초대 목록 | array[AccountInvitation] | |
| count required | 받은 초대 수 Example : 5 | integer |
7.2.4 - AccountMoveResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| success_ids required | 계정 ID 목록 | array[MoveAccountSuccess] |
7.2.5 - AccountPageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| accounts required | 조직 계정 목록 | array[AccountSummary] | |
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
7.2.6 - AccountRemoveResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| failed_ids required | 실패 사유 | array[RemoveAccountFailCaused] | |
| success_ids required | 계정 ID 목록 | array[RemoveAccountSuccess] |
7.2.7 - AccountShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account required | 조직 계정 상세 정보 | OrganizationAccountWithPolicy |
7.2.8 - AccountSummary
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | 생성 일시 Example : 2024-12-19 01:09:05.000 | string (date-time) | |
| created_by required | 생성자 Example : c23fb561c689455993874fa5d5ed4a2f | string | |
| email optional | 계정 이메일 Example : score@samsung.com | any of [string, null] | |
| id required | ID Example : 0a36e0746dbf4908acf0357829701381 | string | |
| joined_method required | 가입 방법 Example : INVITED | enum (INVITED, CREATED, CLOUD_CONTROL) | |
| joined_time required | 가입 일시 Example : 2024-05-17T12:34:56.789Z | string (date-time) | |
| login_id optional | 로그인 ID Example : log-archive@samsung.com | any of [string, null] | |
| modified_at required | 수정 일시 Example : 2023-10-15 14:30:00 | string (date-time) | |
| modified_by required | 수정자 Example : c23fb561c689455993874fa5d5ed4a2f | string | |
| name optional | 계정명 Example : score-account | any of [string, null] | |
| organization_id required | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | string | |
| parent_unit_id required | ROOT 또는 부모 조직 단위 ID Example : ou-fc8c29a138d78e24bf1fa86812fc8b | string | |
| parent_unit_name required | ROOT 또는 부모 조직 단위명 Example : parent-unit-name | any of [string, null] | |
| state required | 계정 상태 Example : ACTIVE | enum (ACTIVE, SUSPENDED, PENDING_CLOSURE) | |
| type required | 계정 유형 Example : MEMBER | enum (MANAGEMENT, DELEGATION, MEMBER, NONE, LOG_ARCHIVE, AUDIT) |
7.2.9 - BindingTarget
| Name | Description | Schema | Default |
|---|---|---|---|
| id required | 조직 단위 ID 또는 조직 계정 ID Example : ou-c29a138f8f1d78e24dbfa8681fc2fc8 또는 b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 | any of [string, null] | |
| name required | 조직 단위명 또는 계정명 Example : score-organization-unit 또는 score-account | any of [string, null] | |
| type required | 타겟 유형 Example : OU | any of [string, null] |
7.2.10 - CombinedUnit
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at optional | 생성 일시 Example : 2024-12-19 01:09:05.000 | any of [string (date-time), null] | |
| depth optional | 계층(0~5) Example : 1 | any of [integer, null] | 1 |
| email optional | 계정 이메일 Example : score@samsung.com | any of [string, null] | |
| id required | 조직 단위 ID 또는 조직 계정 ID Example : ou-c29a138f8f1d78e24dbfa8681fc2fc8 | string | |
| joined_method optional | 가입 방법 Example : INVITED | any of [enum (INVITED, CREATED, CLOUD_CONTROL), null] | |
| joined_time optional | 가입 일시 Example : 2024-05-17T12:34:56.789Z | any of [string (date-time), null] | |
| login_id optional | 로그인 ID Example : log-archive@samsung.com | any of [string, null] | |
| name optional | 조직 단위명 또는 계정명 Example : score-organization-unit | any of [string, null] | - |
| organization_id required | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | string | |
| parent_unit_id optional | ROOT 또는 부모 조직 단위 ID Example : ou-fc8c29a138d78e24bf1fa86812fc8b | any of [string, null] | |
| type required | 유형(ROOT 또는 조직 단위) 또는 계정 유형 Example : MEMBER | string |
7.2.11 - CombinedUnitV1dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at optional | 생성 일시 Example : 2024-12-19 01:09:05.000 | any of [string (date-time), null] | |
| depth optional | 계층(0~5) Example : 1 | any of [integer, null] | 1 |
| email optional | 계정 이메일 Example : score@samsung.com | any of [string, null] | |
| id required | 조직 단위 ID 또는 조직 계정 ID Example : ou-c29a138f8f1d78e24dbfa8681fc2fc8 | string | |
| joined_method optional | 가입 방법 Example : INVITED | any of [enum (INVITED, CREATED, CLOUD_CONTROL), null] | |
| joined_time optional | 가입 일시 Example : 2024-05-17T12:34:56.789Z | any of [string (date-time), null] | |
| login_id optional | 로그인 ID Example : log-archive@samsung.com | any of [string, null] | |
| name optional | 조직 단위명 또는 계정명 Example : score-organization-unit | any of [string, null] | - |
| organization_id required | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | string | |
| parent_unit_id optional | ROOT 또는 부모 조직 단위 ID Example : ou-fc8c29a138d78e24bf1fa86812fc8b | any of [string, null] | |
| parent_unit_name optional | ROOT 또는 부모 조직 단위명 Example : parent-unit-name | any of [string, null] | |
| type required | 유형(ROOT 또는 조직 단위) 또는 계정 유형 Example : MEMBER | string |
7.2.12 - ConnectedPolicySummary
| Name | Description | Schema | Default |
|---|---|---|---|
| policy_id required | 제어 정책 ID Example : f98e76d54c32b10a9z8y7x6w5v4u3 | string | |
| policy_name required | 제어 정책 이름 Example : test-policy-name | string |
7.2.13 - ControlPolicyAssignmentFailCaused
| Name | Description | Schema | Default |
|---|---|---|---|
| error_code required | error code Example : Conflict | string | |
| failed_caused required | 실패 원인 Example : Account 482d111a302547fbbd11ee0141ea23bb is not found | string | |
| failed_id required | 실패 ID Example : ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 | string |
7.2.14 - ControlPolicyAssignmentResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| failed_ids required | array[ControlPolicyAssignmentFailCaused] | ||
| success_ids required | 성공 ID Example : ['ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5'] | array[string] |
7.2.15 - CreateAccountFailCaused
| Name | Description | Schema | Default |
|---|---|---|---|
| error_code required | error code Example : Organization.AccountNotRemovable | string | |
| failed_caused required | 실패 사유 Example : Account b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 is not found | string |
7.2.16 - CreateAccountSuccess
| Name | Description | Schema | Default |
|---|---|---|---|
| success_id required | 조직 계정 ID Example : b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 | string | |
| success_name required | 계정명 Example : score-account | string |
7.2.17 - DelegationPolicy
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | 생성 일시 Example : 2024-12-19 01:09:05.000 | string (date-time) | |
| created_by required | 생성자 Example : c23fb561c689455993874fa5d5ed4a2f | string | |
| document required | 위임 정책 문서 Example : {'Statement': [{'Action': ['organization:CreateServiceControlPolicy', 'organization:DeleteServiceControlPolicies', 'organization:SetServiceControlPolicy', 'organization:ShowServiceControlPolicy', 'organization:ListServiceControlPolicies', 'organization:ShowAccount', 'organization:ListAccounts', 'organization:ListOrganizationUnits', 'organization:ListOrganizationInvitations', 'organization:ListParents', 'organization:ListPoliciesForTarget', 'organization:ListTargetsForPolicy', 'organization:AttachPolicyBindings', 'organization:RemovePolicyBindings', 'organization:ShowDelegatePolicy'], 'Effect': 'Allow', 'Principal': {'scp': ['srn:dev2::f045159f40c64125a1fe61bd71d1c14c:::iam:user/e3a6e3f99c1040639e9a3c8f8b7427df']}, 'Resource': ['*'], 'Sid': 'statement1'}], 'Version': '2024-07-01'} | DelegationPolicyDocument | |
| modified_at required | 수정 일시 Example : 2023-10-15 14:30:00 | string (date-time) | |
| modified_by required | 수정자 Example : c23fb561c689455993874fa5d5ed4a2f | string | |
| organization_id required | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | string |
7.2.18 - DelegationPolicyCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| document required | 위임 정책 문서 Example : {'Statement': [{'Action': ['organization:CreateServiceControlPolicy', 'organization:DeleteServiceControlPolicies', 'organization:SetServiceControlPolicy', 'organization:ShowServiceControlPolicy', 'organization:ListServiceControlPolicies', 'organization:ShowAccount', 'organization:ListAccounts', 'organization:ListOrganizationUnits', 'organization:ListOrganizationInvitations', 'organization:ListParents', 'organization:ListPoliciesForTarget', 'organization:ListTargetsForPolicy', 'organization:AttachPolicyBindings', 'organization:RemovePolicyBindings', 'organization:ShowDelegatePolicy'], 'Effect': 'Allow', 'Principal': {'scp': ['srn:dev2::f045159f40c64125a1fe61bd71d1c14c:::iam:user/e3a6e3f99c1040639e9a3c8f8b7427df']}, 'Resource': ['*'], 'Sid': 'statement1'}], 'Version': '2024-07-01'} | DelegationPolicyDocument | |
| organization_id optional | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | any of [string, null] |
7.2.19 - DelegationPolicyDocument
| Name | Description | Schema | Default |
|---|---|---|---|
| Statement optional | 정책 문법 | array[DelegationPolicyStatement] | |
| Version optional | 정책 버전 Example : 2012-10-17 | string | 2012-10-17 |
7.2.20 - DelegationPolicySetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| document required | 위임 정책 문서 Example : {'Statement': [{'Action': ['organization:CreateServiceControlPolicy', 'organization:DeleteServiceControlPolicies', 'organization:SetServiceControlPolicy', 'organization:ShowServiceControlPolicy', 'organization:ListServiceControlPolicies', 'organization:ShowAccount', 'organization:ListAccounts', 'organization:ListOrganizationUnits', 'organization:ListOrganizationInvitations', 'organization:ListParents', 'organization:ListPoliciesForTarget', 'organization:ListTargetsForPolicy', 'organization:AttachPolicyBindings', 'organization:RemovePolicyBindings', 'organization:ShowDelegatePolicy'], 'Effect': 'Allow', 'Principal': {'scp': ['srn:dev2::f045159f40c64125a1fe61bd71d1c14c:::iam:user/e3a6e3f99c1040639e9a3c8f8b7427df']}, 'Resource': ['*'], 'Sid': 'statement1'}], 'Version': '2024-07-01'} | DelegationPolicyDocument | |
| organization_id optional | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | any of [string, null] |
7.2.21 - DelegationPolicyShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| policy required | DelegationPolicy |
7.2.22 - DelegationPolicyStatement
| Name | Description | Schema | Default |
|---|---|---|---|
| Action optional | 정책 액션 Example : ['s3:PutObject', 's3:GetObject'] | any of [array[string], null] | [‘s3:PutObject’, ‘s3:GetObject’] |
| Condition optional | 정책 요건 Example : | any of [object[object[array[object]]], null] | |
| Effect optional | 정책 효과 Example : Allow | string | Allow |
| NotAction optional | 정책 제외 액션 Example : | any of [array[string], null] | |
| Principal optional | 호출 주체 Example : | any of [string, object[array[string]], null] | |
| Resource optional | 리소스 Example : ['*'] | array[string] | [’*’] |
| Sid optional | 문법 ID Example : statement1 | string | statement1 |
7.2.23 - Invitation
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | 생성 일시 Example : 2024-12-19 01:09:05.000 | string (date-time) | |
| created_by required | 생성자 Example : c23fb561c689455993874fa5d5ed4a2f | string | |
| expired_time required | 초대 만료 일시 Example : 2024-04-30T12:34:56.789Z | string (date-time) | |
| id required | 초대 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | |
| master_account_id required | 관리자 계정 ID Example : 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r | string | |
| modified_at required | 수정 일시 Example : 2023-10-15 14:30:00 | string (date-time) | |
| modified_by required | 수정자 Example : c23fb561c689455993874fa5d5ed4a2f | string | |
| organization_id required | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | string | |
| requested_time required | 초대 요청 일시 Example : 2024-04-17T12:34:56.789Z | string (date-time) | |
| state required | 초대 상태 Example : REFUSED | enum (INVITING, REFUSED, INVITED, CANCELED, EXPIRED) | |
| target_account_id required | 초대 수신자 계정 ID Example : 338c2fc8c29a449dbfa8681f8f1d78e5 | string |
7.2.24 - InvitationAcceptFailCaused
| Name | Description | Schema | Default |
|---|---|---|---|
| error_code required | error code Example : Invitation.AlreadySentError | string | |
| failed_caused required | 실패 사유 Example : Account b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 is not found | string | |
| failed_id required | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | string | |
| failed_name required | 조직 이름 Example : My Organization | string |
7.2.25 - InvitationAcceptResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| failed_id optional | 초대 실패 조직 정보 | any of [InvitationAcceptFailCaused, null] | |
| master_account_email required | 계정 이메일 Example : score@samsung.com | any of [string, null] | |
| success_id optional | 초대 성공 조직 정보 | any of [InvitationAcceptSuccess, null] |
7.2.26 - InvitationAcceptSuccess
| Name | Description | Schema | Default |
|---|---|---|---|
| success_id required | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | string | |
| success_name required | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | string |
7.2.27 - InvitationCancelRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| ids required | 초대 ID Example : ['138c2fc8c29a449dbfa8681f8f1d78e2'] | array[string] | |
| organization_id optional | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | any of [string, null] |
7.2.28 - InvitationCancelResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| success_ids required | 초대 ID Example : ['138c2fc8c29a449dbfa8681f8f1d78e2'] | array[string] |
7.2.29 - InvitationCreateFailCaused
| Name | Description | Schema | Default |
|---|---|---|---|
| error_code required | error code Example : Invitation.AlreadySentError | string | |
| failed_caused required | 실패 사유 Example : Account b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 is not found | string | |
| failed_id required | 조직 초대 실패 Login ID 목록 Example : ['score-1@samsung.com'] | string |
7.2.30 - InvitationCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| organization_id optional | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | any of [string, null] | |
| target_login_ids required | 초대 수신자 계정 이메일 목록 Example : ['score-1@samsung.com'] | array[string] |
7.2.31 - InvitationCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| failed_ids required | array[InvitationCreateFailCaused] | ||
| success_ids required | 조직 초대 성공 Login ID 목록 Example : ['log-archive@samsung.com'] | array[string] |
7.2.32 - InvitationShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| invitation required | 초대 상세 정보 | Invitation |
7.2.33 - ListPoliciesForTargetResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| policies required | array[PoliciesForTargetSummary] | ||
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
7.2.34 - ListTargetsForPolicyResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] | |
| targets required | array[TargetsForPolicySummary] |
7.2.35 - MoveAccountRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| organization_id optional | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | any of [string, null] | |
| parent_unit_id required | ROOT ID 또는 조직 단위 ID Example : ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 | string | |
| target_account_ids required | 타겟 계정 아이디 목록 Example : ['b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0'] | array[string] |
7.2.36 - MoveAccountSuccess
| Name | Description | Schema | Default |
|---|---|---|---|
| success_id required | 조직 계정 ID Example : b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 | string | |
| success_name required | 계정명 Example : score-account | string | |
| target_id required | 조직 단위 ID Example : ou-c29a138f8f1d78e24dbfa8681fc2fc8 | string | |
| target_name required | 조직 단위명 Example : score-organization-unit | string |
7.2.37 - Organization
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | 생성 일시 Example : 2024-12-19 01:09:05.000 | string (date-time) | |
| created_by required | 생성자 Example : c23fb561c689455993874fa5d5ed4a2f | string | |
| creator_name optional | 생성자 성, 이름 Example : John Doe na | string | - |
| delegation_account_id optional | 위임 계정 Example : 124e7d6c5b4a3z2y1x0w9v8u7t6s5r | any of [string, null] | |
| id required | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | string | |
| master_account_email required | 관리자 계정 이메일 Example : admin@example.com | string | |
| master_account_id required | 관리자 계정 ID Example : 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r | string | |
| modified_at required | 수정 일시 Example : 2023-10-15 14:30:00 | string (date-time) | |
| modified_by required | 수정자 Example : c23fb561c689455993874fa5d5ed4a2f | string | |
| modifier_name optional | 수정자 성, 이름 Example : Alice | string | - |
| name required | 조직 이름 Example : My Organization | string | |
| root_unit_id required | 루트 유닛 ID Example : r-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r | string | |
| srn required | 조직 SRN Example : srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/organization/o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | string | |
| use_scp_yn required | 통제 정책 사용 여부 Example : True | boolean |
7.2.38 - OrganizationAccountWithPolicy
| Name | Description | Schema | Default |
|---|---|---|---|
| control_policies required | array[ConnectedPolicySummary] | ||
| created_at required | 생성 일시 Example : 2024-12-19 01:09:05.000 | string (date-time) | |
| created_by required | 생성자 Example : c23fb561c689455993874fa5d5ed4a2f | string | |
| creator_name optional | 생성자 성, 이름 Example : John Doe na | string | - |
| email optional | 계정 이메일 Example : score@samsung.com | any of [string, null] | |
| id required | ID Example : 0a36e0746dbf4908acf0357829701381 | string | |
| joined_method required | 가입 방법 Example : INVITED | enum (INVITED, CREATED, CLOUD_CONTROL) | |
| joined_time required | 가입 일시 Example : 2024-05-17T12:34:56.789Z | string (date-time) | |
| login_id optional | 로그인 ID Example : log-archive@samsung.com | any of [string, null] | |
| modified_at required | 수정 일시 Example : 2023-10-15 14:30:00 | string (date-time) | |
| modified_by required | 수정자 Example : c23fb561c689455993874fa5d5ed4a2f | string | |
| modifier_name optional | 수정자 성, 이름 Example : Alice | string | - |
| name optional | 계정명 Example : score-account | any of [string, null] | |
| organization_id required | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | string | |
| parent_unit_id required | ROOT 또는 부모 조직 단위 ID Example : ou-fc8c29a138d78e24bf1fa86812fc8b | string | |
| parent_unit_name required | ROOT 또는 부모 조직 단위명 Example : parent-unit-name | any of [string, null] | |
| srn optional | SRN Example : srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/account/b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 | any of [string, null] | |
| state required | 계정 상태 Example : ACTIVE | enum (ACTIVE, SUSPENDED, PENDING_CLOSURE) | |
| type required | 계정 유형 Example : MEMBER | enum (MANAGEMENT, DELEGATION, MEMBER, NONE, LOG_ARCHIVE, AUDIT) |
7.2.39 - OrganizationCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| name required | 조직 이름 Example : My OrganizationPattern : ^[a-zA-Z0-9\-.,_+=@ㄱ-ㅎㅏ-ㅣ가-힣 ]*$Minimum length : 1Maximum length : 20 | string |
7.2.40 - OrganizationDeleteFailCaused
| Name | Description | Schema | Default |
|---|---|---|---|
| error_code required | error code Example : Organization.delete.MemberAccountIsExist | string | |
| failed_caused required | 실패 사유 Example : Payment method registration required. | string | |
| failed_id required | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | array[string] |
7.2.41 - OrganizationDeleteResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| failed required | OrganizationDeleteFailCaused | ||
| success optional | 조직 이름 Example : My Organization | any of [string, null] |
7.2.42 - OrganizationInvitation
| Name | Description | Schema | Default |
|---|---|---|---|
| account_email optional | 관리자 계정 이메일 Example : admin@example.com | any of [string, null] | |
| account_name optional | 관리자 계정명 Example : CoreKim | any of [string, null] | |
| created_at required | 생성 일시 Example : 2024-12-19 01:09:05.000 | string (date-time) | |
| created_by required | 생성자 Example : c23fb561c689455993874fa5d5ed4a2f | string | |
| id required | ID Example : 0a36e0746dbf4908acf0357829701381 | string | |
| login_id optional | 로그인 ID Example : log-archive@samsung.com | any of [string, null] | |
| modified_at required | 수정 일시 Example : 2023-10-15 14:30:00 | string (date-time) | |
| modified_by required | 수정자 Example : c23fb561c689455993874fa5d5ed4a2f | string | |
| organization_id required | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | string | |
| state required | 초대 상태 Example : INVITING | enum (INVITING, REFUSED, INVITED, CANCELED, EXPIRED) | |
| target_account_id required | 관리자 계정명 Example : 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r | string |
7.2.43 - OrganizationInvitationPageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| organization_invitations required | 초대 목록 | array[OrganizationInvitation] | |
| page required | page Example : 0 | integer | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
7.2.44 - OrganizationLeaveFailCaused
| Name | Description | Schema | Default |
|---|---|---|---|
| error_code required | error code Example : Organization.AccountNotRemovable | string | |
| failed_caused required | 실패 사유 Example : Payment method registration required. | string | |
| failed_id required | 조직 계정 ID Example : b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 | string | |
| failed_name required | 조직 이름 Example : My Organization | string |
7.2.45 - OrganizationLeaveResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| failed optional | 계정 삭제 실패 정보 | any of [OrganizationLeaveFailCaused, null] | |
| success optional | 계정 삭제 성공 정보 | any of [OrganizationLeaveSuccess, null] |
7.2.46 - OrganizationLeaveSuccess
| Name | Description | Schema | Default |
|---|---|---|---|
| success_id required | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | string | |
| success_name required | 조직 이름 Example : My Organization | string |
7.2.47 - OrganizationPageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| organizations required | array[OrganizationSummary] | ||
| page required | page Example : 0 | integer | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
7.2.48 - OrganizationSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| delegation_account_id optional | 위임 계정 Example : 124e7d6c5b4a3z2y1x0w9v8u7t6s5r | any of [string, null] | |
| name optional | 조직 이름 Example : My OrganizationPattern : ^[a-zA-Z0-9\-.,_+=@ㄱ-ㅎㅏ-ㅣ가-힣 ]*$ | any of [string, null] | |
| organization_id optional | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | any of [string, null] | |
| use_scp_yn optional | 통제 정책 사용 여부 Example : True | any of [boolean, null] |
7.2.49 - OrganizationShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| organization required | Organization |
7.2.50 - OrganizationSummary
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | 생성 일시 Example : 2024-12-19 01:09:05.000 | string (date-time) | |
| created_by required | 생성자 Example : c23fb561c689455993874fa5d5ed4a2f | string | |
| delegation_account_id optional | 위임 계정 Example : 124e7d6c5b4a3z2y1x0w9v8u7t6s5r | any of [string, null] | |
| id required | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | string | |
| master_account_id required | 관리자 계정 ID Example : 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r | string | |
| modified_at required | 수정 일시 Example : 2023-10-15 14:30:00 | string (date-time) | |
| modified_by required | 수정자 Example : c23fb561c689455993874fa5d5ed4a2f | string | |
| name required | 조직 이름 Example : My Organization | string | |
| root_unit_id required | 루트 유닛 ID Example : r-abcd7d6c5b4a3z2y1x0w9v8u7t6s5r | string | |
| use_scp_yn required | 통제 정책 사용 여부 Example : True | boolean |
7.2.51 - OrganizationUnit
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | 생성 일시 Example : 2024-12-19 01:09:05.000 | string (date-time) | |
| created_by required | 생성자 Example : c23fb561c689455993874fa5d5ed4a2f | string | |
| creator_name optional | 생성자 성, 이름 Example : John Doe na | string | - |
| depth required | 계층(0~5) Example : 1 | integer | |
| description optional | 조직 단위 설명 Example : 에스코어 조직 단위 | any of [string, null] | |
| id required | 조직 단위 ID Example : ou-c29a138f8f1d78e24dbfa8681fc2fc8 | string | |
| modified_at required | 수정 일시 Example : 2023-10-15 14:30:00 | string (date-time) | |
| modified_by required | 수정자 Example : c23fb561c689455993874fa5d5ed4a2f | string | |
| modifier_name optional | 수정자 성, 이름 Example : Alice | string | - |
| name required | 조직 단위명 Example : score-organization-unit | string | |
| parent_unit_id optional | 유형(ROOT 또는 조직 단위) Example : ou-fc8c29a138d78e24bf1fa86812fc8b | any of [string, null] | |
| service_name required | 서비스명 Example : Organization | string | |
| srn optional | 조직 단위 SRN Example : srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/ou/ou-c29a138f8f1d78e24dbfa8681fc2fc8 | any of [string, null] | |
| type required | 유형(ROOT 또는 조직 단위) Example : OU | string |
7.2.52 - OrganizationUnitCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | 조직 단위 설명 Example : 에스코어 조직 단위 | any of [string, null] | |
| name required | 조직 단위명 Example : score-organization-unitMinimum length : 1Maximum length : 128 | string | |
| organization_id optional | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | any of [string, null] | |
| parent_unit_id optional | ROOT 또는 부모 조직 단위 ID Example : ou-fc8c29a138d78e24bf1fa86812fc8b | any of [string, null] | |
| policy_ids optional | 제어 정책 목록 ID Example : ['f98e76d54c32b10a9z8y7x6w5v4u3'] | any of [array[string], null] |
7.2.53 - OrganizationUnitCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| organization_unit required | 조직 단위 정보 | OrganizationUnitWithPolicy |
7.2.54 - OrganizationUnitDeleteFailCaused
| Name | Description | Schema | Default |
|---|---|---|---|
| error_code required | error code Example : Organization.UnitNotRemovable | string | |
| failed_caused required | 실패 사유 Example : Account b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 is not found | string | |
| failed_id required | 조직 단위 ID Example : ou-abc1f2h1j0l9n8p7r6t5v4x3z2y1w0 | string |
7.2.55 - OrganizationUnitDeleteRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| ids required | 조직 단위 ID 목록 Example : ['ou-c29a138f8f1d78e24dbfa8681fc2fc8'] | array[string] | |
| organization_id optional | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | any of [string, null] |
7.2.56 - OrganizationUnitDeleteResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| failed_ids required | array[OrganizationUnitDeleteFailCaused] | ||
| success_ids required | 조직 단위 ID 목록 Example : ['ou-c29a138f8f1d78e24dbfa8681fc2fc8'] | array[string] |
7.2.57 - OrganizationUnitListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| organization_units required | 조직 단위 목록 | array[CombinedUnit] |
7.2.58 - OrganizationUnitListResponseV1dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| organization_units required | 조직 단위 목록 | array[CombinedUnitV1dot1] |
7.2.59 - OrganizationUnitParentsResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| parents required | 부모 조직 단위 정보 | array[OrganizationUnit] |
7.2.60 - OrganizationUnitSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | 조직 단위 설명 Example : 에스코어 조직 단위 | any of [string, null] | |
| name optional | 조직 단위명 Example : score-organization-unit | any of [string, null] | |
| organization_id optional | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | any of [string, null] |
7.2.61 - OrganizationUnitShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| organization_unit required | 조직 단위 정보 | OrganizationUnit |
7.2.62 - OrganizationUnitWithPolicy
| Name | Description | Schema | Default |
|---|---|---|---|
| control_policies required | array[ConnectedPolicySummary] | ||
| created_at required | 생성 일시 Example : 2024-12-19 01:09:05.000 | string (date-time) | |
| created_by required | 생성자 Example : c23fb561c689455993874fa5d5ed4a2f | string | |
| creator_name optional | 생성자 성, 이름 Example : John Doe na | string | - |
| depth required | 계층(0~5) Example : 1 | integer | |
| description optional | 조직 단위 설명 Example : 에스코어 조직 단위 | any of [string, null] | |
| id required | 조직 단위 ID Example : ou-c29a138f8f1d78e24dbfa8681fc2fc8 | string | |
| modified_at required | 수정 일시 Example : 2023-10-15 14:30:00 | string (date-time) | |
| modified_by required | 수정자 Example : c23fb561c689455993874fa5d5ed4a2f | string | |
| modifier_name optional | 수정자 성, 이름 Example : Alice | string | - |
| name required | 조직 단위명 Example : score-organization-unit | string | |
| parent_unit_id optional | 유형(ROOT 또는 조직 단위) Example : ou-fc8c29a138d78e24bf1fa86812fc8b | any of [string, null] | |
| service_name required | 서비스명 Example : Organization | string | |
| srn optional | 조직 단위 SRN Example : srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/ou/ou-c29a138f8f1d78e24dbfa8681fc2fc8 | any of [string, null] | |
| type required | 유형(ROOT 또는 조직 단위) Example : OU | string |
7.2.63 - OrganizationUserCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| login_id required | 로그인 ID Example : log-archive@samsung.comMaximum length : 60 | string (email) | |
| name required | 계정명 Example : score-accountPattern : ^[a-zA-Z0-9ㄱ-ㅎㅏ-ㅣ가-힣 \+=_\-@\[\]\(\)\.,]*$Minimum length : 3Maximum length : 30 | string | |
| organization_id required | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | string | |
| role_name required | 역할명 Example : OrganizationAccountAccessRolePattern : ^[a-zA-Z0-9\+=,\.@_\-ㄱ-ㅎㅏ-ㅣ가-힣 ]*$Minimum length : 1Maximum length : 64 | string |
7.2.64 - PoliciesForTargetSummary
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | 생성 일시 Example : 2024-12-19 01:09:05.000 | string (date-time) | |
| created_by required | 생성자 Example : c23fb561c689455993874fa5d5ed4a2f | string | |
| id required | ID Example : 0a36e0746dbf4908acf0357829701381 | string | |
| link_types required | 연결 유형 Example : {'DIRECTED': [{'target_id': '1a2b3c4d5e6f7g8h9i0j1k2l3m4n5', 'target_name': 'example-target', 'target_type': 'OU'}], 'INHERITED': [{'target_id': '2a2b3c4d5e6f7g8h9i0j1k2l3m4n5', 'target_name': 'root', 'target_type': 'ROOT'}]} | object[array[PolicyLinkInfo]] | |
| modified_at required | 수정 일시 Example : 2023-10-15 14:30:00 | string (date-time) | |
| modified_by required | 수정자 Example : c23fb561c689455993874fa5d5ed4a2f | string | |
| policy_name required | 제어 정책 이름 Example : test-policy-name | string | |
| policy_type required | 제어 정책 유형 Example : SYSTEM_MANAGED | enum (SYSTEM_MANAGED, USER_DEFINED) | |
| source required | 정책 생성 주체 Example : ORGANIZATION | string |
7.2.65 - PolicyAttachRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| entity required | 개체 유형 Example : POLICY | enum (POLICY, TARGET) | |
| organization_id optional | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | any of [string, null] | |
| policy_ids required | 제어 정책 목록 ID Example : ['f98e76d54c32b10a9z8y7x6w5v4u3'] | array[string] | |
| target_ids required | 타겟 정보 Example : ['ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5'] | array[string] |
7.2.66 - PolicyLinkInfo
| Name | Description | Schema | Default |
|---|---|---|---|
| target_id required | 타겟 ID Example : ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 | string | |
| target_name required | 타겟명 Example : example-target | any of [string, null] | |
| target_type required | 타겟 유형 Example : OU | string |
7.2.67 - PolicyRemoveRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| entity required | 개체 유형 Example : POLICY | enum (POLICY, TARGET) | |
| organization_id optional | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | any of [string, null] | |
| policy_ids required | 제어 정책 목록 ID Example : ['f98e76d54c32b10a9z8y7x6w5v4u3'] | array[string] | |
| target_ids required | 타겟 정보 Example : ['ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5'] | array[string] |
7.2.68 - RemoveAccountFailCaused
| Name | Description | Schema | Default |
|---|---|---|---|
| error_code required | error code Example : Organization.AccountNotRemovable | string | |
| failed_caused required | 실패 사유 Example : Account b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 is not found | string | |
| failed_id required | 조직 계정 ID Example : 1a5xz23h1j0l9n8p7r6t5v4x3z2y1w0 | string | |
| failed_name required | 계정명 Example : score-account | string |
7.2.69 - RemoveAccountsRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| organization_id optional | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | any of [string, null] | |
| target_account_ids required | 타겟 계정 아이디 목록 Example : ['b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0'] | array[string] |
7.2.70 - RemoveAccountSuccess
| Name | Description | Schema | Default |
|---|---|---|---|
| success_id required | 조직 계정 ID Example : b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 | string | |
| success_name required | 계정명 Example : score-account | string |
7.2.71 - ServiceControlPolicy
| Name | Description | Schema | Default |
|---|---|---|---|
| category required | 정책 카테고리 Example : SCP | string | |
| created_at required | 생성 일시 Example : 2024-12-19 01:09:05.000 | string (date-time) | |
| created_by required | 생성자 Example : c23fb561c689455993874fa5d5ed4a2f | string | |
| creator_name optional | 생성자 성, 이름 Example : John Doe na | string | - |
| description required | 정책 설명 Example : This is an example policy. | any of [string, null] | |
| document required | 정책 문서 Example : {'Statement': [{'Action': ['*'], 'Effect': 'Allow', 'Resource': ['*'], 'Sid': 'statement1'}], 'Version': '2024-07-01'} | ServiceControlPolicyDocument | |
| id required | 서비스 제어 정책 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | |
| modified_at required | 수정 일시 Example : 2023-10-15 14:30:00 | string (date-time) | |
| modified_by required | 수정자 Example : c23fb561c689455993874fa5d5ed4a2f | string | |
| modifier_name optional | 수정자 성, 이름 Example : Alice | string | - |
| name required | 서비스 제어 정책 이름 Example : MyPolicy | string | |
| organization_id required | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | string | |
| service_name required | 서비스명 Example : Organization | string | |
| source required | 정책 생성 주체 Example : ORGANIZATION | string | |
| srn required | 정책 SRN Example : srn:dev2::1b8c29a138d78e24bf1fa86812fcaa:kr-west1::organizations/service-control-policy/138c2fc8c29a449dbfa8681f8f1d78e2 | string | |
| state required | 정책 상태 Example : ACTIVE | string | |
| type required | 서비스 제어 정책 유형 Example : MANAGED | string |
7.2.72 - ServiceControlPolicyCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description required | 정책 설명 Example : This is an example policy. | any of [string, null] | |
| document required | 정책 문서 Example : {'Statement': [{'Action': ['*'], 'Effect': 'Allow', 'Resource': ['*'], 'Sid': 'statement1'}], 'Version': '2024-07-01'} | ServiceControlPolicyDocument | |
| name required | 서비스 제어 정책 이름 Example : MyPolicyPattern : ^[a-zA-Z0-9\-.,_+=@ㄱ-ㅎㅏ-ㅣ가-힣]*$Minimum length : 3Maximum length : 128 | string | |
| organization_id required | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | string | |
| type optional | 서비스 제어 정책 유형 Example : MANAGED | enum (SYSTEM_MANAGED, USER_DEFINED) | USER_DEFINED |
7.2.73 - ServiceControlPolicyDeleteFailCaused
| Name | Description | Schema | Default |
|---|---|---|---|
| binding_targets required | array[BindingTarget] | ||
| error_code required | error code Example : Policy.PolicyInUseError | string | |
| failed_caused required | 실패 사유 Example : The specified policy is in use and cannot be deleted. | string | |
| failed_id required | 서비스 제어 정책 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string |
7.2.74 - ServiceControlPolicyDeleteRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| ids required | 서비스 제어 정책 목록ID Example : ['138c2fc8c29a449dbfa8681f8f1d78e2'] | array[string] | |
| organization_id required | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | string |
7.2.75 - ServiceControlPolicyDeleteResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| failed_ids required | array[ServiceControlPolicyDeleteFailCaused] | ||
| success_ids required | array[string] |
7.2.76 - ServiceControlPolicyDocument
| Name | Description | Schema | Default |
|---|---|---|---|
| Statement optional | 정책 문법 | array[ServiceControlPolicyStatement] | |
| Version optional | 정책 버전 Example : 2012-10-17 | string | 2012-10-17 |
7.2.77 - ServiceControlPolicyPageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| policies required | array[ServiceControlPolicySummary] | ||
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
7.2.78 - ServiceControlPolicySetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | 정책 설명 Example : This is an example policy. | any of [string, null] | |
| document optional | 정책 문서 Example : {'Statement': [{'Action': ['*'], 'Effect': 'Allow', 'Resource': ['*'], 'Sid': 'statement1'}], 'Version': '2024-07-01'} | any of [ServiceControlPolicyDocument, null] | |
| name optional | 서비스 제어 정책 이름 Example : MyPolicyPattern : ^[a-zA-Z0-9\-.,_+=@ㄱ-ㅎㅏ-ㅣ가-힣]*$ | any of [string, null] | |
| organization_id required | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | string |
7.2.79 - ServiceControlPolicyShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| policy required | ServiceControlPolicy |
7.2.80 - ServiceControlPolicyStatement
| Name | Description | Schema | Default |
|---|---|---|---|
| Action optional | 정책 액션 Example : ['s3:PutObject', 's3:GetObject'] | any of [array[string], null] | [‘s3:PutObject’, ‘s3:GetObject’] |
| Condition optional | 정책 요건 Example : | any of [object[object[array[object]]], null] | |
| Effect optional | 정책 효과 Example : Allow | string | Allow |
| NotAction optional | 정책 제외 액션 Example : | any of [array[string], null] | |
| Principal optional | 호출 주체 Example : | any of [string, object[array[string]], null] | |
| Resource optional | 리소스 Example : ['*'] | array[string] | [’*’] |
| Sid optional | 문법 ID Example : statement1 | string | statement1 |
7.2.81 - ServiceControlPolicySummary
| Name | Description | Schema | Default |
|---|---|---|---|
| category required | 정책 카테고리 Example : SCP | string | |
| created_at required | 생성 일시 Example : 2024-12-19 01:09:05.000 | string (date-time) | |
| created_by required | 생성자 Example : c23fb561c689455993874fa5d5ed4a2f | string | |
| creator_name optional | 생성자 성, 이름 Example : John Doe na | string | - |
| description required | 정책 설명 Example : This is an example policy. | any of [string, null] | |
| document required | 정책 문서 Example : {'Statement': [{'Action': ['*'], 'Effect': 'Allow', 'Resource': ['*'], 'Sid': 'statement1'}], 'Version': '2024-07-01'} | ServiceControlPolicyDocument | |
| id required | 서비스 제어 정책 ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | |
| modified_at required | 수정 일시 Example : 2023-10-15 14:30:00 | string (date-time) | |
| modified_by required | 수정자 Example : c23fb561c689455993874fa5d5ed4a2f | string | |
| modifier_name optional | 수정자 성, 이름 Example : Alice | string | - |
| name required | 서비스 제어 정책 이름 Example : MyPolicy | string | |
| organization_id required | 조직 ID Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 | string | |
| source required | 정책 생성 주체 Example : ORGANIZATION | string | |
| state required | 정책 상태 Example : ACTIVE | string | |
| type required | 서비스 제어 정책 유형 Example : MANAGED | string |
7.2.82 - TargetsForPolicySummary
| Name | Description | Schema | Default |
|---|---|---|---|
| control_policies required | 통제 정책 아이디 목록 | array[ConnectedPolicySummary] | |
| created_at required | 생성 일시 Example : 2024-12-19 01:09:05.000 | string (date-time) | |
| created_by required | 생성자 Example : c23fb561c689455993874fa5d5ed4a2f | string | |
| id required | ID Example : 0a36e0746dbf4908acf0357829701381 | string | |
| modified_at required | 수정 일시 Example : 2023-10-15 14:30:00 | string (date-time) | |
| modified_by required | 수정자 Example : c23fb561c689455993874fa5d5ed4a2f | string | |
| target_name required | 타겟명 Example : example-target | any of [string, null] |
8 - Quota Service
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.
본 가이드는 할당량 관리 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | DEPRECATED | 20260223 |
| 1.1 | DEPRECATED | 20260223 |
| 1.2 | CURRENT | - |
OpenAPI URL
https://quota.{environment}.samsungsdscloud.com
Environment and Region List
| environment | region |
|---|---|
| s | kr-west1 |
| s | kr-east1 |
| g | kr-south1 |
| g | kr-south2 |
| g | kr-south3 |
| e | kr-west1 |
| e | kr-east1 |
8.1 - APIs
8.1.1 - ListAccountQuota
8.1.1.1 - 1.2
get /v1/account-quotas
Description
account quota 목록 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | request_class optional | Request Class Example : Account | any of [string, null] | None |
| query | service optional | Service Name Example : IAM | any of [string, null] | None |
| query | quota_item optional | Quota Item Name Example : QUOTA.REQUEST.COUNT | any of [string, null] | None |
| query | description optional | Description Example : Virtual Server disk max size | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AccountQuotaListResponseV1dot1 |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/account-quotas
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = quota 1.2"
Example HTTP response
Response 200
{
"account_quotas": [
{
"account_id": "2b7ed60576ce404bbc734266ff1839a5",
"account_name": "Example Account Inc.",
"adjustable": true,
"applied_value": 200,
"approval": false,
"class_value": "Global",
"created_at": "2024-05-17T00:23:17Z",
"description": "Maximum disk size for virtual servers in the account",
"free_rate": 10,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"initial_value": 100,
"max_per_account": 1000,
"modified_at": "2024-05-17T00:23:17Z",
"quota_item": "QUOTA.REQUEST.COUNT",
"reduction": false,
"request": false,
"request_class": "Account",
"resource_type": "account-quota",
"service": "Virtual Server",
"srn": "srn:s::1651c68f8c664df580b55fa12345678:::quota:account-quota/9b088c6bc57c4a50a4620fb312345678",
"unit": "GB"
}
],
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
8.1.1.2 - 1.1
get /v1/account-quotas
Description
account quota 목록 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | request_class optional | Request Class Example : Account | any of [string, null] | None |
| query | service optional | Service Name Example : IAM | any of [string, null] | None |
| query | quota_item optional | Quota Item Name Example : QUOTA.REQUEST.COUNT | any of [string, null] | None |
| query | description optional | Description Example : Virtual Server disk max size | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AccountQuotaListResponseV1dot1 |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/account-quotas
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = quota 1.1"
Example HTTP response
Response 200
{
"account_quotas": [
{
"account_id": "2b7ed60576ce404bbc734266ff1839a5",
"account_name": "Example Account Inc.",
"adjustable": true,
"applied_value": 200,
"approval": false,
"class_value": "Global",
"created_at": "2024-05-17T00:23:17Z",
"description": "Maximum disk size for virtual servers in the account",
"free_rate": 10,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"initial_value": 100,
"max_per_account": 1000,
"modified_at": "2024-05-17T00:23:17Z",
"quota_item": "QUOTA.REQUEST.COUNT",
"reduction": false,
"request": false,
"request_class": "Account",
"resource_type": "account-quota",
"service": "Virtual Server",
"srn": "srn:s::1651c68f8c664df580b55fa12345678:::quota:account-quota/9b088c6bc57c4a50a4620fb312345678",
"unit": "GB"
}
],
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
8.1.1.3 - 1.0
get /v1/account-quotas
Description
account quota 목록 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | request_class optional | Request Class Example : Account | any of [string, null] | None |
| query | service optional | Service Name Example : IAM | any of [string, null] | None |
| query | quota_item optional | Quota Item Name Example : QUOTA.REQUEST.COUNT | any of [string, null] | None |
| query | description optional | Description Example : Virtual Server disk max size | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AccountQuotaListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/account-quotas
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = quota 1.0"
Example HTTP response
Response 200
{
"account_quotas": [
{
"account_id": "2b7ed60576ce404bbc734266ff1839a5",
"account_name": "Example Account Inc.",
"adjustable": true,
"applied_value": 200,
"approval": false,
"class_value": "Global",
"created_at": "2024-05-17T00:23:17Z",
"description": "Maximum disk size for virtual servers in the account",
"free_rate": 10,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"initial_value": 100,
"modified_at": "2024-05-17T00:23:17Z",
"quota_item": "QUOTA.REQUEST.COUNT",
"reduction": false,
"request": false,
"request_class": "Account",
"resource_type": "account-quota",
"service": "Virtual Server",
"srn": "srn:s::1651c68f8c664df580b55fa12345678:::quota:account-quota/9b088c6bc57c4a50a4620fb312345678",
"unit": "GB"
}
],
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
8.1.2 - ListQuotaRequests
8.1.2.1 - 1.2
get /v1/quota-requests
Description
quota request 목록 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | service optional | Service Name Example : Virtual Server | any of [string, null] | None |
| query | quota_item optional | Quota Item Name Example : QUOTA.REQUEST.COUNT | any of [string, null] | None |
| query | requester optional | Requester Information Example : cloud.kim | any of [string, null] | None |
| query | request_class optional | Request Class Example : Account | any of [string, null] | None |
| query | requested_start_at optional | Start date of the request Example : 2024-05-01 | any of [string (date-time), null] | None |
| query | requested_end_at optional | End date of the request Example : 2024-05-31 | any of [string (date-time), null] | None |
| query | applied_start_at optional | Start date of the application Example : 2024-05-01 | any of [string (date-time), null] | None |
| query | applied_end_at optional | End date of the application Example : 2024-05-31 | any of [string (date-time), null] | None |
| query | state optional | Request State Example : BEFORE_APPROVE | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | QuotaRequestListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quota-requests
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = quota 1.2"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"quota_requests": [
{
"applied_at": "2024-05-17T00:23:17Z",
"applied_value": 200,
"approval_message": "Quota increase request message.",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"free_rate": 10,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"initial_value": 100,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"quota_item": "QUOTA.REQUEST.COUNT",
"request_class": "Account",
"request_message": "Quota increase request message.",
"request_value": 300,
"requester": "cloudkim",
"service": "Virtual Server",
"state": "BEFORE_APPROVE",
"unit": "GB"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
8.1.2.2 - 1.1
get /v1/quota-requests
Description
quota request 목록 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | service optional | Service Name Example : Virtual Server | any of [string, null] | None |
| query | quota_item optional | Quota Item Name Example : QUOTA.REQUEST.COUNT | any of [string, null] | None |
| query | requester optional | Requester Information Example : cloud.kim | any of [string, null] | None |
| query | request_class optional | Request Class Example : Account | any of [string, null] | None |
| query | requested_start_at optional | Start date of the request Example : 2024-05-01 | any of [string (date-time), null] | None |
| query | requested_end_at optional | End date of the request Example : 2024-05-31 | any of [string (date-time), null] | None |
| query | applied_start_at optional | Start date of the application Example : 2024-05-01 | any of [string (date-time), null] | None |
| query | applied_end_at optional | End date of the application Example : 2024-05-31 | any of [string (date-time), null] | None |
| query | state optional | Request State Example : BEFORE_APPROVE | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | QuotaRequestListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quota-requests
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = quota 1.1"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"quota_requests": [
{
"applied_at": "2024-05-17T00:23:17Z",
"applied_value": 200,
"approval_message": "Quota increase request message.",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"free_rate": 10,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"initial_value": 100,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"quota_item": "QUOTA.REQUEST.COUNT",
"request_class": "Account",
"request_message": "Quota increase request message.",
"request_value": 300,
"requester": "cloudkim",
"service": "Virtual Server",
"state": "BEFORE_APPROVE",
"unit": "GB"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
8.1.2.3 - 1.0
get /v1/quota-requests
Description
quota request 목록 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | service optional | Service Name Example : Virtual Server | any of [string, null] | None |
| query | quota_item optional | Quota Item Name Example : QUOTA.REQUEST.COUNT | any of [string, null] | None |
| query | requester optional | Requester Information Example : cloud.kim | any of [string, null] | None |
| query | request_class optional | Request Class Example : Account | any of [string, null] | None |
| query | requested_start_at optional | Start date of the request Example : 2024-05-01 | any of [string (date-time), null] | None |
| query | requested_end_at optional | End date of the request Example : 2024-05-31 | any of [string (date-time), null] | None |
| query | applied_start_at optional | Start date of the application Example : 2024-05-01 | any of [string (date-time), null] | None |
| query | applied_end_at optional | End date of the application Example : 2024-05-31 | any of [string (date-time), null] | None |
| query | state optional | Request State Example : BEFORE_APPROVE | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | QuotaRequestListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quota-requests
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = quota 1.0"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"quota_requests": [
{
"applied_at": "2024-05-17T00:23:17Z",
"applied_value": 200,
"approval_message": "Quota increase request message.",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"free_rate": 10,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"initial_value": 100,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"quota_item": "QUOTA.REQUEST.COUNT",
"request_class": "Account",
"request_message": "Quota increase request message.",
"request_value": 300,
"requester": "cloudkim",
"service": "Virtual Server",
"state": "BEFORE_APPROVE",
"unit": "GB"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
8.1.3 - ShowAccountQuota
8.1.3.1 - 1.2
get /v1/account-quotas/{account_quota_id}
Description
account quota 상세 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | account_quota_id required | Account Quota ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AccountQuotaShowResponseV1dot1 |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/account-quotas/{account_quota_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = quota 1.2"
Example HTTP response
Response 200
{
"account_quota": {
"account_id": "2b7ed60576ce404bbc734266ff1839a5",
"account_name": "Example Account Inc.",
"adjustable": true,
"applied_value": 200,
"approval": false,
"class_value": "Global",
"created_at": "2024-05-17T00:23:17Z",
"description": "Maximum disk size for virtual servers in the account",
"free_rate": 10,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"initial_value": 100,
"max_per_account": 1000,
"modified_at": "2024-05-17T00:23:17Z",
"quota_item": "QUOTA.REQUEST.COUNT",
"reduction": false,
"request": false,
"request_class": "Account",
"resource_type": "account-quota",
"service": "Virtual Server",
"srn": "srn:s::1651c68f8c664df580b55fa12345678:::quota:account-quota/9b088c6bc57c4a50a4620fb312345678",
"unit": "GB"
}
}
8.1.3.2 - 1.1
get /v1/account-quotas/{account_quota_id}
Description
account quota 상세 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | account_quota_id required | Account Quota ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AccountQuotaShowResponseV1dot1 |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/account-quotas/{account_quota_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = quota 1.1"
Example HTTP response
Response 200
{
"account_quota": {
"account_id": "2b7ed60576ce404bbc734266ff1839a5",
"account_name": "Example Account Inc.",
"adjustable": true,
"applied_value": 200,
"approval": false,
"class_value": "Global",
"created_at": "2024-05-17T00:23:17Z",
"description": "Maximum disk size for virtual servers in the account",
"free_rate": 10,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"initial_value": 100,
"max_per_account": 1000,
"modified_at": "2024-05-17T00:23:17Z",
"quota_item": "QUOTA.REQUEST.COUNT",
"reduction": false,
"request": false,
"request_class": "Account",
"resource_type": "account-quota",
"service": "Virtual Server",
"srn": "srn:s::1651c68f8c664df580b55fa12345678:::quota:account-quota/9b088c6bc57c4a50a4620fb312345678",
"unit": "GB"
}
}
8.1.3.3 - 1.0
get /v1/account-quotas/{account_quota_id}
Description
account quota 상세 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | account_quota_id required | Account Quota ID Example : 138c2fc8c29a449dbfa8681f8f1d78e2 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AccountQuotaShowResponse |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/account-quotas/{account_quota_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = quota 1.0"
Example HTTP response
Response 200
{
"account_quota": {
"account_id": "2b7ed60576ce404bbc734266ff1839a5",
"account_name": "Example Account Inc.",
"adjustable": true,
"applied_value": 200,
"approval": false,
"class_value": "Global",
"created_at": "2024-05-17T00:23:17Z",
"description": "Maximum disk size for virtual servers in the account",
"free_rate": 10,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"initial_value": 100,
"modified_at": "2024-05-17T00:23:17Z",
"quota_item": "QUOTA.REQUEST.COUNT",
"reduction": false,
"request": false,
"request_class": "Account",
"resource_type": "account-quota",
"service": "Virtual Server",
"srn": "srn:s::1651c68f8c664df580b55fa12345678:::quota:account-quota/9b088c6bc57c4a50a4620fb312345678",
"unit": "GB"
}
}
8.1.4 - ShowQuotaRequest
8.1.4.1 - 1.2
get /v1/quota-requests/{request_id}
Description
quota request 상세 조회
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.2 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | request_id required | Request ID Example : 0c2a06f2f06d42248a6bb88b1a78d4cc | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | QuotaRequestShowResponse |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quota-requests/{request_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = quota 1.2"
Example HTTP response
Response 200
{
"quota_request": {
"account_quota_id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"applied_at": "2024-05-17T00:23:17Z",
"applied_value": 200,
"approval_message": "Quota increase request message.",
"class_value": "Global",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Maximum disk size for virtual servers in the account",
"free_rate": 10,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"initial_value": 100,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"quota_item": "QUOTA.REQUEST.COUNT",
"reduction": false,
"request_message": "Quota increase request message.",
"request_value": 300,
"requester": "cloudkim",
"state": "BEFORE_APPROVE",
"unit": "GB"
}
}
8.1.4.2 - 1.1
get /v1/quota-requests/{request_id}
Description
quota request 상세 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | request_id required | Request ID Example : 0c2a06f2f06d42248a6bb88b1a78d4cc | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | QuotaRequestShowResponse |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quota-requests/{request_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = quota 1.1"
Example HTTP response
Response 200
{
"quota_request": {
"account_quota_id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"applied_at": "2024-05-17T00:23:17Z",
"applied_value": 200,
"approval_message": "Quota increase request message.",
"class_value": "Global",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Maximum disk size for virtual servers in the account",
"free_rate": 10,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"initial_value": 100,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"quota_item": "QUOTA.REQUEST.COUNT",
"reduction": false,
"request_message": "Quota increase request message.",
"request_value": 300,
"requester": "cloudkim",
"state": "BEFORE_APPROVE",
"unit": "GB"
}
}
8.1.4.3 - 1.0
get /v1/quota-requests/{request_id}
Description
quota request 상세 조회
상태 ACTIVE (DEPRECATED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260223 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | request_id required | Request ID Example : 0c2a06f2f06d42248a6bb88b1a78d4cc | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | QuotaRequestShowResponse |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/quota-requests/{request_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = quota 1.0"
Example HTTP response
Response 200
{
"quota_request": {
"account_quota_id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"applied_at": "2024-05-17T00:23:17Z",
"applied_value": 200,
"approval_message": "Quota increase request message.",
"class_value": "Global",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "Maximum disk size for virtual servers in the account",
"free_rate": 10,
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"initial_value": 100,
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"quota_item": "QUOTA.REQUEST.COUNT",
"reduction": false,
"request_message": "Quota increase request message.",
"request_value": 300,
"requester": "cloudkim",
"state": "BEFORE_APPROVE",
"unit": "GB"
}
}
8.2 - Models
8.2.1 - AccountQuota
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Unique identifier for the account Example : 2b7ed60576ce404bbc734266ff1839a5 | string | |
| account_name required | Name of the account Example : Example Account Inc. | string | |
| adjustable required | Flag indicating if additional quota is being requested Example : True | boolean | |
| applied_value optional | Modified quota value after changes Example : 200 | any of [integer, null] | |
| approval required | Approval Example : False | boolean | |
| class_value required | Value associated with the request class Example : Global | string | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| description required | Detailed description of the quota item Example : Maximum disk size for virtual servers in the account | string | |
| free_rate required | Free Rate Example : 10 | integer | |
| id required | Account Quota ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| initial_value required | Initial quota value allocated Example : 100 | integer | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| quota_item required | Specific quota item within the resource Example : QUOTA.REQUEST.COUNT | string | |
| reduction optional | Reduction Example : False | boolean | |
| request optional | Request Example : False | boolean | |
| request_class required | Request Class Example : Account | string | |
| resource_type required | Type of the resource Example : account-quota | string | |
| service required | Name of the service to which quota applies Example : Virtual Server | string | |
| srn required | Service Resource Name for the quota item Example : srn:s::1651c68f8c664df580b55fa12345678:::quota:account-quota/9b088c6bc57c4a50a4620fb312345678 | string | |
| unit required | Unit in which the quota value is measured Example : GB | string |
8.2.2 - AccountQuota1dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Unique identifier for the account Example : 2b7ed60576ce404bbc734266ff1839a5 | string | |
| account_name required | Name of the account Example : Example Account Inc. | string | |
| adjustable required | Flag indicating if additional quota is being requested Example : True | boolean | |
| applied_value optional | Modified quota value after changes Example : 200 | any of [integer, null] | |
| approval required | Approval Example : False | boolean | |
| class_value required | Value associated with the request class Example : Global | string | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| description required | Detailed description of the quota item Example : Maximum disk size for virtual servers in the account | string | |
| free_rate required | Free Rate Example : 10 | integer | |
| id required | Account Quota ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| initial_value required | Initial quota value allocated Example : 100 | integer | |
| max_per_account required | Max per Account Value Example : 1000Minimum : 1Maximum : 999999999 | integer | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| quota_item required | Specific quota item within the resource Example : QUOTA.REQUEST.COUNT | string | |
| reduction optional | Reduction Example : False | boolean | |
| request optional | Request Example : False | boolean | |
| request_class required | Request Class Example : Account | string | |
| resource_type required | Type of the resource Example : account-quota | string | |
| service required | Name of the service to which quota applies Example : Virtual Server | string | |
| srn required | Service Resource Name for the quota item Example : srn:s::1651c68f8c664df580b55fa12345678:::quota:account-quota/9b088c6bc57c4a50a4620fb312345678 | string | |
| unit required | Unit in which the quota value is measured Example : GB | string |
8.2.3 - AccountQuotaListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_quotas required | array[AccountQuota] | ||
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
8.2.4 - AccountQuotaListResponseV1dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| account_quotas required | array[AccountQuota1dot1] | ||
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
8.2.5 - AccountQuotaShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_quota required | AccountQuota |
8.2.6 - AccountQuotaShowResponseV1dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| account_quota required | AccountQuota1dot1 |
8.2.7 - QuotaRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| applied_at optional | Applied At Example : 2024-05-17T00:23:17Z | any of [string (date-time), null] | |
| applied_value required | Applied Value Example : 200 | any of [integer, null] | |
| approval_message optional | Request message Example : Quota increase request message. | any of [string, null] | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| free_rate optional | Free Rate Example : 10 | any of [integer, null] | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| initial_value required | Initial Value Example : 100 | integer | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| quota_item required | Quota Item Name Example : QUOTA.REQUEST.COUNT | string | |
| request_class required | Request Class Example : Account | string | |
| request_message required | Request message Example : Quota increase request message. | string | |
| request_value required | User Request Value Example : 300 | integer | |
| requester required | Requester Example : cloudkim | string | |
| service required | Service Name Example : Virtual Server | string | |
| state required | Request State Example : BEFORE_APPROVE | enum (BEFORE_APPROVE, PARTIAL_APPROVED, REFUSED, HOLDING, APPROVED, AUTO_REDUCED) | |
| unit required | Unit in which the quota value is measured Example : GB | string |
8.2.8 - QuotaRequestDetail
| Name | Description | Schema | Default |
|---|---|---|---|
| account_quota_id required | Account Quota ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| applied_at optional | Applied At Example : 2024-05-17T00:23:17Z | any of [string (date-time), null] | |
| applied_value required | Applied Value Example : 200 | any of [integer, null] | |
| approval_message optional | Request message Example : Quota increase request message. | any of [string, null] | |
| class_value required | Value associated with the request class Example : Global | string | |
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| description required | Detailed description of the quota item Example : Maximum disk size for virtual servers in the account | string | |
| free_rate optional | Free Rate Example : 10 | any of [integer, null] | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| initial_value required | Initial Value Example : 100 | integer | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| quota_item required | Quota Item Name Example : QUOTA.REQUEST.COUNT | string | |
| reduction required | Reduction Example : False | boolean | |
| request_message required | Request message Example : Quota increase request message. | string | |
| request_value required | User Request Value Example : 300 | integer | |
| requester required | Requester Example : cloudkim | string | |
| state required | Request State Example : BEFORE_APPROVE | enum (BEFORE_APPROVE, PARTIAL_APPROVED, REFUSED, HOLDING, APPROVED, AUTO_REDUCED) | |
| unit required | Unit in which the quota value is measured Example : GB | string |
8.2.9 - QuotaRequestListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| quota_requests required | array[QuotaRequest] | ||
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
8.2.10 - QuotaRequestShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| quota_request required | QuotaRequestDetail |
9 - Resource Manager
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.
본 가이드는 Resourcemanager 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
OpenAPI URL
https://resourcemanager.{environment}.samsungsdscloud.com
Environment and Region List
| environment | region |
|---|---|
| s | kr-west1 |
| s | kr-east1 |
| g | kr-south1 |
| g | kr-south2 |
| g | kr-south3 |
| e | kr-west1 |
| e | kr-east1 |
9.1 - APIs
9.1.1 - CreateResourceGroup
9.1.1.1 - 1.0
post /v1/resource-groups
Description
create a resource_group
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ResourceGroupCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | ResourceGroupCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/resource-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = resourcemanager 1.0"
Request body
{
"description": "resource group 1",
"name": "resource-group-1",
"region": "kr-west1",
"resource_types": "[\"resourcemanager:resource-group\", \"loggingaudit:trail\"]",
"tags": "[{\"key\": \"key1\", \"value\": \"value1\"}, {\"key\": \"key2\", \"value\": \"value2\"}]"
}
Example HTTP response
Response 201
{
"resource_group": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "resource group 1",
"id": "1486t61d84b354fb9135cc467owe1346",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "resource-group-1",
"region": "kr-west1",
"resource_types": "[\"resourcemanager:resource-group\", \"loggingaudit:trail\"]",
"srn": "srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496",
"tags": "[{\"key\": \"key1\", \"value\": \"value1\"}, {\"key\": \"key2\", \"value\": \"value2\"}]"
}
}
9.1.2 - DeleteComponentsTag
9.1.2.1 - 1.0
delete /v1/tags/{region}/{service}/{resource_type}/{resource_identifier}/{key}
Description
delete a specific components tag
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | region required | 리전 Example : kr-west1 | string | None |
| path | service required | 서비스 명 Example : virtualserver | string | None |
| path | resource_type required | 자원 유형 Example : virtual-server | string | None |
| path | resource_identifier required | 자원 ID Example : z95fa561-11u3-4frw-962g-3b123123c496 | string | None |
| path | key required | 태그 key (base64 encoded KEY) Example : dGFnLWtleQ== | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/tags/{region}/{service}/{resource_type}/{resource_identifier}/{key}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = resourcemanager 1.0"
Example HTTP response
Response 204
9.1.3 - DeleteComponentsTags
9.1.3.1 - 1.0
delete /v1/tags/{region}/{service}/{resource_type}/{resource_identifier}
Description
delete components tags
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | region required | 리전 Example : kr-west1 | string | None |
| path | service required | 서비스 명 Example : virtualserver | string | None |
| path | resource_type required | 자원 유형 Example : virtual-server | string | None |
| path | resource_identifier required | 자원 ID Example : z95fa561-11u3-4frw-962g-3b123123c496 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/tags/{region}/{service}/{resource_type}/{resource_identifier}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = resourcemanager 1.0"
Example HTTP response
Response 204
9.1.4 - DeleteResourceGroup
9.1.4.1 - 1.0
delete /v1/resource-groups/{resource_group_id}
Description
delete a specific resource_group
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | resource_group_id required | 리소스 그룹 ID Example : 1486t61d84b354fb9135cc467owe1346 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/resource-groups/{resource_group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = resourcemanager 1.0"
Example HTTP response
Response 204
9.1.5 - DeleteResourceGroups
9.1.5.1 - 1.0
delete /v1/resource-groups
Description
delete a specific resource_groups
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | ResourceGroupsDeleteRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/resource-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = resourcemanager 1.0"
Request body
{
"ids": "[\"8156q42h99z489mniehcpo103ekx5836\", \"1486t61d84b354fb9135cc467owe1346\"]"
}
Example HTTP response
Response 204
9.1.6 - DeleteResourceTag
9.1.6.1 - 1.0
delete /v1/tags/{srn}/{key}
Description
delete a specific resource tag
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | srn required | SRN (base64 encoded SRN) Example : c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng== | string | None |
| path | key required | 태그 key (base64 encoded KEY) Example : dGFnLWtleQ== | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/tags/{srn}/{key}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = resourcemanager 1.0"
Example HTTP response
Response 204
9.1.7 - DeleteResourceTags
9.1.7.1 - 1.0
delete /v1/tags/{srn}
Description
delete resource tags
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | srn required | SRN (base64 encoded SRN) Example : c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng== | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/tags/{srn}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = resourcemanager 1.0"
Example HTTP response
Response 204
9.1.8 - DeleteTags
9.1.8.1 - 1.0
delete /v1/tags
Description
delete tags
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | TagDeleteRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 204 | No Content | None |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/tags
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = resourcemanager 1.0"
Request body
{
"tags": "{\"srn:e::PROJECT-NTcEraJPrRhNGqldsJLTnf:kr-east1::compute:instance/INSTANCE-UPOg3Z6ZqyiMM0QyC3sI2m\": [\"key1\", \"key4\"]}"
}
Example HTTP response
Response 204
9.1.9 - ListComponentsTags
9.1.9.1 - 1.0
get /v1/tags/{region}/{service}/{resource_type}/{resource_identifier}
Description
get components tags
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | region required | 리전 Example : kr-west1 | string | None |
| path | service required | 서비스 명 Example : virtualserver | string | None |
| path | resource_type required | 자원 유형 Example : virtual-server | string | None |
| path | resource_identifier required | 자원 ID Example : z95fa561-11u3-4frw-962g-3b123123c496 | string | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | key optional | 태그 key Example : tag-key | any of [string, null] | None |
| query | value optional | 태그 value Example : tag-value | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TagShowListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/tags/{region}/{service}/{resource_type}/{resource_identifier}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = resourcemanager 1.0"
Example HTTP response
Response 200
{
"content": {
"srn": "srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496",
"tags": [
{
"key": "tag-key",
"value": "tag-value"
}
]
},
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
9.1.10 - ListResourceGroupResources
9.1.10.1 - 1.0
get /v1/resource-groups/{resource_group_id}/resources
Description
list a specific resource_group_resources
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | resource_group_id required | 리소스 그룹 ID Example : 1486t61d84b354fb9135cc467owe1346 | string | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResourcePageResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/resource-groups/{resource_group_id}/resources
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = resourcemanager 1.0"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"resources": [
{
"account_id": "1234ab567cd64769e8f9g490hi304891",
"created_at": "2025-02-27T10:23:43Z",
"created_by": "7123ke8439734e5789lj355b17ef5473",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"product_name": "Virtual Server",
"region": "kr-west1",
"resource_name": "resource-name-1",
"resource_type": "virtual-server",
"resource_type_display_name": "Virtual Server",
"service": "virtualserver",
"service_name": "Virtual Server",
"srn": "srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496",
"state": "Success",
"tags": "[{\"key1\": \"value1\"}, {\"key2\": \"value2\"}]"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
9.1.11 - ListResourceGroups
9.1.11.1 - 1.0
get /v1/resource-groups
Description
get resource_groups list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | id optional | 리소스 그룹 ID Example : 1486t61d84b354fb9135cc467owe1346 | any of [string, null] | None |
| query | name optional | 리소스 그룹명 Example : resource-group-1 | any of [string, null] | None |
| query | region optional | 리전 Example : kr-west1 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResourceGroupPageResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/resource-groups
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = resourcemanager 1.0"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"resource_groups": [
{
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "resource group 1",
"id": "1486t61d84b354fb9135cc467owe1346",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "resource-group-1",
"region": "kr-west1",
"resource_types": "[\"resourcemanager:resource-group\", \"loggingaudit:trail\"]",
"tags": "[{\"key\": \"key1\", \"value\": \"value1\"}, {\"key\": \"key2\", \"value\": \"value2\"}]"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
9.1.12 - ListResources
9.1.12.1 - 1.0
get /v1/resources
Description
get resources list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | id optional | 자원 ID Example : z95fa561-11u3-4frw-962g-3b123123c496 | any of [string, null] | None |
| query | resource_name optional | 자원명 Example : resource-name-1 | any of [string, null] | None |
| query | service_name optional | 서비스 명 Example : Virtual Server | any of [string, null] | None |
| query | resource_type optional | 자원 유형 Example : virtual-server | any of [string, null] | None |
| query | region optional | 리전 Example : kr-west1 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResourcePageResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/resources
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = resourcemanager 1.0"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"resources": [
{
"account_id": "1234ab567cd64769e8f9g490hi304891",
"created_at": "2025-02-27T10:23:43Z",
"created_by": "7123ke8439734e5789lj355b17ef5473",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"product_name": "Virtual Server",
"region": "kr-west1",
"resource_name": "resource-name-1",
"resource_type": "virtual-server",
"resource_type_display_name": "Virtual Server",
"service": "virtualserver",
"service_name": "Virtual Server",
"srn": "srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496",
"state": "Success",
"tags": "[{\"key1\": \"value1\"}, {\"key2\": \"value2\"}]"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
9.1.13 - ListResourceTags
9.1.13.1 - 1.0
get /v1/tags/{srn}
Description
get resource tags
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | srn required | SRN (base64 encoded SRN) Example : c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng== | string | None |
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | key optional | 태그 key Example : tag-key | any of [string, null] | None |
| query | value optional | 태그 value Example : tag-value | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TagShowListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/tags/{srn}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = resourcemanager 1.0"
Example HTTP response
Response 200
{
"content": {
"srn": "srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496",
"tags": [
{
"key": "tag-key",
"value": "tag-value"
}
]
},
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
9.1.14 - ListTagKeys
9.1.14.1 - 1.0
get /v1/tags/keys
Description
get tag key list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | key optional | 태그 key Example : tag-key | any of [string, null] | None |
| query | region optional | 리전 Example : kr-west1 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TagKeyResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/tags/keys
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = resourcemanager 1.0"
Example HTTP response
Response 200
{
"count": 6,
"keys": "[\"key1\", \"key2\"]"
}
9.1.15 - ListTags
9.1.15.1 - 1.0
get /v1/tags
Description
get tag list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | account_id optional | 어카운트 ID Example : 1234ab567cd64769e8f9g490hi304891 | any of [string, null] | None |
| query | key optional | 태그 key Example : tag-key | any of [string, null] | None |
| query | value optional | 태그 value Example : tag-value | any of [string, null] | None |
| query | resource_identifier optional | 자원 ID Example : z95fa561-11u3-4frw-962g-3b123123c496 | any of [string, null] | None |
| query | resource_type optional | 자원 유형 Example : virtual-server | any of [string, null] | None |
| query | service optional | 서비스 명 Example : virtualserver | any of [string, null] | None |
| query | offering optional | SCP 운영 단위 Example : dev2 | any of [string, null] | None |
| query | region optional | 리전 Example : kr-west1 | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TagListResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/tags
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = resourcemanager 1.0"
Example HTTP response
Response 200
{
"content": [
{
"key": "tag-key",
"srn": "srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496",
"value": "tag-value"
}
],
"count": 20,
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
9.1.16 - ListTagValues
9.1.16.1 - 1.0
get /v1/tags/values
Description
get tag value list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | key optional | 태그 key Example : tag-key | any of [string, null] | None |
| query | region optional | 리전 Example : kr-west1 | any of [string, null] | None |
| query | value optional | 태그 value Example : tag-value | any of [string, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TagValueResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/tags/values
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = resourcemanager 1.0"
Example HTTP response
Response 200
{
"count": 6,
"values": "[\"value1\", \"value2\"]"
}
9.1.17 - SetResourceGroup
9.1.17.1 - 1.0
put /v1/resource-groups/{resource_group_id}
Description
set resource_group
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | resource_group_id required | 리소스 그룹 ID Example : 1486t61d84b354fb9135cc467owe1346 | string | None |
| body | body required | ResourceGroupUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResourceGroupCreateResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/resource-groups/{resource_group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = resourcemanager 1.0"
Request body
{
"description": "resource group 1",
"resource_types": "[\"resourcemanager:resource-group\", \"loggingaudit:trail\"]",
"tags": "[{\"key\": \"key1\", \"value\": \"value1\"}, {\"key\": \"key2\", \"value\": \"value2\"}]"
}
Example HTTP response
Response 200
{
"resource_group": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "resource group 1",
"id": "1486t61d84b354fb9135cc467owe1346",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "resource-group-1",
"region": "kr-west1",
"resource_types": "[\"resourcemanager:resource-group\", \"loggingaudit:trail\"]",
"srn": "srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496",
"tags": "[{\"key\": \"key1\", \"value\": \"value1\"}, {\"key\": \"key2\", \"value\": \"value2\"}]"
}
}
9.1.18 - ShowComponentsTag
9.1.18.1 - 1.0
get /v1/tags/{region}/{service}/{resource_type}/{resource_identifier}/{key}
Description
get a specific components tag
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | region required | 리전 Example : kr-west1 | string | None |
| path | service required | 서비스 명 Example : virtualserver | string | None |
| path | resource_type required | 자원 유형 Example : virtual-server | string | None |
| path | resource_identifier required | 자원 ID Example : z95fa561-11u3-4frw-962g-3b123123c496 | string | None |
| path | key required | 태그 key (base64 encoded KEY) Example : dGFnLWtleQ== | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TagShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/tags/{region}/{service}/{resource_type}/{resource_identifier}/{key}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = resourcemanager 1.0"
Example HTTP response
Response 200
{
"content": {
"srn": "srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496",
"tag": {
"key": "tag-key",
"value": "tag-value"
}
}
}
9.1.19 - ShowResource
9.1.19.1 - 1.0
get /v1/resources/{srn}
Description
get a specific resource
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | srn required | SRN (base64 encoded SRN) Example : c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng== | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResourceShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/resources/{srn}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = resourcemanager 1.0"
Example HTTP response
Response 200
{
"resource": {
"account_id": "1234ab567cd64769e8f9g490hi304891",
"created_at": "2025-02-27T10:23:43Z",
"created_by": "7123ke8439734e5789lj355b17ef5473",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"product_name": "Virtual Server",
"region": "kr-west1",
"resource_name": "resource-name-1",
"resource_type": "virtual-server",
"resource_type_display_name": "Virtual Server",
"service": "virtualserver",
"service_name": "Virtual Server",
"srn": "srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496",
"state": "Success",
"tags": "[{\"key1\": \"value1\"}, {\"key2\": \"value2\"}]"
}
}
9.1.20 - ShowResourceByComponents
9.1.20.1 - 1.0
get /v1/resources/{region}/{service}/{resource_type}/{resource_identifier}
Description
get a specific resource
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | region required | 리전 Example : kr-west1 | string | None |
| path | service required | 서비스 명 Example : virtualserver | string | None |
| path | resource_type required | 자원 유형 Example : virtual-server | string | None |
| path | resource_identifier required | 자원 ID Example : z95fa561-11u3-4frw-962g-3b123123c496 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResourceShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/resources/{region}/{service}/{resource_type}/{resource_identifier}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = resourcemanager 1.0"
Example HTTP response
Response 200
{
"resource": {
"account_id": "1234ab567cd64769e8f9g490hi304891",
"created_at": "2025-02-27T10:23:43Z",
"created_by": "7123ke8439734e5789lj355b17ef5473",
"id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"product_name": "Virtual Server",
"region": "kr-west1",
"resource_name": "resource-name-1",
"resource_type": "virtual-server",
"resource_type_display_name": "Virtual Server",
"service": "virtualserver",
"service_name": "Virtual Server",
"srn": "srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496",
"state": "Success",
"tags": "[{\"key1\": \"value1\"}, {\"key2\": \"value2\"}]"
}
}
9.1.21 - ShowResourceGroup
9.1.21.1 - 1.0
get /v1/resource-groups/{resource_group_id}
Description
show a specific resource_group
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | resource_group_id required | 리소스 그룹 ID Example : 1486t61d84b354fb9135cc467owe1346 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ResourceGroupShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/resource-groups/{resource_group_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = resourcemanager 1.0"
Example HTTP response
Response 200
{
"resource_group": {
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"description": "resource group 1",
"id": "1486t61d84b354fb9135cc467owe1346",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"name": "resource-group-1",
"region": "kr-west1",
"resource_types": "[\"resourcemanager:resource-group\", \"loggingaudit:trail\"]",
"srn": "srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496",
"tags": "[{\"key\": \"key1\", \"value\": \"value1\"}, {\"key\": \"key2\", \"value\": \"value2\"}]"
}
}
9.1.22 - ShowResourceTag
9.1.22.1 - 1.0
get /v1/tags/{srn}/{key}
Description
get a specific resource tag
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | srn required | SRN (base64 encoded SRN) Example : c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng== | string | None |
| path | key required | 태그 key (base64 encoded KEY) Example : dGFnLWtleQ== | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TagShowResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/tags/{srn}/{key}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = resourcemanager 1.0"
Example HTTP response
Response 200
{
"content": {
"srn": "srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496",
"tag": {
"key": "tag-key",
"value": "tag-value"
}
}
}
9.1.23 - UpdateComponentsTags
9.1.23.1 - 1.0
put /v1/tags/{region}/{service}/{resource_type}/{resource_identifier}/bulk
Description
update components tags
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | region required | 리전 Example : kr-west1 | string | None |
| path | service required | 서비스 명 Example : virtualserver | string | None |
| path | resource_type required | 자원 유형 Example : virtual-server | string | None |
| path | resource_identifier required | 자원 ID Example : z95fa561-11u3-4frw-962g-3b123123c496 | string | None |
| body | body required | TagSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TagBaseResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/tags/{region}/{service}/{resource_type}/{resource_identifier}/bulk
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = resourcemanager 1.0"
Request body
{
"tags": [
{
"key": "tag-key",
"value": "tag-value"
}
]
}
Example HTTP response
Response 200
{
"content": {
"": [
{
"key": "tag-key",
"value": "tag-value"
}
]
}
}
9.1.24 - UpdateComponentsTagValue
9.1.24.1 - 1.0
put /v1/tags/{region}/{service}/{resource_type}/{resource_identifier}/{key}
Description
update components tag value
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | region required | 리전 Example : kr-west1 | string | None |
| path | service required | 서비스 명 Example : virtualserver | string | None |
| path | resource_type required | 자원 유형 Example : virtual-server | string | None |
| path | resource_identifier required | 자원 ID Example : z95fa561-11u3-4frw-962g-3b123123c496 | string | None |
| path | key required | 태그 key (base64 encoded KEY) Example : dGFnLWtleQ== | string | None |
| body | body required | TagValue |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TagBaseResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/tags/{region}/{service}/{resource_type}/{resource_identifier}/{key}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = resourcemanager 1.0"
Request body
{
"value": "tag-value"
}
Example HTTP response
Response 200
{
"content": {
"": [
{
"key": "tag-key",
"value": "tag-value"
}
]
}
}
9.1.25 - UpdateResourceTags
9.1.25.1 - 1.0
put /v1/tags/{srn}/bulk
Description
update resource tags
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | srn required | SRN (base64 encoded SRN) Example : c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng== | string | None |
| body | body required | TagSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TagBaseResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/tags/{srn}/bulk
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = resourcemanager 1.0"
Request body
{
"tags": [
{
"key": "tag-key",
"value": "tag-value"
}
]
}
Example HTTP response
Response 200
{
"content": {
"": [
{
"key": "tag-key",
"value": "tag-value"
}
]
}
}
9.1.26 - UpdateResourceTagValue
9.1.26.1 - 1.0
put /v1/tags/{srn}/{key}
Description
update resource tag value
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | srn required | SRN (base64 encoded SRN) Example : c3JuOmRldjI6OjEyMzRhYjU2N2NkNjQ3NjllOGY5ZzQ5MGhpMzA0ODkxOmtyLXdlc3QxOjp2aXJ0dWFsc2VydmVyOnZpcnR1YWwtc2VydmVyL3o5NWZhNTYxLTExdTMtNGZydy05NjJnLTNiMTIzMTIzYzQ5Ng== | string | None |
| path | key required | 태그 key (base64 encoded KEY) Example : dGFnLWtleQ== | string | None |
| body | body required | TagValue |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TagBaseResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/tags/{srn}/{key}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = resourcemanager 1.0"
Request body
{
"value": "tag-value"
}
Example HTTP response
Response 200
{
"content": {
"": [
{
"key": "tag-key",
"value": "tag-value"
}
]
}
}
9.1.27 - UpdateTags
9.1.27.1 - 1.0
put /v1/tags/bulk
Description
update tags
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | TagsSetRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | TagBaseResponse |
| 400 | Bad Request | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/tags/bulk
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = resourcemanager 1.0"
Request body
{
"tags": {
"": [
{
"key": "tag-key",
"value": "tag-value"
}
]
}
}
Example HTTP response
Response 200
{
"content": {
"": [
{
"key": "tag-key",
"value": "tag-value"
}
]
}
}
9.2 - Models
9.2.1 - CreateResourceGroup
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| description required | 리소스 그룹 설명 Example : resource group 1 | any of [string, null] | |
| id required | 리소스 그룹 ID Example : 1486t61d84b354fb9135cc467owe1346 | string | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | 리소스 그룹명 Example : resource-group-1 | any of [string, null] | |
| region required | 리전 Example : kr-west1 | any of [string, null] | |
| resource_types optional | 자원 유형 목록 Example : ["resourcemanager:resource-group", "loggingaudit:trail"] | any of [array[string], null] | |
| srn required | SRN Example : srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496 | string | |
| tags optional | 태그 목록 Example : [{"key": "key1", "value": "value1"}, {"key": "key2", "value": "value2"}] | any of [array[Tag], null] |
9.2.2 - Resource
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | 어카운트ID Example : 1234ab567cd64769e8f9g490hi304891 | any of [string, null] | |
| created_at required | 생성 일시 Example : 2025-02-27T10:23:43Z | any of [string (date-time), null] | |
| created_by required | 생성자 Example : 7123ke8439734e5789lj355b17ef5473 | any of [string, null] | |
| id required | ID Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e | string | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| product_name required | 상품/서비스 Example : Virtual Server | any of [string, null] | |
| region required | 리전 Example : kr-west1 | any of [string, null] | |
| resource_name required | 자원명 Example : resource-name-1 | any of [string, null] | |
| resource_type required | 자원 유형 Example : virtual-server | any of [string, null] | |
| resource_type_display_name required | 자원 유형명 Example : Virtual Server | any of [string, null] | |
| service required | SERVICE Example : virtualserver | any of [string, null] | |
| service_name required | 서비스 명 Example : Virtual Server | any of [string, null] | |
| srn required | SRN Example : srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496 | any of [string, null] | |
| state required | 상태 Example : Success | any of [string, null] | |
| tags required | 태그 목록 Example : [{"key1": "value1"}, {"key2": "value2"}] | any of [array[object], null] |
9.2.3 - ResourceGroup
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | 생성 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | 생성자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| description required | 리소스 그룹 설명 Example : resource group 1 | any of [string, null] | |
| id required | 리소스 그룹 ID Example : 1486t61d84b354fb9135cc467owe1346 | string | |
| modified_at required | 수정 시간 Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | 수정자 Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| name required | 리소스 그룹명 Example : resource-group-1 | any of [string, null] | |
| region required | 리전 Example : kr-west1 | any of [string, null] | |
| resource_types optional | 자원 유형 목록 Example : ["resourcemanager:resource-group", "loggingaudit:trail"] | any of [array[string], null] | |
| tags optional | 태그 목록 Example : [{"key": "key1", "value": "value1"}, {"key": "key2", "value": "value2"}] | any of [array[Tag], null] |
9.2.4 - ResourceGroupCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description required | 리소스 그룹 설명 Example : resource group 1 | any of [string, null] | |
| name required | 리소스 그룹명 Example : resource-group-1Pattern : ^[가-힣ㄱ-ㅎㅏ-ㅣa-zA-Z0-9+=,.\@_-]+$Minimum length : 3Maximum length : 64 | string | |
| region optional | 리전 Example : kr-west1 | any of [string, null] | |
| resource_types optional | 자원 유형 목록 (service:resource_type) Example : ["resourcemanager:resource-group", "loggingaudit:trail"] | any of [array[string], null] | |
| tags optional | 태그 목록 Example : [{"key": "key1", "value": "value1"}, {"key": "key2", "value": "value2"}] | any of [array[Tag], null] |
9.2.5 - ResourceGroupCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| resource_group required | 리소스 그룹 | CreateResourceGroup |
9.2.6 - ResourceGroupPageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| resource_groups required | 리소스 그룹 목록 | array[ResourceGroup] | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
9.2.7 - ResourceGroupsDeleteRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| ids optional | 리소스 그룹 ID 목록 Example : ["8156q42h99z489mniehcpo103ekx5836", "1486t61d84b354fb9135cc467owe1346"] | any of [array[string], null] |
9.2.8 - ResourceGroupShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| resource_group required | 리소스 그룹 | CreateResourceGroup |
9.2.9 - ResourceGroupUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| description required | 리소스 그룹 설명 Example : resource group 1 | any of [string, null] | |
| resource_types optional | 자원 유형 목록 (service:resource_type) Example : ["resourcemanager:resource-group", "loggingaudit:trail"] | any of [array[string], null] | |
| tags optional | 태그 목록 Example : [{"key": "key1", "value": "value1"}, {"key": "key2", "value": "value2"}] | any of [array[Tag], null] |
9.2.10 - ResourcePageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| resources optional | 자원 목록 | array[Resource] | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
9.2.11 - ResourceShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| resource optional | 자원 | Resource |
9.2.12 - SrnKeyValue
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | 태그 key Example : tag-keyPattern : ^[a-zA-Z0-9가-힣ㄱ-ㅎㅏ-ㅣ \+\-\=\.\_:/@]*$Minimum length : 1Maximum length : 128 | string | |
| srn required | SRN Example : srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496 | string | |
| value required | 태그 value Example : tag-valuePattern : ^[a-zA-Z0-9가-힣ㄱ-ㅎㅏ-ㅣ \+\-\=\.\_:/@]*$Maximum length : 256 | string |
9.2.13 - SrnTag
| Name | Description | Schema | Default |
|---|---|---|---|
| srn required | SRN Example : srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496 | string | |
| tag required | 태그 | any of [Tag, null] |
9.2.14 - SrnTagList
| Name | Description | Schema | Default |
|---|---|---|---|
| srn required | SRN Example : srn:dev2::1234ab567cd64769e8f9g490hi304891:kr-west1::virtualserver:virtual-server/z95fa561-11u3-4frw-962g-3b123123c496 | string | |
| tags optional | 태그 목록 | any of [array[Tag], null] |
9.2.15 - Tag
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | 태그 key Example : tag-keyPattern : ^[a-zA-Z0-9가-힣ㄱ-ㅎㅏ-ㅣ \+\-\=\.\_:/@]*$Minimum length : 1Maximum length : 128 | string | |
| value required | 태그 value Example : tag-valuePattern : ^[a-zA-Z0-9가-힣ㄱ-ㅎㅏ-ㅣ \+\-\=\.\_:/@]*$ | any of [string, null] |
9.2.16 - TagBaseResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| content required | 태그 목록 | object[array[Tag]] |
9.2.17 - TagDeleteRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| tags required | 태그 키 목록 Example : {"srn:e::PROJECT-NTcEraJPrRhNGqldsJLTnf:kr-east1::compute:instance/INSTANCE-UPOg3Z6ZqyiMM0QyC3sI2m": ["key1", "key4"]} | object[array[string]] |
9.2.18 - TagKeyResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | 개수 Example : 6 | integer | |
| keys required | 태그 key 목록 Example : ["key1", "key2"] | array[string] |
9.2.19 - TagListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| content required | 태그 목록 | array[SrnKeyValue] | |
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
9.2.20 - TagSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| tags required | 태그 목록 | array[Tag] |
9.2.21 - TagShowListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| content required | 태그 목록 | SrnTagList | |
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
9.2.22 - TagShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| content required | 태그 | SrnTag |
9.2.23 - TagsSetRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| tags required | 태그 목록 | object[array[Tag]] |
9.2.24 - TagValue
| Name | Description | Schema | Default |
|---|---|---|---|
| value required | SRN Example : tag-value | string |
9.2.25 - TagValueResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | 개수 Example : 6 | integer | |
| values required | 태그 value 목록 Example : ["value1", "value2"] | array[string] |
10 - ServiceWatch
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.
본 가이드는 ServiceWatch 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | SUPPORTED | 20260630 |
| 1.1 | CURRENT | - |
OpenAPI URL
https://servicewatch.{region}.{environment}.samsungsdscloud.com
Environment and Region List
| environment | region |
|---|---|
| s | kr-west1 |
| s | kr-east1 |
| g | kr-south1 |
| g | kr-south2 |
| g | kr-south3 |
| e | kr-west1 |
| e | kr-east1 |
10.1 - APIs
10.1.1 - CreateCustomLogEvents
10.1.1.1 - 1.1
post /v1/log-groups/log-streams/log-events
Description
Create custom log events
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | CustomLogEventsCreateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | CustomLogEventsCreateResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/log-groups/log-streams/log-events
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = servicewatch 1.1"
Request body
{
"resourceLogs": [
{
"resource": {
"attributes": [
{
"key": "log_stream_value",
"value": {
"stringValue": "a1e2f3045678901a2b3c4d5e6f7a8b81"
}
},
{
"key": "log_group_value",
"value": {
"stringValue": "b1e2f3045678901a2b3c4d5e6f7a8b81"
}
},
{
"key": "account_id",
"value": {
"stringValue": "c1e2f3045678901a2b3c4d5e6f7a8b81"
}
}
]
},
"scopeLogs": [
{
"logRecords": [
{
"body": {
"stringValue": "level=info otlp test log"
},
"timeUnixNano": "1762336464000000000"
}
]
}
]
}
]
}
Example HTTP response
Response 202
{
"status": "success"
}
10.1.2 - CreateCustomLogStream
10.1.2.1 - 1.1
post /v1/log-groups/log-streams/collect/custom
Description
Create a custom log stream
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | LogGroupsLogStreamsCollectCustomRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | LogGroupsLogStreamsCollectCustomResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/log-groups/log-streams/collect/custom
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = servicewatch 1.1"
Request body
{
"log_group_name": "testlg01",
"log_stream_name": "testls01"
}
Example HTTP response
Response 200
{
"account_id": "1bcf39b344ac41cbaf0466ff0d2bebad",
"log_group_value": "fa6169af200b4d5db229aff384b2a028",
"log_stream_value": "551513c5182b45beb22eadb634cdccfb",
"requests_per_second": 500
}
10.1.3 - CreateCustomMetricMetas
10.1.3.1 - 1.1
post /v1/metrics/custom/meta
Description
Create Custom Metric Metas
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | MetricCustomMetaRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | MetricCustomMetaResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/metrics/custom/meta
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = servicewatch 1.1"
Request body
{
"metricMetas": [
{
"descriptionEn": "filestorage volume total byte",
"descriptionKo": "파일스토리지 총 바이트 수",
"dimensions": [
[
"image_id"
]
],
"metricName": "Custom_filestorage_volume_total_byte",
"storageResolution": 60,
"unit": "Bytes"
}
],
"namespace": "MyCustom/filestorage"
}
Example HTTP response
Response 200
{
"account_id": "d79a5194b1a44a858969eb94754d3ba1",
"max_data_points": "",
"unit_logs": [
{
"code": "Success",
"message": "[libvirt_domain_info_virtual_cpus] unit is updated from Count to Bytes"
}
]
}
10.1.4 - CreateCustomMetrics
10.1.4.1 - 1.1
post /v1/metrics/custom
Description
Create Custom Metrics. The request body of this API can receive data in either camelCase or snake_case.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | MetricCustomRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 202 | Accepted | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/metrics/custom
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = servicewatch 1.1"
Request body
{
"resource_metrics": [
{
"resource": {
"attributes": [
{
"key": "",
"value": {
"array_value": "",
"bool_value": "",
"byte_value": "",
"double_value": "",
"int_value": "",
"kvlist_value": "",
"string_value": ""
}
}
]
},
"scope_metrics": [
{
"metrics": [
{
"description": "The total number of bytes read successfully.",
"gauge": {
"data_points": [
{
"as_double": 0.75,
"as_int": 10,
"attributes": [
{
"key": "",
"value": {
"array_value": "",
"bool_value": "",
"byte_value": "",
"double_value": "",
"int_value": "",
"kvlist_value": "",
"string_value": ""
}
}
],
"start_time_unix_nano": "1753776789854000000",
"time_unix_nano": "1753776789854000000"
}
]
},
"name": "node_disk_read_bytes_total",
"sum": {
"aggregation_temporality": "2",
"data_points": [
{
"as_double": 0.75,
"as_int": 10,
"attributes": [
{
"key": "",
"value": {
"array_value": "",
"bool_value": "",
"byte_value": "",
"double_value": "",
"int_value": "",
"kvlist_value": "",
"string_value": ""
}
}
],
"start_time_unix_nano": "1753776789854000000",
"time_unix_nano": "1753776789854000000"
}
],
"is_monotonic": true
},
"unit": "Bytes"
}
],
"scope": {
"name": "ServiceWatch-Agent",
"version": "1.0.0"
}
}
]
}
]
}
Example HTTP response
Response 202
10.1.5 - CreateDashboard
10.1.5.1 - 1.1
post /v1/dashboards
Description
Create dashboard
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | DashboardCreationRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | DashboardDetailResponseV1Dot1 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/dashboards
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = servicewatch 1.1"
Request body
{
"name": "New-Monitoring-Dashboard",
"widgets": [
{
"height": 1,
"order": 1,
"properties": {
"metrics": [
{
"color": "#ff7f0e",
"dimensions": [
{
"key": "InstanceId",
"value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
}
],
"display_name": "EC2-Prod-CPU",
"individual_items": [
{
"key": "BucketId",
"value": "b-1234567890abcdef0"
}
],
"name": "CPUUtilization",
"namespace_name": "Virtual Server",
"period": 300,
"statistic_type": "AVG"
}
],
"period": 300,
"stacked": false,
"statistic_type": "AVG",
"title": "Virtual Server | CPU Utilization",
"view": "line"
},
"type": "metric",
"width": 1
}
]
}
Example HTTP response
Response 201
{
"alerts": {
"summary": {
"high": 1,
"low": 0,
"medium": 3
},
"widgets": [
{
"properties": {
"metrics": [
{
"alerts": [
{
"id": "",
"name": ""
}
],
"color": "#ff7f0e",
"dimensions": [
{
"key": "InstanceId",
"value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
}
],
"display_name": "EC2-Prod-CPU",
"individual_items": [
{
"key": "BucketId",
"value": "b-1234567890abcdef0"
}
],
"name": "CPUUtilization",
"namespace_name": "Virtual Server",
"period": 300,
"statistic_type": "AVG"
}
],
"period": 300,
"stacked": false,
"statistic_type": "AVG",
"title": "Virtual Server | CPU Utilization",
"view": "line"
}
}
]
},
"created_at": "2026-02-11T06:44:15.180Z",
"created_by": "user-xxxxxxxx",
"favorite_enabled": true,
"id": "b48e730a70e74f6aa3d2555000b5c22b",
"modified_at": "",
"modified_by": "user-yyyyyyyy",
"name": "Production-Web-Servers",
"product_name": "ServiceWatch",
"resource_id": "c8e41e595ad040a8abe57e2ffc109113",
"resource_name": "Production-Web-Servers",
"resource_type": "dashboard",
"share_type": "Private",
"srn": "srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113",
"type": "Custom",
"widgets": [
{
"dashboard_id": "b48e730a70e74f6aa3d2555000b5c22b",
"height": 1,
"id": "75da70a1a4fb486ab0282cf90693ec3c",
"order": 1,
"properties": {
"metrics": [
{
"color": "#ff7f0e",
"dimensions": [
{
"key": "InstanceId",
"value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
}
],
"display_name": "EC2-Prod-CPU",
"name": "CPUUtilization",
"namespace_name": "Virtual Server",
"period": 300,
"statistic_type": "AVG"
}
],
"period": 300,
"stacked": false,
"statistic_type": "AVG",
"title": "Virtual Server | CPU Utilization",
"view": "line"
},
"type": "metric",
"width": 1
}
]
}
10.1.5.2 - 1.0
post /v1/dashboards
Description
Create dashboard
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | DashboardCreationRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 201 | Created | DashboardDetailResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 409 | Conflict | None |
Example HTTP request
Request path
/v1/dashboards
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = servicewatch 1.0"
Request body
{
"name": "New-Monitoring-Dashboard",
"widgets": [
{
"height": 1,
"order": 1,
"properties": {
"metrics": [
{
"color": "#ff7f0e",
"dimensions": [
{
"key": "InstanceId",
"value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
}
],
"display_name": "EC2-Prod-CPU",
"individual_items": [
{
"key": "BucketId",
"value": "b-1234567890abcdef0"
}
],
"name": "CPUUtilization",
"namespace_name": "Virtual Server",
"period": 300,
"statistic_type": "AVG"
}
],
"period": 300,
"stacked": false,
"statistic_type": "AVG",
"title": "Virtual Server | CPU Utilization",
"view": "line"
},
"type": "metric",
"width": 1
}
]
}
Example HTTP response
Response 201
{
"alerts": {
"summary": {
"high": 1,
"low": 0,
"medium": 3
},
"widgets": [
{
"properties": {
"metrics": [
{
"alerts": [
{
"id": "",
"name": ""
}
],
"color": "#ff7f0e",
"dimensions": [
{
"key": "InstanceId",
"value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
}
],
"display_name": "EC2-Prod-CPU",
"individual_items": [
{
"key": "BucketId",
"value": "b-1234567890abcdef0"
}
],
"name": "CPUUtilization",
"namespace_name": "Virtual Server",
"period": 300,
"statistic_type": "AVG"
}
],
"period": 300,
"stacked": false,
"statistic_type": "AVG",
"title": "Virtual Server | CPU Utilization",
"view": "line"
}
}
]
},
"created_at": "2026-02-11T06:44:14.512Z",
"created_by": "user-xxxxxxxx",
"favorite_enabled": true,
"id": "b48e730a70e74f6aa3d2555000b5c22b",
"modified_at": "",
"modified_by": "user-yyyyyyyy",
"name": "Production-Web-Servers",
"product_name": "ServiceWatch",
"resource_id": "c8e41e595ad040a8abe57e2ffc109113",
"resource_name": "Production-Web-Servers",
"resource_type": "dashboard",
"share_type": "Private",
"srn": "srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113",
"type": "Custom",
"widgets": [
{
"dashboard_id": "b48e730a70e74f6aa3d2555000b5c22b",
"height": 1,
"id": "75da70a1a4fb486ab0282cf90693ec3c",
"order": 1,
"properties": {
"metrics": [
{
"color": "#ff7f0e",
"dimensions": [
{
"key": "InstanceId",
"value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
}
],
"display_name": "EC2-Prod-CPU",
"individual_items": [
{
"key": "BucketId",
"value": "b-1234567890abcdef0"
}
],
"name": "CPUUtilization",
"namespace_name": "Virtual Server",
"period": 300,
"statistic_type": "AVG"
}
],
"period": 300,
"stacked": false,
"statistic_type": "AVG",
"title": "Virtual Server | CPU Utilization",
"view": "line"
},
"type": "metric",
"width": 1
}
]
}
10.1.6 - DeleteBulkDashboards
10.1.6.1 - 1.1
delete /v1/dashboards
Description
Delete bulk dashboards
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | DashboardBulkDeleteRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | DashboardBulkDeleteResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/dashboards
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = servicewatch 1.1"
Request body
{
"dashboard_ids": [
"b48e730a70e74f6aa3d2555000b5c22b",
"c48e730a70e74f6aa3d2555000b5c22b"
]
}
Example HTTP response
Response 200
{
"dashboard_names": [
"dash-abc",
"dash-def"
]
}
10.1.6.2 - 1.0
delete /v1/dashboards
Description
Delete bulk dashboards
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | DashboardBulkDeleteRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | DashboardBulkDeleteResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/dashboards
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = servicewatch 1.0"
Request body
{
"dashboard_ids": [
"b48e730a70e74f6aa3d2555000b5c22b",
"c48e730a70e74f6aa3d2555000b5c22b"
]
}
Example HTTP response
Response 200
{
"dashboard_names": [
"dash-abc",
"dash-def"
]
}
10.1.7 - DownloadMetricDataImage
10.1.7.1 - 1.1
post /v1/metrics/data/download/image
Description
Download metric data image
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | MetricDataImageRequestV1Dot1 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/metrics/data/download/image
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = servicewatch 1.1"
Request body
{
"end": 1640995440,
"height": 400,
"metrics": [
{
"color": "#0000ff",
"dimensions": [
{
"key": "VolumeID",
"value": "45fbde15-cdd2-4891-be31-4a9de75fccda"
}
],
"display_name": "Virtual Server | VirtualServer001 | CPU Usage/Core[Basic]",
"name": "CPU Usage/Core[Basic]",
"namespace_name": "Virtual Server",
"period": 300,
"statistic_type": "AVG"
}
],
"period": 300,
"start": 1640995200,
"statistic_type": "AVG",
"timezone": "UTC",
"title": "Virtual Server Metric Chart",
"width": 600
}
Example HTTP response
Response 200
10.1.7.2 - 1.0
post /v1/metrics/data/download/image
Description
Download metric data image
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | MetricDataImageRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | None |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/metrics/data/download/image
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = servicewatch 1.0"
Request body
{
"end": 1640995440,
"height": 400,
"metrics": [
{
"color": "#0000ff",
"dimensions": [
{
"key": "VolumeID",
"value": "45fbde15-cdd2-4891-be31-4a9de75fccda"
}
],
"display_name": "Virtual Server | VirtualServer001 | CPU Usage/Core[Basic]",
"individual_items": [
{
"key": "VolumeID",
"value": "45fbde15-cdd2-4891-be31-4a9de75fccda"
}
],
"name": "CPU Usage/Core[Basic]",
"namespace_name": "Virtual Server",
"period": 300,
"statistic_type": "AVG"
}
],
"period": 300,
"start": 1640995200,
"statistic_type": "AVG",
"timezone": "UTC",
"title": "Virtual Server Metric Chart",
"width": 600
}
Example HTTP response
Response 200
10.1.8 - ListDashboards
10.1.8.1 - 1.1
get /v1/dashboards
Description
Get list of dashboards
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : name:asc or modified_at:desc | any of [string, null] | None |
| query | name optional | Dashboard’s name Example : MyProd | any of [string, null] | None |
| query | name_like optional | Wildcard Search for Dashboard Names Example : MyProd | any of [string, null] | None |
| query | favorite_enabled optional | Whether it is a favorite dashboard Example : True | any of [boolean, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | DashboardPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/dashboards
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = servicewatch 1.1"
Example HTTP response
Response 200
{
"count": 20,
"dashboards": [
{
"created_at": "2026-02-11T06:44:14.473Z",
"favorite_enabled": true,
"id": "b48e730a70e74f6aa3d2555000b5c22b",
"modified_at": "2026-02-11T06:44:14.474Z",
"name": "Production-Web-Servers",
"type": "Custom"
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
10.1.8.2 - 1.0
get /v1/dashboards
Description
Get list of dashboards
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : name:asc or modified_at:desc | any of [string, null] | None |
| query | name optional | Dashboard’s name Example : MyProd | any of [string, null] | None |
| query | name_like optional | Wildcard Search for Dashboard Names Example : MyProd | any of [string, null] | None |
| query | favorite_enabled optional | Whether it is a favorite dashboard Example : True | any of [boolean, null] | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | DashboardPageResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/dashboards
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = servicewatch 1.0"
Example HTTP response
Response 200
{
"count": 20,
"dashboards": [
{
"created_at": "2026-02-11T06:44:14.473Z",
"favorite_enabled": true,
"id": "b48e730a70e74f6aa3d2555000b5c22b",
"modified_at": "2026-02-11T06:44:14.474Z",
"name": "Production-Web-Servers",
"type": "Custom"
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
10.1.9 - ListMetricData
10.1.9.1 - 1.1
post /v1/metrics/data
Description
Get metric data list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | MetricDataRequestV1Dot1 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | MetricDataResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/metrics/data
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = servicewatch 1.1"
Request body
{
"end": 1640995440,
"metrics": [
{
"dimensions": [
{
"key": "VolumeID",
"value": "45fbde15-cdd2-4891-be31-4a9de75fccda"
}
],
"display_name": "Virtual Server | VirtualServer001 | CPU Usage/Core[Basic]",
"name": "CPU Usage/Core[Basic]",
"namespace_name": "Virtual Server",
"period": 300,
"statistic_type": "AVG"
}
],
"period": 300,
"start": 1640995200,
"statistic_type": "AVG"
}
Example HTTP response
Response 200
{
"metrics": [
{
"display_name": "Virtual Server | VirtualServer001 | CPU Usage/Core[Basic]",
"status": "",
"values": "[[1640995200, \"45.5\"]]"
}
]
}
10.1.9.2 - 1.0
post /v1/metrics/data
Description
Get metric data list
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | MetricDataRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | MetricDataResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/metrics/data
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = servicewatch 1.0"
Request body
{
"end": 1640995440,
"metrics": [
{
"dimensions": [
{
"key": "VolumeID",
"value": "45fbde15-cdd2-4891-be31-4a9de75fccda"
}
],
"display_name": "Virtual Server | VirtualServer001 | CPU Usage/Core[Basic]",
"individual_items": [
{
"key": "VolumeID",
"value": "45fbde15-cdd2-4891-be31-4a9de75fccda"
}
],
"name": "CPU Usage/Core[Basic]",
"namespace_name": "Virtual Server",
"period": 300,
"statistic_type": "AVG"
}
],
"period": 300,
"start": 1640995200,
"statistic_type": "AVG"
}
Example HTTP response
Response 200
{
"metrics": [
{
"display_name": "Virtual Server | VirtualServer001 | CPU Usage/Core[Basic]",
"status": "",
"values": "[[1640995200, \"45.5\"]]"
}
]
}
10.1.10 - ListMetricInfos
10.1.10.1 - 1.1
post /v1/metrics
Description
Get metric list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | MetricSearchRequestV1Dot1 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | MetricsResponseV1Dot1 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/metrics
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = servicewatch 1.1"
Request body
{
"metric_name": "CPU Usage/Core[Basic]",
"namespaces": [
{
"dimensions": "[[\"resource_id\"]]",
"name": "Virtual Server"
}
],
"resource_id": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502",
"resource_name": "VirtualServer01",
"tags": [
{
"key": "key01",
"value": "value01"
}
]
}
Example HTTP response
Response 200
{
"count": 1,
"namespaces": [
{
"dimensions": [
{
"columns": [
{
"key": "name",
"name_en": "지표명",
"name_ko": "지표명"
}
],
"keys": "InstanceId",
"metrics": [
{
"alerts": [
{
"id": "0ad6da92-634a-4f8c-932e-9d650599ab1e",
"name": "Alert1"
}
],
"default_collection_interval": "5m",
"detailed_collection_interval": "1m",
"dimensions": [
{
"key": "VolumeID",
"value": "45fbde15-cdd2-4891-be31-4a9de75fccda"
}
],
"id": "d91097ac-0387-4e69-adb2-7b8d453b8db5",
"name": "CPU Usage/Core[Basic]",
"named_dimensions": [
{
"key": "VolumeID",
"value": "45fbde15-cdd2-4891-be31-4a9de75fccda"
}
],
"namespace_id": "d583a229-9766-4eb8-96c4-ec389902ba3d",
"namespace_name": "Virtual Server",
"primary": true,
"recommended_stat_types": "[\"AVG\", \"MAX\"]",
"tags": [
{
"key": "key01",
"value": "value01"
}
],
"unit": "BYTE"
}
]
}
],
"id": "d583a229-9766-4eb8-96c4-ec389902ba3d",
"name": "Virtual Server",
"service_name": ""
}
]
}
10.1.10.2 - 1.0
post /v1/metrics
Description
Get metric list
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| body | body required | MetricSearchRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | MetricsResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/metrics
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = servicewatch 1.0"
Request body
{
"metric_name": "CPU Usage/Core[Basic]",
"namespaces": [
{
"dimensions": "[\"resource_id\"]",
"name": "Virtual Server"
}
],
"resource_id": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502",
"resource_name": "VirtualServer01",
"tags": [
{
"key": "key01",
"value": "value01"
}
]
}
Example HTTP response
Response 200
{
"count": 1,
"namespaces": [
{
"dimensions": [
{
"columns": [
{
"key": "name",
"name_en": "지표명",
"name_ko": "지표명"
}
],
"key": "InstanceId",
"metrics": [
{
"alerts": [
{
"id": "0ad6da92-634a-4f8c-932e-9d650599ab1e",
"name": "Alert1"
}
],
"default_collection_interval": "5m",
"detailed_collection_interval": "1m",
"dimensions": [
{
"key": "VolumeID",
"value": "45fbde15-cdd2-4891-be31-4a9de75fccda"
}
],
"id": "d91097ac-0387-4e69-adb2-7b8d453b8db5",
"individual_items": [
{
"key": "VolumeID",
"value": "45fbde15-cdd2-4891-be31-4a9de75fccda"
}
],
"name": "CPU Usage/Core[Basic]",
"named_dimensions": [
{
"key": "VolumeID",
"value": "45fbde15-cdd2-4891-be31-4a9de75fccda"
}
],
"namespace_id": "d583a229-9766-4eb8-96c4-ec389902ba3d",
"namespace_name": "Virtual Server",
"primary": true,
"recommended_stat_types": "[\"AVG\", \"MAX\"]",
"tags": [
{
"key": "key01",
"value": "value01"
}
],
"unit": "BYTE"
}
]
}
],
"id": "d583a229-9766-4eb8-96c4-ec389902ba3d",
"name": "Virtual Server",
"service_name": ""
}
]
}
10.1.11 - SetDashboard
10.1.11.1 - 1.1
put /v1/dashboards/{dashboard_id}
Description
Set dashboard
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | dashboard_id required | Dashboard’s unique ID Example : b48e730a70e74f6aa3d2555000b5c22b | string | None |
| body | body required | DashboardUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | DashboardDetailResponseV1Dot1 |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/dashboards/{dashboard_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = servicewatch 1.1"
Request body
{
"name": "Renamed-Dashboard",
"widgets": [
{
"height": 1,
"order": 1,
"properties": {
"metrics": [
{
"color": "#ff7f0e",
"dimensions": [
{
"key": "InstanceId",
"value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
}
],
"display_name": "EC2-Prod-CPU",
"individual_items": [
{
"key": "BucketId",
"value": "b-1234567890abcdef0"
}
],
"name": "CPUUtilization",
"namespace_name": "Virtual Server",
"period": 300,
"statistic_type": "AVG"
}
],
"period": 300,
"stacked": false,
"statistic_type": "AVG",
"title": "Virtual Server | CPU Utilization",
"view": "line"
},
"type": "metric",
"width": 1
}
]
}
Example HTTP response
Response 200
{
"alerts": {
"summary": {
"high": 1,
"low": 0,
"medium": 3
},
"widgets": [
{
"properties": {
"metrics": [
{
"alerts": [
{
"id": "",
"name": ""
}
],
"color": "#ff7f0e",
"dimensions": [
{
"key": "InstanceId",
"value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
}
],
"display_name": "EC2-Prod-CPU",
"individual_items": [
{
"key": "BucketId",
"value": "b-1234567890abcdef0"
}
],
"name": "CPUUtilization",
"namespace_name": "Virtual Server",
"period": 300,
"statistic_type": "AVG"
}
],
"period": 300,
"stacked": false,
"statistic_type": "AVG",
"title": "Virtual Server | CPU Utilization",
"view": "line"
}
}
]
},
"created_at": "2026-02-11T06:44:15.180Z",
"created_by": "user-xxxxxxxx",
"favorite_enabled": true,
"id": "b48e730a70e74f6aa3d2555000b5c22b",
"modified_at": "",
"modified_by": "user-yyyyyyyy",
"name": "Production-Web-Servers",
"product_name": "ServiceWatch",
"resource_id": "c8e41e595ad040a8abe57e2ffc109113",
"resource_name": "Production-Web-Servers",
"resource_type": "dashboard",
"share_type": "Private",
"srn": "srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113",
"type": "Custom",
"widgets": [
{
"dashboard_id": "b48e730a70e74f6aa3d2555000b5c22b",
"height": 1,
"id": "75da70a1a4fb486ab0282cf90693ec3c",
"order": 1,
"properties": {
"metrics": [
{
"color": "#ff7f0e",
"dimensions": [
{
"key": "InstanceId",
"value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
}
],
"display_name": "EC2-Prod-CPU",
"name": "CPUUtilization",
"namespace_name": "Virtual Server",
"period": 300,
"statistic_type": "AVG"
}
],
"period": 300,
"stacked": false,
"statistic_type": "AVG",
"title": "Virtual Server | CPU Utilization",
"view": "line"
},
"type": "metric",
"width": 1
}
]
}
10.1.11.2 - 1.0
put /v1/dashboards/{dashboard_id}
Description
Set dashboard
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | dashboard_id required | Dashboard’s unique ID Example : b48e730a70e74f6aa3d2555000b5c22b | string | None |
| body | body required | DashboardUpdateRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | DashboardDetailResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/dashboards/{dashboard_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = servicewatch 1.0"
Request body
{
"name": "Renamed-Dashboard",
"widgets": [
{
"height": 1,
"order": 1,
"properties": {
"metrics": [
{
"color": "#ff7f0e",
"dimensions": [
{
"key": "InstanceId",
"value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
}
],
"display_name": "EC2-Prod-CPU",
"individual_items": [
{
"key": "BucketId",
"value": "b-1234567890abcdef0"
}
],
"name": "CPUUtilization",
"namespace_name": "Virtual Server",
"period": 300,
"statistic_type": "AVG"
}
],
"period": 300,
"stacked": false,
"statistic_type": "AVG",
"title": "Virtual Server | CPU Utilization",
"view": "line"
},
"type": "metric",
"width": 1
}
]
}
Example HTTP response
Response 200
{
"alerts": {
"summary": {
"high": 1,
"low": 0,
"medium": 3
},
"widgets": [
{
"properties": {
"metrics": [
{
"alerts": [
{
"id": "",
"name": ""
}
],
"color": "#ff7f0e",
"dimensions": [
{
"key": "InstanceId",
"value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
}
],
"display_name": "EC2-Prod-CPU",
"individual_items": [
{
"key": "BucketId",
"value": "b-1234567890abcdef0"
}
],
"name": "CPUUtilization",
"namespace_name": "Virtual Server",
"period": 300,
"statistic_type": "AVG"
}
],
"period": 300,
"stacked": false,
"statistic_type": "AVG",
"title": "Virtual Server | CPU Utilization",
"view": "line"
}
}
]
},
"created_at": "2026-02-11T06:44:14.512Z",
"created_by": "user-xxxxxxxx",
"favorite_enabled": true,
"id": "b48e730a70e74f6aa3d2555000b5c22b",
"modified_at": "",
"modified_by": "user-yyyyyyyy",
"name": "Production-Web-Servers",
"product_name": "ServiceWatch",
"resource_id": "c8e41e595ad040a8abe57e2ffc109113",
"resource_name": "Production-Web-Servers",
"resource_type": "dashboard",
"share_type": "Private",
"srn": "srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113",
"type": "Custom",
"widgets": [
{
"dashboard_id": "b48e730a70e74f6aa3d2555000b5c22b",
"height": 1,
"id": "75da70a1a4fb486ab0282cf90693ec3c",
"order": 1,
"properties": {
"metrics": [
{
"color": "#ff7f0e",
"dimensions": [
{
"key": "InstanceId",
"value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
}
],
"display_name": "EC2-Prod-CPU",
"individual_items": [
{
"key": "BucketId",
"value": "b-1234567890abcdef0"
}
],
"name": "CPUUtilization",
"namespace_name": "Virtual Server",
"period": 300,
"statistic_type": "AVG"
}
],
"period": 300,
"stacked": false,
"statistic_type": "AVG",
"title": "Virtual Server | CPU Utilization",
"view": "line"
},
"type": "metric",
"width": 1
}
]
}
10.1.12 - ShowAgentDownloadLink
10.1.12.1 - 1.1
get /v1/agents/download-link
Description
Show link to agent download
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | AgentDownloadLinkResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
Example HTTP request
Request path
/v1/agents/download-link
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = servicewatch 1.1"
Example HTTP response
Response 200
{
"download_link": "download_link = 'https://object-store.private.{region}.{environment}.samsungsdscloud.com/account:swt-agent/1.0/ServiceWatch_Agent.zip'"
}
10.1.13 - ShowDashboard
10.1.13.1 - 1.1
get /v1/dashboards/{dashboard_id}
Description
Show dashboard
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.1 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | dashboard_id required | Dashboard’s unique ID Example : b48e730a70e74f6aa3d2555000b5c22b | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | DashboardDetailResponseV1Dot1 |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/dashboards/{dashboard_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = servicewatch 1.1"
Example HTTP response
Response 200
{
"alerts": {
"summary": {
"high": 1,
"low": 0,
"medium": 3
},
"widgets": [
{
"properties": {
"metrics": [
{
"alerts": [
{
"id": "",
"name": ""
}
],
"color": "#ff7f0e",
"dimensions": [
{
"key": "InstanceId",
"value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
}
],
"display_name": "EC2-Prod-CPU",
"individual_items": [
{
"key": "BucketId",
"value": "b-1234567890abcdef0"
}
],
"name": "CPUUtilization",
"namespace_name": "Virtual Server",
"period": 300,
"statistic_type": "AVG"
}
],
"period": 300,
"stacked": false,
"statistic_type": "AVG",
"title": "Virtual Server | CPU Utilization",
"view": "line"
}
}
]
},
"created_at": "2026-02-11T06:44:15.180Z",
"created_by": "user-xxxxxxxx",
"favorite_enabled": true,
"id": "b48e730a70e74f6aa3d2555000b5c22b",
"modified_at": "",
"modified_by": "user-yyyyyyyy",
"name": "Production-Web-Servers",
"product_name": "ServiceWatch",
"resource_id": "c8e41e595ad040a8abe57e2ffc109113",
"resource_name": "Production-Web-Servers",
"resource_type": "dashboard",
"share_type": "Private",
"srn": "srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113",
"type": "Custom",
"widgets": [
{
"dashboard_id": "b48e730a70e74f6aa3d2555000b5c22b",
"height": 1,
"id": "75da70a1a4fb486ab0282cf90693ec3c",
"order": 1,
"properties": {
"metrics": [
{
"color": "#ff7f0e",
"dimensions": [
{
"key": "InstanceId",
"value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
}
],
"display_name": "EC2-Prod-CPU",
"name": "CPUUtilization",
"namespace_name": "Virtual Server",
"period": 300,
"statistic_type": "AVG"
}
],
"period": 300,
"stacked": false,
"statistic_type": "AVG",
"title": "Virtual Server | CPU Utilization",
"view": "line"
},
"type": "metric",
"width": 1
}
]
}
10.1.13.2 - 1.0
get /v1/dashboards/{dashboard_id}
Description
Show dashboard
상태 ACTIVE (SUPPORTED)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | 20260630 |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | dashboard_id required | Dashboard’s unique ID Example : b48e730a70e74f6aa3d2555000b5c22b | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | DashboardDetailResponse |
| 401 | Unauthorized | None |
| 403 | Forbidden | None |
| 404 | Not Found | None |
Example HTTP request
Request path
/v1/dashboards/{dashboard_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = servicewatch 1.0"
Example HTTP response
Response 200
{
"alerts": {
"summary": {
"high": 1,
"low": 0,
"medium": 3
},
"widgets": [
{
"properties": {
"metrics": [
{
"alerts": [
{
"id": "",
"name": ""
}
],
"color": "#ff7f0e",
"dimensions": [
{
"key": "InstanceId",
"value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
}
],
"display_name": "EC2-Prod-CPU",
"individual_items": [
{
"key": "BucketId",
"value": "b-1234567890abcdef0"
}
],
"name": "CPUUtilization",
"namespace_name": "Virtual Server",
"period": 300,
"statistic_type": "AVG"
}
],
"period": 300,
"stacked": false,
"statistic_type": "AVG",
"title": "Virtual Server | CPU Utilization",
"view": "line"
}
}
]
},
"created_at": "2026-02-11T06:44:14.512Z",
"created_by": "user-xxxxxxxx",
"favorite_enabled": true,
"id": "b48e730a70e74f6aa3d2555000b5c22b",
"modified_at": "",
"modified_by": "user-yyyyyyyy",
"name": "Production-Web-Servers",
"product_name": "ServiceWatch",
"resource_id": "c8e41e595ad040a8abe57e2ffc109113",
"resource_name": "Production-Web-Servers",
"resource_type": "dashboard",
"share_type": "Private",
"srn": "srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113",
"type": "Custom",
"widgets": [
{
"dashboard_id": "b48e730a70e74f6aa3d2555000b5c22b",
"height": 1,
"id": "75da70a1a4fb486ab0282cf90693ec3c",
"order": 1,
"properties": {
"metrics": [
{
"color": "#ff7f0e",
"dimensions": [
{
"key": "InstanceId",
"value": "10bf5d24-0f20-4066-bb0b-de2b1d6ff502"
}
],
"display_name": "EC2-Prod-CPU",
"individual_items": [
{
"key": "BucketId",
"value": "b-1234567890abcdef0"
}
],
"name": "CPUUtilization",
"namespace_name": "Virtual Server",
"period": 300,
"statistic_type": "AVG"
}
],
"period": 300,
"stacked": false,
"statistic_type": "AVG",
"title": "Virtual Server | CPU Utilization",
"view": "line"
},
"type": "metric",
"width": 1
}
]
}
10.2 - Models
10.2.1 - AgentDownloadLinkResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| download_link required | URL to download agent Example : download_link = 'https://object-store.private.{region}.{environment}.samsungsdscloud.com/account:swt-agent/1.0/ServiceWatch_Agent.zip' | string |
10.2.2 - AlertPropertiesDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| metrics required | List of metrics included in the widget | array[MetricAlertsDTO] | |
| period optional | Query period (seconds) Example : 300 | any of [integer, null] | |
| stacked required | Whether the graph is stacked Example : False | boolean | |
| statistic_type optional | Statistical function Example : AVG | any of [string, null] | |
| title required | Widget title Example : Virtual Server | CPU Utilization | string | |
| view required | View type Example : line | string |
10.2.3 - AlertsObjectDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| summary required | Alert summary | AlertSummaryDTO | |
| widgets optional | List of widgets containing alert information | any of [array[DashboardAlertWidgetDTO], null] |
10.2.4 - AlertSummaryDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| high required | Number of high-severity alarms Example : 1 | integer | |
| low required | Number of low-severity alarms Example : 0 | integer | |
| medium required | Number of medium-severity alarms Example : 3 | integer |
10.2.5 - CustomLogAttributeDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | Key Example : | string | |
| value required | Value | CustomLogValueDTO |
10.2.6 - CustomLogEventsCreateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| resourceLogs required | Resource Logs | array[CustomResourceLogDTO] |
10.2.7 - CustomLogEventsCreateResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| status required | Status Example : success | string |
10.2.8 - CustomLogRecordDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| body required | Body | CustomLogValueDTO | |
| timeUnixNano required | Unix nano time Example : 1762336464000000000 | integer |
10.2.9 - CustomLogResourceDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| attributes required | Attributes Example : [{'key': 'log_stream_value', 'value': {'stringValue': 'a1e2f3045678901a2b3c4d5e6f7a8b81'}}, {'key': 'log_group_value', 'value': {'stringValue': 'b1e2f3045678901a2b3c4d5e6f7a8b81'}}, {'key': 'account_id', 'value': {'stringValue': 'c1e2f3045678901a2b3c4d5e6f7a8b81'}}] | array[CustomLogAttributeDTO] |
10.2.10 - CustomLogValueDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| stringValue required | String Value: account_id, log_group_value, log_stream_value Example : level=info otlp test log | string |
10.2.11 - CustomResourceLogDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| resource required | Resource | CustomLogResourceDTO | |
| scopeLogs required | Scope Log | array[CustomScopeLogDTO] |
10.2.12 - CustomScopeLogDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| logRecords required | Log Records | array[CustomLogRecordDTO] |
10.2.13 - DashboardAlertWidgetDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| properties required | Widget’s detailed properties | AlertPropertiesDTO |
10.2.14 - DashboardBulkDeleteRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| dashboard_ids required | List of dashboard IDs Example : ['b48e730a70e74f6aa3d2555000b5c22b', 'c48e730a70e74f6aa3d2555000b5c22b'] | array[string] |
10.2.15 - DashboardBulkDeleteResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| dashboard_names required | List of dashboard’s name Example : ['dash-abc', 'dash-def'] | array[string] |
10.2.16 - DashboardCreationRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| name required | Dashboard’s name Example : New-Monitoring-Dashboard | string | |
| widgets optional | List of widgets included in the dashboard | any of [array[WidgetDTO], null] |
10.2.17 - DashboardDetailResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| alerts optional | Alert information related to the dashboard | any of [AlertsObjectDTO, null] | |
| created_at required | Created date time Example : 2026-02-11T06:44:14.512Z | string (date-time) | |
| created_by required | Creator ID Example : user-xxxxxxxx | string | |
| favorite_enabled required | Whether it is a favorite dashboard Example : True | boolean | |
| id required | Dashboard’s unique ID Example : b48e730a70e74f6aa3d2555000b5c22b | string | |
| modified_at optional | Modified date time Example : | any of [string (date-time), null] | |
| modified_by optional | Modifier ID Example : user-yyyyyyyy | any of [string, null] | |
| name required | Dashboard’s name Example : Production-Web-Servers | string | |
| product_name required | Associated resource type Example : ServiceWatch | string | |
| resource_id required | Associated resource ID Example : c8e41e595ad040a8abe57e2ffc109113 | string | |
| resource_name required | Associated resource name Example : Production-Web-Servers | string | |
| resource_type required | Associated resource type Example : dashboard | string | |
| share_type required | Sharing type Example : Private | string | |
| srn required | Service resource name (SRN) Example : srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113 | string | |
| type required | Dashboard type Example : Custom | string | |
| widgets optional | List of widgets included in the dashboard | any of [array[WidgetDetailDTO], null] |
10.2.18 - DashboardDetailResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| alerts optional | Alert information related to the dashboard | any of [AlertsObjectDTO, null] | |
| created_at required | Created date time Example : 2026-02-11T06:44:15.180Z | string (date-time) | |
| created_by required | Creator ID Example : user-xxxxxxxx | string | |
| favorite_enabled required | Whether it is a favorite dashboard Example : True | boolean | |
| id required | Dashboard’s unique ID Example : b48e730a70e74f6aa3d2555000b5c22b | string | |
| modified_at optional | Modified date time Example : | any of [string (date-time), null] | |
| modified_by optional | Modifier ID Example : user-yyyyyyyy | any of [string, null] | |
| name required | Dashboard’s name Example : Production-Web-Servers | string | |
| product_name required | Associated resource type Example : ServiceWatch | string | |
| resource_id required | Associated resource ID Example : c8e41e595ad040a8abe57e2ffc109113 | string | |
| resource_name required | Associated resource name Example : Production-Web-Servers | string | |
| resource_type required | Associated resource type Example : dashboard | string | |
| share_type required | Sharing type Example : Private | string | |
| srn required | Service resource name (SRN) Example : srn:vs:kr-central-1:123456789012:instance/c8e41e595ad040a8abe57e2ffc109113 | string | |
| type required | Dashboard type Example : Custom | string | |
| widgets optional | List of widgets included in the dashboard | any of [array[WidgetDetailDtoV1Dot1], null] |
10.2.19 - DashboardDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| created_at required | Created date time Example : 2026-02-11T06:44:14.473Z | string (date-time) | |
| favorite_enabled required | Whether it is a favorite dashboard Example : True | boolean | |
| id required | Dashboard’s unique ID Example : b48e730a70e74f6aa3d2555000b5c22b | string | |
| modified_at required | Modified date time Example : 2026-02-11T06:44:14.474Z | string (date-time) | |
| name required | Dashboard’s name Example : Production-Web-Servers | string | |
| type required | Dashboard type Example : Custom | string |
10.2.20 - DashboardPageResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| dashboards required | List of dashboards | array[DashboardDTO] | |
| page required | page Example : 0 | integer | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
10.2.21 - DashboardUpdateRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| name optional | Dashboard’s name Example : Renamed-Dashboard | any of [string, null] | |
| widgets optional | List of widgets included in the dashboard | any of [array[WidgetDTO], null] |
10.2.22 - DimensionDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | Dimension Key Example : InstanceId | string | |
| value required | Dimension Value Example : 10bf5d24-0f20-4066-bb0b-de2b1d6ff502 | string |
10.2.23 - IndividualItemDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | Individual item’s key Example : bucket_id | string | |
| value required | Individual item’s value Example : 6870d9989ec3496c932de11b409ed9cc | object |
10.2.24 - LogGroupsLogStreamsCollectCustomRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| log_group_name required | Log group name Example : testlg01 | string | |
| log_stream_name required | Log stream name Example : testls01 | string |
10.2.25 - LogGroupsLogStreamsCollectCustomResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID Example : 1bcf39b344ac41cbaf0466ff0d2bebad | string | |
| log_group_value required | Log group value Example : fa6169af200b4d5db229aff384b2a028 | string | |
| log_stream_value required | Log stream value Example : 551513c5182b45beb22eadb634cdccfb | string | |
| requests_per_second required | 초당 로그 요청 내보내기 Example : 500 | integer |
10.2.26 - MetricAlert
| Name | Description | Schema | Default |
|---|---|---|---|
| id required | Example : | string | |
| name required | Example : | string |
10.2.27 - MetricAlertDto
| Name | Description | Schema | Default |
|---|---|---|---|
| id required | Alert ID Example : 0ad6da92-634a-4f8c-932e-9d650599ab1e | string | |
| name required | Alert Name Example : Alert1 | string |
10.2.28 - MetricAlertsDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| alerts optional | List of Alerts | any of [array[MetricAlert], null] | |
| color required | Metric line color Example : #ff7f0e | string | |
| dimensions required | List of Dimensions | array[DimensionDTO] | |
| display_name required | Display name (label) of the metric Example : EC2-Prod-CPU | string | |
| individual_items optional | List of Individual Items Example : [{'key': 'BucketId', 'value': 'b-1234567890abcdef0'}] | any of [array[IndividualItemDTO], null] | |
| name required | Metric Name Example : CPUUtilization | string | |
| namespace_name required | Namespace Example : Virtual Server | string | |
| period required | Query period (seconds) Example : 300 | integer | |
| statistic_type required | Statistical function Example : AVG | string |
10.2.29 - MetricCustomMetaRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| metricMetas required | array[MetricMetaDto] | ||
| namespace required | Namespace Example : MyCustom/filestorage | string |
10.2.30 - MetricCustomMetaResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | Account ID of Metrics Example : d79a5194b1a44a858969eb94754d3ba1 | string | |
| max_data_points optional | Example : | integer | |
| unit_logs required | array[UnitLogDto] |
10.2.31 - MetricCustomRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| resource_metrics required | The resourceMetrics field holds a set of all metric data associated with a specific resource | array[OtlpResourceMetricDto] |
10.2.32 - MetricDataImageDto
| Name | Description | Schema | Default |
|---|---|---|---|
| color optional | Color Example : #0000ff | any of [string, null] | |
| dimensions required | List of Dimensions | array[MetricLabelDto] | |
| display_name optional | Metric Display Name Example : Virtual Server | VirtualServer001 | CPU Usage/Core[Basic] | any of [string, null] | |
| individual_items optional | List of Individual Items | any of [array[MetricLabelDto], null] | |
| name required | Metric Name Example : CPU Usage/Core[Basic] | string | |
| namespace_name required | Namespace Example : Virtual Server | string | |
| period optional | Statistic Period Example : 300 | any of [integer, null] | |
| statistic_type optional | Metric Statistics Type Example : AVG | any of [enum (AVG, SUM, MAX, MIN, CNT), null] |
10.2.33 - MetricDataImageDtoV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| color optional | Color Example : #0000ff | any of [string, null] | |
| dimensions required | List of Dimensions | array[MetricLabelDto] | |
| display_name optional | Metric Display Name Example : Virtual Server | VirtualServer001 | CPU Usage/Core[Basic] | any of [string, null] | |
| name required | Metric Name Example : CPU Usage/Core[Basic] | string | |
| namespace_name required | Namespace Example : Virtual Server | string | |
| period optional | Statistic Period Example : 300 | any of [integer, null] | |
| statistic_type optional | Metric Statistics Type Example : AVG | any of [enum (AVG, SUM, MAX, MIN, CNT), null] |
10.2.34 - MetricDataImageRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| end required | Metric End Time - Unix Timestamp Example : 1640995440Maximum : 4102444800 | integer | |
| height optional | Chart Image Height(pixels) Example : 400 | any of [integer, null] | 500 |
| metrics required | array[MetricDataImageDto] | ||
| period required | Statistic Period Example : 300 | integer | |
| start required | Metric Start Time - Unix Timestamp Example : 1640995200Maximum : 4102444800 | integer | |
| statistic_type required | Metric Statistics Type Example : AVG | enum (AVG, SUM, MAX, MIN, CNT) | |
| timezone optional | 타임존 Example : UTC | any of [string, null] | UTC |
| title optional | Chart Title Example : Virtual Server Metric Chart | any of [string, null] | |
| width optional | Chart Image Width(pixels) Example : 600 | any of [integer, null] | 1400 |
10.2.35 - MetricDataImageRequestV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| end required | Metric End Time - Unix Timestamp Example : 1640995440Maximum : 4102444800 | integer | |
| height optional | Chart Image Height(pixels) Example : 400 | any of [integer, null] | 500 |
| metrics required | array[MetricDataImageDtoV1Dot1] | ||
| period required | Statistic Period Example : 300 | integer | |
| start required | Metric Start Time - Unix Timestamp Example : 1640995200Maximum : 4102444800 | integer | |
| statistic_type required | Metric Statistics Type Example : AVG | enum (AVG, SUM, MAX, MIN, CNT) | |
| timezone optional | 타임존 Example : UTC | any of [string, null] | UTC |
| title optional | Chart Title Example : Virtual Server Metric Chart | any of [string, null] | |
| width optional | Chart Image Width(pixels) Example : 600 | any of [integer, null] | 1400 |
10.2.36 - MetricDataRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| end required | Metric End Time - Unix Timestamp Example : 1640995440Maximum : 4102444800 | integer | |
| metrics required | array[MetricDetailDto] | ||
| period required | Statistic Period Example : 300 | integer | |
| start required | Metric Start Time - Unix Timestamp Example : 1640995200Maximum : 4102444800 | integer | |
| statistic_type required | Metric Statistics Type Example : AVG | enum (AVG, SUM, MAX, MIN, CNT) |
10.2.37 - MetricDataRequestV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| end required | Metric End Time - Unix Timestamp Example : 1640995440Maximum : 4102444800 | integer | |
| metrics required | array[MetricDetailDtoV1Dot1] | ||
| period required | Statistic Period Example : 300 | integer | |
| start required | Metric Start Time - Unix Timestamp Example : 1640995200Maximum : 4102444800 | integer | |
| statistic_type required | Metric Statistics Type Example : AVG | enum (AVG, SUM, MAX, MIN, CNT) |
10.2.38 - MetricDataResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| metrics required | array[MetricDataResponseDto] |
10.2.39 - MetricDataResponseDto
| Name | Description | Schema | Default |
|---|---|---|---|
| display_name required | Metric Display Name Example : Virtual Server | VirtualServer001 | CPU Usage/Core[Basic] | string | |
| status required | Example : | string | |
| values required | List of Metric Series Values Example : [[1640995200, "45.5"]] | array[array[any of [integer, string]]] |
10.2.40 - MetricDetailDto
| Name | Description | Schema | Default |
|---|---|---|---|
| dimensions required | List of Dimensions | array[MetricLabelDto] | |
| display_name optional | Metric Display Name Example : Virtual Server | VirtualServer001 | CPU Usage/Core[Basic] | any of [string, null] | |
| individual_items optional | List of Individual Items | any of [array[MetricLabelDto], null] | |
| name required | Metric Name Example : CPU Usage/Core[Basic] | string | |
| namespace_name required | Namespace Example : Virtual Server | string | |
| period optional | Statistic Period Example : 300 | any of [integer, null] | |
| statistic_type optional | Metric Statistics Type Example : AVG | any of [enum (AVG, SUM, MAX, MIN, CNT), null] |
10.2.41 - MetricDetailDtoV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| dimensions required | List of Dimensions | array[MetricLabelDto] | |
| display_name optional | Metric Display Name Example : Virtual Server | VirtualServer001 | CPU Usage/Core[Basic] | any of [string, null] | |
| name required | Metric Name Example : CPU Usage/Core[Basic] | string | |
| namespace_name required | Namespace Example : Virtual Server | string | |
| period optional | Statistic Period Example : 300 | any of [integer, null] | |
| statistic_type optional | Metric Statistics Type Example : AVG | any of [enum (AVG, SUM, MAX, MIN, CNT), null] |
10.2.42 - MetricDimensionDto
| Name | Description | Schema | Default |
|---|---|---|---|
| columns required | array[MetricsMetricColumnDto] | ||
| key required | Dimension Key Example : InstanceId | string | |
| metrics required | array[MetricListDto] |
10.2.43 - MetricDimensionDtoV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| columns required | array[MetricsMetricColumnDto] | ||
| keys required | Dimension Key Example : InstanceId | array[string] | |
| metrics required | array[MetricListDtoV1Dot1] |
10.2.44 - MetricDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| color required | Metric line color Example : #ff7f0e | string | |
| dimensions required | List of Dimensions | array[DimensionDTO] | |
| display_name required | Display name (label) of the metric Example : EC2-Prod-CPU | string | |
| individual_items optional | List of Individual Items Example : [{'key': 'BucketId', 'value': 'b-1234567890abcdef0'}] | any of [array[IndividualItemDTO], null] | |
| name required | Metric Name Example : CPUUtilization | string | |
| namespace_name required | Namespace Example : Virtual Server | string | |
| period required | Query period (seconds) Example : 300 | integer | |
| statistic_type required | Statistical function Example : AVG | string |
10.2.45 - MetricDtoV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| color required | Metric line color Example : #ff7f0e | string | |
| dimensions required | List of Dimensions | array[DimensionDTO] | |
| display_name required | Display name (label) of the metric Example : EC2-Prod-CPU | string | |
| name required | Metric Name Example : CPUUtilization | string | |
| namespace_name required | Namespace Example : Virtual Server | string | |
| period required | Query period (seconds) Example : 300 | integer | |
| statistic_type required | Statistical function Example : AVG | string |
10.2.46 - MetricLabelDto
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | Key Example : VolumeID | string | |
| value required | Value Example : 45fbde15-cdd2-4891-be31-4a9de75fccda | string |
10.2.47 - MetricLabelNameDto
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | Key Example : VolumeID | string | |
| value required | Value Example : 45fbde15-cdd2-4891-be31-4a9de75fccda | any of [string, null] |
10.2.48 - MetricListDto
| Name | Description | Schema | Default |
|---|---|---|---|
| alerts required | List of Alerts | any of [array[MetricAlertDto], null] | |
| default_collection_interval required | Metric’s Default Collection Interval Example : 5m | enum (NONE, 1m, 5m) | |
| detailed_collection_interval required | Metric’s Detailed Collection Interval Example : 1m | enum (NONE, 1m, 5m) | |
| dimensions required | List of Dimensions | array[MetricLabelDto] | |
| id required | Metric ID Example : d91097ac-0387-4e69-adb2-7b8d453b8db5 | string | |
| individual_items optional | List of Dimensions | any of [array[MetricLabelDto], null] | |
| name required | Metric Name Example : CPU Usage/Core[Basic] | string | |
| named_dimensions required | List of Dimensions | any of [array[MetricLabelNameDto], null] | |
| namespace_id required | Namespace ID Example : d583a229-9766-4eb8-96c4-ec389902ba3d | string | |
| namespace_name required | Namespace Example : Virtual Server | string | |
| primary required | Primary Metric Example : True | boolean | |
| recommended_stat_types required | List of Recommended Metric Statistics Example : ["AVG", "MAX"] | array[string] | |
| tags required | List of Tags | any of [array[TagDTO], null] | |
| unit required | Metric Unit Example : BYTE | string |
10.2.49 - MetricListDtoV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| alerts required | List of Alerts | any of [array[MetricAlertDto], null] | |
| default_collection_interval required | Metric’s Default Collection Interval Example : 5m | enum (NONE, 1m, 5m) | |
| detailed_collection_interval required | Metric’s Detailed Collection Interval Example : 1m | enum (NONE, 1m, 5m) | |
| dimensions required | List of Dimensions | array[MetricLabelDto] | |
| id required | Metric ID Example : d91097ac-0387-4e69-adb2-7b8d453b8db5 | string | |
| name required | Metric Name Example : CPU Usage/Core[Basic] | string | |
| named_dimensions required | List of Dimensions | any of [array[MetricLabelNameDto], null] | |
| namespace_id required | Namespace ID Example : d583a229-9766-4eb8-96c4-ec389902ba3d | string | |
| namespace_name required | Namespace Example : Virtual Server | string | |
| primary required | Primary Metric Example : True | boolean | |
| recommended_stat_types required | List of Recommended Metric Statistics Example : ["AVG", "MAX"] | array[string] | |
| tags required | List of Tags | any of [array[TagDTO], null] | |
| unit required | Metric Unit Example : BYTE | string |
10.2.50 - MetricMetaDto
| Name | Description | Schema | Default |
|---|---|---|---|
| descriptionEn required | Description of Metrics in English Example : filestorage volume total byte | any of [string, null] | |
| descriptionKo required | Description of Metrics in Korean Example : 파일스토리지 총 바이트 수 | any of [string, null] | |
| dimensions required | List of Dimension Keys Example : [['image_id']] | array[array[string]] | |
| metricName required | Metric Name Example : Custom_filestorage_volume_total_byte | string | |
| storageResolution optional | Storage Resolution Example : 60 | any of [integer, null] | |
| unit required | Metric Unit Example : Bytes | any of [enum (Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, Count/Minute, None), null] |
10.2.51 - MetricNamespaceDto
| Name | Description | Schema | Default |
|---|---|---|---|
| dimensions required | array[MetricDimensionDto] | ||
| id required | Namespace ID Example : d583a229-9766-4eb8-96c4-ec389902ba3d | string | |
| name required | Namespace Example : Virtual Server | string | |
| service_name required | Example : | string |
10.2.52 - MetricNamespaceDtoV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| dimensions required | array[MetricDimensionDtoV1Dot1] | ||
| id required | Namespace ID Example : d583a229-9766-4eb8-96c4-ec389902ba3d | string | |
| name required | Namespace Example : Virtual Server | string | |
| service_name required | Example : | string |
10.2.53 - MetricSearchRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| metric_name optional | Metric Name Example : CPU Usage/Core[Basic] | any of [string, null] | |
| namespaces optional | List of Namespace | any of [array[SearchOptionNamespaceDto], null] | |
| resource_id optional | Resource ID Example : 10bf5d24-0f20-4066-bb0b-de2b1d6ff502 | any of [string, null] | |
| resource_name optional | Resource Name Example : VirtualServer01 | any of [string, null] | |
| tags optional | List of Tags | any of [array[TagDTO], null] |
10.2.54 - MetricSearchRequestV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| metric_name optional | Metric Name Example : CPU Usage/Core[Basic] | any of [string, null] | |
| namespaces optional | List of Namespace | any of [array[SearchOptionNamespaceDtoV1Dot1], null] | |
| resource_id optional | Resource ID Example : 10bf5d24-0f20-4066-bb0b-de2b1d6ff502 | any of [string, null] | |
| resource_name optional | Resource Name Example : VirtualServer01 | any of [string, null] | |
| tags optional | List of Tags | any of [array[TagDTO], null] |
10.2.55 - MetricsMetricColumnDto
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | Column Key Example : name | string | |
| name_en required | Column Name Example : 지표명 | string | |
| name_ko required | Column Name Example : 지표명 | string |
10.2.56 - MetricsResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | Count Example : 1 | integer | |
| namespaces required | array[MetricNamespaceDto] |
10.2.57 - MetricsResponseV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | Count Example : 1 | integer | |
| namespaces required | array[MetricNamespaceDtoV1Dot1] |
10.2.58 - OtlpAttributeDto
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | Key value of an Attribute. Generally, Resource Attributes are configured to signify the entity or environment from which the metric data was collected. Data Point Attributes represent the name of the label. Example : | string | |
| value required | Value of Attribute. There are fields that correspond to multiple types, and only a single value may be sent. If more than one value is provided, only one will be accepted and the additional values will be dropped | OtlpAttributeValueDto |
10.2.59 - OtlpAttributeValueDto
| Name | Description | Schema | Default |
|---|---|---|---|
| array_value optional | Array-typed Value of Attribute Example : | any of [array[object], null] | |
| bool_value optional | Bool-typed Value of Attribute Example : | any of [boolean, null] | |
| byte_value optional | Byte-typed Value of Attribute Example : | any of [string (binary), null] | |
| double_value optional | Double-typed Value of Attribute Example : | any of [object, null] | |
| int_value optional | Int-typed Value of Attribute Example : | any of [integer, null] | |
| kvlist_value optional | Key-Value List-typed Value of Attribute Example : | any of [object, null] | |
| string_value optional | String-typed Value of Attribute Example : | any of [string, null] |
10.2.60 - OtlpGaugeDto
| Name | Description | Schema | Default |
|---|---|---|---|
| data_points required | The dataPoints field contains a list of the actual observed values for a specific metric, where each value has a timestamp and a metric value. The value of a data point must be represented as either asInt or asDouble, and only a single value may be sent. If more than one value is provided, only one will be accepted and the additional values will be dropped | array[OtlpNumberDataPointDto] |
10.2.61 - OtlpMetricDto
| Name | Description | Schema | Default |
|---|---|---|---|
| description optional | Description of Metric Example : The total number of bytes read successfully. | any of [string, null] | |
| gauge optional | The gauge field is a metric type that represents a single value at a specific point in time, used for measuring fluctuating values like current memory usage or CPU temperature. either sum or gauge must be specified. | any of [OtlpGaugeDto, null] | |
| name required | Name of Metric Example : node_disk_read_bytes_total | string | |
| sum optional | The sum field is a metric type that represents a cumulative value over time, used for measuring quantities that only increase, like the number of requests or bytes sent. either sum or gauge must be specified. | any of [OtlpSumDto, null] | |
| unit optional | Unit of Metric Example : Bytes | any of [string, null] |
10.2.62 - OtlpNumberDataPointDto
| Name | Description | Schema | Default |
|---|---|---|---|
| as_double optional | Double-typed value of the metric Example : 0.75 | any of [object, null] | |
| as_int optional | Int-typed value of the metric Example : 10 | any of [integer, null] | |
| attributes required | Labels of Metric | array[OtlpAttributeDto] | |
| start_time_unix_nano optional | Unix timestamp, expressed in nanoseconds, for the moment when the metric data began being measured (only used for sum, not for gauge) Example : 1753776789854000000 | any of [string, null] | |
| time_unix_nano required | Unix timestamp, expressed in nanoseconds, for the moment when the metric data was measured or when the measurement ended Example : 1753776789854000000 | integer |
10.2.63 - OtlpResourceDto
| Name | Description | Schema | Default |
|---|---|---|---|
| attributes required | Resource attributes of Metric | array[OtlpAttributeDto] |
10.2.64 - OtlpResourceMetricDto
| Name | Description | Schema | Default |
|---|---|---|---|
| resource required | The resource field holds attributes that describe the entity or environment from which the metric data originated | OtlpResourceDto | |
| scope_metrics required | The scopeMetrics field holds a set of all metric data associated with a specific instrumentation library/scope | array[OtlpScopeMetricDto] |
10.2.65 - OtlpScopeDto
| Name | Description | Schema | Default |
|---|---|---|---|
| name required | Name of the Collector that collected the metric Example : ServiceWatch-Agent | string | |
| version optional | Version of the Collector that collected the metric Example : 1.0.0 | any of [string, null] |
10.2.66 - OtlpScopeMetricDto
| Name | Description | Schema | Default |
|---|---|---|---|
| metrics required | The metrics field contains a list of the actual metric data generated by the scope, where each item represents a single metric. The metric type can only be gauge or sum, and you must send exactly one value. If more than one value is provided, only one will be accepted and the additional values will be dropped | array[OtlpMetricDto] | |
| scope required | The scope field identifies the instrumentation library or scope that generated the metrics, typically including its name and version | OtlpScopeDto |
10.2.67 - OtlpSumDto
| Name | Description | Schema | Default |
|---|---|---|---|
| aggregation_temporality required | Aggregation Temporality defines the time window over which metric measurements are aggregated, specifying if the reported value is the cumulative sum (2) or the incremental change (1, Delta) since the last report or unspecified (0). Example : 2 | integer | |
| data_points required | The dataPoints field contains a list of the actual observed values for a specific metric, where each value has a timestamp and a metric value. The value of a data point must be represented as either asInt or asDouble, and only a single value may be sent. If more than one value is provided, only one will be accepted and the additional values will be dropped | array[OtlpNumberDataPointDto] | |
| is_monotonic required | Whether the value is monotonic Example : True | boolean |
10.2.68 - PropertiesDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| metrics required | List of metrics included in the widget | array[MetricDTO] | |
| period optional | Query period (seconds) Example : 300 | any of [integer, null] | |
| stacked required | Whether the graph is stacked Example : False | boolean | |
| statistic_type optional | Statistical function Example : AVG | any of [string, null] | |
| title required | Widget title Example : Virtual Server | CPU Utilization | string | |
| view required | View type Example : line | string |
10.2.69 - PropertiesDtoV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| metrics required | List of metrics included in the widget | array[MetricDtoV1Dot1] | |
| period optional | Query period (seconds) Example : 300 | any of [integer, null] | |
| stacked required | Whether the graph is stacked Example : False | boolean | |
| statistic_type optional | Statistical function Example : AVG | any of [string, null] | |
| title required | Widget title Example : Virtual Server | CPU Utilization | string | |
| view required | View type Example : line | string |
10.2.70 - SearchOptionNamespaceDto
| Name | Description | Schema | Default |
|---|---|---|---|
| dimensions required | List of Dimensions Example : ["resource_id"] | array[string] | |
| name required | Namespace Example : Virtual Server | string |
10.2.71 - SearchOptionNamespaceDtoV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| dimensions required | List of Dimensions Example : [["resource_id"]] | array[array[string]] | |
| name required | Namespace Example : Virtual Server | string |
10.2.72 - TagDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| key required | Tag Key Example : key01 | string | |
| value required | Tag Value Example : value01 | string |
10.2.73 - UnitLogDto
| Name | Description | Schema | Default |
|---|---|---|---|
| code required | RESPONSE STATUS CODE of Metric Example : Success | string | |
| message required | Message about Updated Unit Info Example : [libvirt_domain_info_virtual_cpus] unit is updated from Count to Bytes | string |
10.2.74 - WidgetDetailDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| dashboard_id required | Dashboard’s unique ID Example : b48e730a70e74f6aa3d2555000b5c22b | string | |
| height required | Widget’s height Example : 1 | integer | |
| id required | Widget’s unique ID Example : 75da70a1a4fb486ab0282cf90693ec3c | string | |
| order required | Widget’s order in the dashboard Example : 1 | integer | |
| properties required | Widget’s detailed properties | PropertiesDTO | |
| type required | Widget type Example : metric | string | |
| width required | Widget’s width Example : 1 | integer |
10.2.75 - WidgetDetailDtoV1Dot1
| Name | Description | Schema | Default |
|---|---|---|---|
| dashboard_id required | Dashboard’s unique ID Example : b48e730a70e74f6aa3d2555000b5c22b | string | |
| height required | Widget’s height Example : 1 | integer | |
| id required | Widget’s unique ID Example : 75da70a1a4fb486ab0282cf90693ec3c | string | |
| order required | Widget’s order in the dashboard Example : 1 | integer | |
| properties required | Widget’s detailed properties | PropertiesDtoV1Dot1 | |
| type required | Widget type Example : metric | string | |
| width required | Widget’s width Example : 1 | integer |
10.2.76 - WidgetDTO
| Name | Description | Schema | Default |
|---|---|---|---|
| height required | Widget’s height Example : 1 | integer | |
| order required | Widget’s order in the dashboard Example : 1 | integer | |
| properties required | Widget’s detailed properties | PropertiesDTO | |
| type required | Widget type Example : metric | string | |
| width required | Widget’s width Example : 1 | integer |
11 - Support
Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.
본 가이드는 Support 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
OpenAPI URL
https://support.{environment}.samsungsdscloud.com
Environment and Region List
| environment | region |
|---|---|
| s | kr-west1 |
| s | kr-east1 |
| g | kr-south1 |
| g | kr-south2 |
| g | kr-south3 |
| e | kr-west1 |
| e | kr-east1 |
11.1 - APIs
11.1.1 - Get Inquiry List
11.1.1.1 - 1.0
get /v1/inquiries
Description
None
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | title optional | title Example : VM usage inquiry | string | None |
| query | state optional | state Example : CLOSED | string | None |
| query | inquiry_type optional | inquiry type Example : General Inquiry - Account and connection inquiry | string | None |
| query | region_id optional | region id Example : kr-west1 | string | None |
| query | created_at optional | created at Example : 2024-06-01T00:12:57.000000Z | any of [string, null] | None |
| query | filter_inquiry_codes optional | filter inquiry codes Example : FL01,FL02 | string | None |
| query | filter_states optional | filter states Example : TODO,INPROGRESS | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | InquiryListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 500 | Internal Server Error | None |
Example HTTP request
Request path
/v1/inquiries
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = support 1.0"
Example HTTP response
Response 200
{
"count": 20,
"inquiries": [
{
"account_id": "2010571da2f7458e97c3b881b2362b72",
"closed_at": "2024-06-27T08:12:57.000000Z",
"contents": "VM usage inquiry",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"files": [
{
"file_name": "test.txt",
"id": "File-008ccb7ff65244689dacd605fafec92f",
"size": 298426
}
],
"id": "sr-240530-00028-nuri",
"inquiry_code": "G01",
"inquiry_type": "General Inquiry - Account and connection inquiry",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"region_id": "kr-west1",
"resource_name": "lb1",
"service_category": "Networking",
"service_item": "Load Balancer",
"state": "CLOSED",
"title": "VM usage inquiry"
}
],
"page": 0,
"size": 20,
"sort": [
"created_at:asc"
]
}
11.1.2 - Get Service Request List
11.1.2.1 - 1.0
get /v1/service-requests
Description
None
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| query | size optional | size Example : 20 | any of [integer, null] | 20 |
| query | page optional | page Example : 0 | any of [integer, null] | 0 |
| query | sort optional | sort Example : created_at:desc | any of [string, null] | None |
| query | filter_operation_type_ids optional | 2010571da2f7458e97c3b881b2362b72,1h6q5kqt42f7458e97c3b881b2311utn Example : e8fea87728164808860ad81c6ce779b6 | string | None |
| query | filter_service_item_ids optional | service item id list Example : VIRTUAL_SERVER,LOAD_BALANCER | string | None |
| query | filter_title optional | title Example : Virtual Server operation related | string | None |
| query | filter_states optional | filter states Example : REQUESTING,CLOSED | string | None |
| query | from_created_at optional | from created at Example : 2024-07-01T00:00:00Z | any of [string (date-time), null] | None |
| query | to_created_at optional | to created at Example : 2024-07-05T23:59:59Z | any of [string (date-time), null] | None |
| query | operation_type optional | operation type Example : Placement Group Set Up Request | string | None |
| query | service_item_name optional | service item Example : Load Balancer | string | None |
| query | title optional | title Example : Virtual Server operation related | string | None |
| query | state optional | state Example : REQUESTING | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServiceRequestListResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 500 | Internal Server Error | None |
Example HTTP request
Request path
/v1/service-requests
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = support 1.0"
Example HTTP response
Response 200
{
"count": 20,
"page": 0,
"service_requests": [
{
"account_id": "2010571da2f7458e97c3b881b2362b72",
"account_name": "dev_project",
"closed_at": "2024-06-27T08:12:57.000000Z",
"contents": "I need assistance with working with Virtual Server.",
"created_at": "2024-06-01T00:12:57.000000Z",
"created_by": "e3bff0c980dc41b2b6f3ac080b6d3ba0",
"created_by_name": "KimSamSung(test@samsung.com)",
"files": [
{
"file_name": "test.txt",
"id": "File-008ccb7ff65244689dacd605fafec92f",
"size": 298426
}
],
"id": "007d8cc7d60c4b26bb5a833b06686db3",
"iops_result": "Processing completed.",
"iops_sr_id": "SR0002834921",
"modified_at": "2024-06-11T00:12:57.000000Z",
"modified_by": "e3bff0c980dc41b2b6f3ac080b6d3ba0",
"operation_type": "Placement Group Set Up Request",
"region": "kr-west1",
"service_category_name": "Networking",
"service_item_name": "Load Balancer",
"state": "ACTIVE",
"template_id": "e8fea87728164808860ad81c6ce779b6",
"title": "Virtual Server operation related"
}
],
"size": 20,
"sort": [
"created_at:asc"
]
}
11.1.3 - Show Inquiry
11.1.3.1 - 1.0
get /v1/inquiries/{inquiry_id}
Description
None
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | inquiry_id required | id Example : sr-240530-00028-nuri | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | InquiryShowResponse |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
| 500 | Internal Server Error | None |
Example HTTP request
Request path
/v1/inquiries/{inquiry_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = support 1.0"
Example HTTP response
Response 200
{
"affect": "No impact on current service",
"affect_id": "2010571da2f7458e97c3b881b2362b72",
"answer_comment": "Here is the answer to your inquiry.",
"answer_type": "COMMENT / EMAIL / TEL",
"closed_at": "2024-06-27T08:12:57.000000Z",
"contents": "VM usage inquiry",
"created_at": "2024-05-17T00:23:17Z",
"created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"created_by_name": "KimSamSung(test@samsung.com)",
"files": [
{
"file_name": "test.txt",
"id": "File-008ccb7ff65244689dacd605fafec92f",
"size": 298426
}
],
"id": "sr-240530-00028-nuri",
"inquiry_code": "G01",
"inquiry_type": "General Inquiry - Account and connection inquiry",
"modified_at": "2024-05-17T00:23:17Z",
"modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
"recipient_email": "test@samsung.com",
"recipient_tel_nation_id": "+82",
"recipient_telno": "01012341234",
"region_id": "kr-west1",
"resource_name": "lb1",
"service_category": "Networking",
"service_item": "Load Balancer",
"state": "CLOSED",
"title": "VM usage inquiry"
}
11.1.4 - Show Service Request
11.1.4.1 - 1.0
get /v1/service-requests/{service_request_id}
Description
None
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| path | service_request_id required | id Example : 007d8cc7d60c4b26bb5a833b06686db3 | string | None |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | ServiceRequest |
| 400 | Bad Request | None |
| 401 | Unauthorized | None |
| 404 | Not Found | None |
| 500 | Internal Server Error | None |
Example HTTP request
Request path
/v1/service-requests/{service_request_id}
Request header
"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = support 1.0"
Example HTTP response
Response 200
{
"account_id": "2010571da2f7458e97c3b881b2362b72",
"account_name": "dev_project",
"closed_at": "2024-06-27T08:12:57.000000Z",
"contents": "I need assistance with working with Virtual Server.",
"created_at": "2024-06-01T00:12:57.000000Z",
"created_by": "e3bff0c980dc41b2b6f3ac080b6d3ba0",
"created_by_name": "KimSamSung(test@samsung.com)",
"files": [
{
"file_name": "test.txt",
"id": "File-008ccb7ff65244689dacd605fafec92f",
"size": 298426
}
],
"id": "007d8cc7d60c4b26bb5a833b06686db3",
"iops_result": "Processing completed.",
"iops_sr_id": "SR0002834921",
"modified_at": "2024-06-11T00:12:57.000000Z",
"modified_by": "e3bff0c980dc41b2b6f3ac080b6d3ba0",
"operation_type": "Placement Group Set Up Request",
"region": "kr-west1",
"service_category_name": "Networking",
"service_item_name": "Load Balancer",
"state": "ACTIVE",
"template_id": "e8fea87728164808860ad81c6ce779b6",
"title": "Virtual Server operation related"
}
11.2 - Models
11.2.1 - FileResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| file_name required | name Example : test.txt | string | |
| id required | id Example : File-008ccb7ff65244689dacd605fafec92f | string | |
| size required | size Example : 298426 | integer |
11.2.2 - Inquiry
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | account id Example : 2010571da2f7458e97c3b881b2362b72 | any of [string, null] | |
| closed_at required | closed at Example : 2024-06-27T08:12:57.000000Z | any of [string, null] | |
| contents required | contents Example : VM usage inquiry | string | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| files optional | any of [array[FileResponse], null] | ||
| id required | id Example : sr-240530-00028-nuri | string | |
| inquiry_code required | inquiry code Example : G01 | string | |
| inquiry_type required | inquiry type Example : General Inquiry - Account and connection inquiry | string | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| region_id required | region id Example : kr-west1 | any of [string, null] | |
| resource_name required | resource name Example : lb1 | any of [string, null] | |
| service_category required | service category Example : Networking | any of [string, null] | |
| service_item required | service item Example : Load Balancer | any of [string, null] | |
| state required | state Example : CLOSED | string | |
| title required | title Example : VM usage inquiry | string |
11.2.3 - InquiryListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| inquiries required | array[Inquiry] | ||
| page required | page Example : 0 | integer | |
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |
11.2.4 - InquiryShowResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| affect required | affect Example : No impact on current service | any of [string, null] | |
| affect_id required | affect id Example : 2010571da2f7458e97c3b881b2362b72 | any of [string, null] | |
| answer_comment required | answer comment Example : Here is the answer to your inquiry. | any of [string, null] | |
| answer_type optional | answer type Example : COMMENT / EMAIL / TEL | any of [string, null] | |
| closed_at required | closed at Example : 2024-06-27T08:12:57.000000Z | any of [string, null] | |
| contents required | contents Example : VM usage inquiry | string | |
| created_at required | Created At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| created_by required | Created By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| created_by_name optional | created by name and email Example : KimSamSung(test@samsung.com) | any of [string, null] | |
| files optional | any of [array[FileResponse], null] | ||
| id required | id Example : sr-240530-00028-nuri | string | |
| inquiry_code required | inquiry code Example : G01 | string | |
| inquiry_type required | inquiry type Example : General Inquiry - Account and connection inquiry | string | |
| modified_at required | Modified At Example : 2024-05-17T00:23:17Z | string (date-time) | |
| modified_by required | Modified By Example : 90dddfc2b1e04edba54ba2b41539a9ac | string | |
| recipient_email optional | eamil Example : test@samsung.com | any of [string, null] | |
| recipient_tel_nation_id optional | nation id Example : +82 | any of [string, null] | |
| recipient_telno optional | tel no Example : 01012341234 | any of [string, null] | |
| region_id required | region id Example : kr-west1 | any of [string, null] | |
| resource_name required | resource name Example : lb1 | any of [string, null] | |
| service_category required | service category Example : Networking | any of [string, null] | |
| service_item required | service item Example : Load Balancer | any of [string, null] | |
| state required | state Example : CLOSED | string | |
| title required | title Example : VM usage inquiry | string |
11.2.5 - ServiceRequest
| Name | Description | Schema | Default |
|---|---|---|---|
| account_id required | account id Example : 2010571da2f7458e97c3b881b2362b72 | string | |
| account_name required | account name Example : dev_project | any of [string, null] | |
| closed_at optional | closed at Example : 2024-06-27T08:12:57.000000Z | any of [string, null] | |
| contents required | contents Example : I need assistance with working with Virtual Server. | string | |
| created_at required | created at Example : 2024-06-01T00:12:57.000000Z | string | |
| created_by required | created by Example : e3bff0c980dc41b2b6f3ac080b6d3ba0 | string | |
| created_by_name optional | created by name and email Example : KimSamSung(test@samsung.com) | any of [string, null] | |
| files optional | any of [array[FileResponse], null] | ||
| id required | id Example : 007d8cc7d60c4b26bb5a833b06686db3 | string | |
| iops_result optional | iops result Example : Processing completed. | any of [string, null] | |
| iops_sr_id required | iops sr id Example : SR0002834921 | string | |
| modified_at required | modified at Example : 2024-06-11T00:12:57.000000Z | string | |
| modified_by required | modified by Example : e3bff0c980dc41b2b6f3ac080b6d3ba0 | string | |
| operation_type required | operation type Example : Placement Group Set Up Request | string | |
| region required | region Example : kr-west1 | string | |
| service_category_name required | service category Example : Networking | string | |
| service_item_name required | service item Example : Load Balancer | string | |
| state required | state Example : ACTIVE | string | |
| template_id required | template_id Example : e8fea87728164808860ad81c6ce779b6 | string | |
| title required | title Example : Virtual Server operation related | string |
11.2.6 - ServiceRequestListResponse
| Name | Description | Schema | Default |
|---|---|---|---|
| count required | count Example : 20 | integer | |
| page required | page Example : 0 | integer | |
| service_requests required | array[ServiceRequest] | ||
| size required | size Example : 20 | integer | |
| sort optional | sort Example : ['created_at:asc'] | any of [array[string], null] |