This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

APIs

1 - AcceptInvitation

1.1 - 1.1

put /v1/invitations/{invitation_id}/accept

Description

accept a specific invitation

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathinvitation_id
required
초대 ID
Example : 138c2fc8c29a449dbfa8681f8f1d78e2
stringNone

Responses

HTTP CodeDescriptionSchema
200OKInvitationAcceptResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    }
}

1.2 - 1.0

put /v1/invitations/{invitation_id}/accept

Description

accept a specific invitation

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathinvitation_id
required
초대 ID
Example : 138c2fc8c29a449dbfa8681f8f1d78e2
stringNone

Responses

HTTP CodeDescriptionSchema
200OKInvitationAcceptResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    }
}

2 - AttachPolicyBindings

2.1 - 1.1

post /v1/assignments/policy-bindings

Description

attach policy bindings

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

PolicyAttachRequest

Responses

HTTP CodeDescriptionSchema
200OKControlPolicyAssignmentResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    ]
}

2.2 - 1.0

post /v1/assignments/policy-bindings

Description

attach policy bindings

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

PolicyAttachRequest

Responses

HTTP CodeDescriptionSchema
200OKControlPolicyAssignmentResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    ]
}

3 - CancelInvitations

3.1 - 1.1

put /v1/invitations/cancel

Description

cancel invitations

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

InvitationCancelRequest

Responses

HTTP CodeDescriptionSchema
200OKInvitationCancelResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"Scp-Api-Version = organization 1.1"

Request body

{
    "ids": [
        "138c2fc8c29a449dbfa8681f8f1d78e2"
    ],
    "organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5"
}

Example HTTP response

Response 200

{
    "success_ids": [
        "138c2fc8c29a449dbfa8681f8f1d78e2"
    ]
}

3.2 - 1.0

put /v1/invitations/cancel

Description

cancel invitations

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

InvitationCancelRequest

Responses

HTTP CodeDescriptionSchema
200OKInvitationCancelResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"Scp-Api-Version = organization 1.0"

Request body

{
    "ids": [
        "138c2fc8c29a449dbfa8681f8f1d78e2"
    ],
    "organization_id": "o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5"
}

Example HTTP response

Response 200

{
    "success_ids": [
        "138c2fc8c29a449dbfa8681f8f1d78e2"
    ]
}

4 - CreateAccount

4.1 - 1.1

post /v1/organization-accounts

Description

create a account

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

OrganizationUserCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedAccountCreateResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    }
}

4.2 - 1.0

post /v1/organization-accounts

Description

create a account

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

OrganizationUserCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedAccountCreateResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    }
}

5 - CreateDelegationPolicy

5.1 - 1.1

post /v1/delegation-policies

Description

create a delegation policy

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

DelegationPolicyCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedDelegationPolicyShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    }
}

5.2 - 1.0

post /v1/delegation-policies

Description

create a delegation policy

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

DelegationPolicyCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedDelegationPolicyShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    }
}

6 - CreateInvitation

6.1 - 1.1

post /v1/invitations

Description

create an invitation

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

InvitationCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedInvitationCreateResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    ]
}

6.2 - 1.0

post /v1/invitations

Description

create an invitation

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

InvitationCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedInvitationCreateResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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 - CreateOrganization

7.1 - 1.1

post /v1/organizations

Description

create a organization

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

OrganizationCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedOrganizationShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

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 = en-US",
"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.2 - 1.0

post /v1/organizations

Description

create a organization

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

OrganizationCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedOrganizationShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

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 = en-US",
"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
    }
}

8 - CreateOrganizationUnit

8.1 - 1.1

post /v1/organization-units

Description

create an organization unit

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

OrganizationUnitCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedOrganizationUnitCreateResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    }
}

8.2 - 1.0

post /v1/organization-units

Description

create an organization unit

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

OrganizationUnitCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedOrganizationUnitCreateResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    }
}

9 - CreateServiceControlPolicy

9.1 - 1.1

post /v1/service-control-policies

Description

create a service control policy

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

ServiceControlPolicyCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedServiceControlPolicyShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    }
}

9.2 - 1.0

post /v1/service-control-policies

Description

create a service control policy

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

ServiceControlPolicyCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedServiceControlPolicyShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    }
}

10 - DeclineInvitation

10.1 - 1.1

put /v1/invitations/{invitation_id}/decline

Description

decline a specific invitation

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathinvitation_id
required
초대 ID
Example : 138c2fc8c29a449dbfa8681f8f1d78e2
stringNone

Responses

HTTP CodeDescriptionSchema
200OKInvitationShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    }
}

10.2 - 1.0

put /v1/invitations/{invitation_id}/decline

Description

decline a specific invitation

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathinvitation_id
required
초대 ID
Example : 138c2fc8c29a449dbfa8681f8f1d78e2
stringNone

Responses

HTTP CodeDescriptionSchema
200OKInvitationShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    }
}

11 - DeleteDelegationPolicy

11.1 - 1.1

delete /v1/delegation-policies

Description

delete a specific delegation policy

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
queryorganization_id
optional
조직 ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
204No ContentNone
403ForbiddenNone

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 = en-US",
"Scp-Api-Version = organization 1.1"

Example HTTP response

Response 204

11.2 - 1.0

delete /v1/delegation-policies

Description

delete a specific delegation policy

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
queryorganization_id
optional
조직 ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
204No ContentNone
403ForbiddenNone

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 = en-US",
"Scp-Api-Version = organization 1.0"

Example HTTP response

Response 204

12 - DeleteOrganization

12.1 - 1.1

delete /v1/organizations/{organization_id}

Description

delete a specific organization

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathorganization_id
required
조직 ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
stringNone

Responses

HTTP CodeDescriptionSchema
200OKOrganizationDeleteResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
}

12.2 - 1.0

delete /v1/organizations/{organization_id}

Description

delete a specific organization

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathorganization_id
required
조직 ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
stringNone

Responses

HTTP CodeDescriptionSchema
200OKOrganizationDeleteResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
}

13 - DeleteOrganizationUnits

13.1 - 1.1

delete /v1/organization-units

Description

delete organization units

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

OrganizationUnitDeleteRequest

Responses

HTTP CodeDescriptionSchema
200OKOrganizationUnitDeleteResponse
403ForbiddenNone

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 = en-US",
"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"
    ]
}

13.2 - 1.0

delete /v1/organization-units

Description

delete organization units

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

OrganizationUnitDeleteRequest

Responses

HTTP CodeDescriptionSchema
200OKOrganizationUnitDeleteResponse
403ForbiddenNone

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 = en-US",
"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"
    ]
}

14 - DeleteServiceControlPolicies

14.1 - 1.1

delete /v1/service-control-policies

Description

delete service control policies

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

ServiceControlPolicyDeleteRequest

Responses

HTTP CodeDescriptionSchema
200OKServiceControlPolicyDeleteResponse
403ForbiddenNone

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 = en-US",
"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": [
        ""
    ]
}

14.2 - 1.0

delete /v1/service-control-policies

Description

delete service control policies

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

ServiceControlPolicyDeleteRequest

Responses

HTTP CodeDescriptionSchema
200OKServiceControlPolicyDeleteResponse
403ForbiddenNone

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 = en-US",
"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": [
        ""
    ]
}

15 - LeaveOrganization

15.1 - 1.1

delete /v1/organizations/{organization_id}/membership

Description

leave a specific organization

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathorganization_id
required
조직 ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
stringNone

Responses

HTTP CodeDescriptionSchema
200OKOrganizationLeaveResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    }
}

15.2 - 1.0

delete /v1/organizations/{organization_id}/membership

Description

leave a specific organization

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathorganization_id
required
조직 ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
stringNone

Responses

HTTP CodeDescriptionSchema
200OKOrganizationLeaveResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    }
}

16 - ListAccountInvitations

16.1 - 1.1

get /v1/account-invitations

Description

get account invitation list

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Responses

HTTP CodeDescriptionSchema
200OKAccountInvitationResponse
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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
}

16.2 - 1.0

get /v1/account-invitations

Description

get account invitation list

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Responses

HTTP CodeDescriptionSchema
200OKAccountInvitationResponse
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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
}

17 - ListAccounts

17.1 - 1.1

get /v1/organization-accounts

Description

get accounts list

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
queryorganization_id
optional
조직 ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
any of [string, null]None
querysize
optional
size
Example : 20
any of [integer, null]20
querypage
optional
page
Example : 0
any of [integer, null]0
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
queryid
optional
조직 계정 ID
Example : b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
any of [string, null]None
queryname
optional
계정명
Example : score-account
any of [string, null]None
queryemail
optional
계정 이메일
Example : score@samsung.com
any of [string, null]None
querylogin_id
optional
로그인 ID
Example : log-archive@samsung.com
any of [string, null]None
queryjoined_start_date
optional
가입 조회 시작 일시
Example : 2024-05-17T12:34:56.789Z
any of [string, null]None
queryjoined_end_date
optional
가입 조회 종료 일시
Example : 2024-05-17T12:34:56.789Z
any of [string, null]None
queryjoined_method
optional
가입 방법
Example : INVITED
any of [enum (INVITED, CREATED, CLOUD_CONTROL), null]None
queryexclude_policy_id
optional
제외할 정책 ID
Example : 238c2fc8c29a449dbfa8681f8f1d78e2
any of [string, null]None
queryparent_unit_id
optional
ROOT 또는 부모 조직 단위 ID
Example : ou-fc8c29a138d78e24bf1fa86812fc8b
any of [string, null]None
queryparent_unit_name
optional
ROOT 또는 부모 조직 단위명
Example : parent-unit-name
any of [string, null]None
querytype
optional
계정 유형
Example : MEMBER
any of [enum (MANAGEMENT, DELEGATION, MEMBER, NONE, LOG_ARCHIVE, AUDIT), null]None

Responses

HTTP CodeDescriptionSchema
200OKAccountPageResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    ]
}

17.2 - 1.0

get /v1/organization-accounts

Description

get accounts list

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
queryorganization_id
optional
조직 ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
any of [string, null]None
querysize
optional
size
Example : 20
any of [integer, null]20
querypage
optional
page
Example : 0
any of [integer, null]0
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
queryid
optional
조직 계정 ID
Example : b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
any of [string, null]None
queryname
optional
계정명
Example : score-account
any of [string, null]None
queryemail
optional
계정 이메일
Example : score@samsung.com
any of [string, null]None
querylogin_id
optional
로그인 ID
Example : log-archive@samsung.com
any of [string, null]None
queryjoined_start_date
optional
가입 조회 시작 일시
Example : 2024-05-17T12:34:56.789Z
any of [string, null]None
queryjoined_end_date
optional
가입 조회 종료 일시
Example : 2024-05-17T12:34:56.789Z
any of [string, null]None
queryjoined_method
optional
가입 방법
Example : INVITED
any of [enum (INVITED, CREATED, CLOUD_CONTROL), null]None
queryexclude_policy_id
optional
제외할 정책 ID
Example : 238c2fc8c29a449dbfa8681f8f1d78e2
any of [string, null]None
queryparent_unit_id
optional
ROOT 또는 부모 조직 단위 ID
Example : ou-fc8c29a138d78e24bf1fa86812fc8b
any of [string, null]None
queryparent_unit_name
optional
ROOT 또는 부모 조직 단위명
Example : parent-unit-name
any of [string, null]None
querytype
optional
계정 유형
Example : MEMBER
any of [enum (MANAGEMENT, DELEGATION, MEMBER, NONE, LOG_ARCHIVE, AUDIT), null]None

Responses

HTTP CodeDescriptionSchema
200OKAccountPageResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    ]
}

18 - ListOrganizationInvitations

18.1 - 1.1

get /v1/organization-invitations

Description

get organization invitation list

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
queryorganization_id
optional
조직 ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
any of [string, null]None
querysize
optional
size
Example : 20
any of [integer, null]20
querypage
optional
page
Example : 0
any of [integer, null]0
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
queryaccount_id
optional
관리자 계정명
Example : 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r
any of [string, null]None
queryaccount_name
optional
관리자 계정명
Example : CoreKim
any of [string, null]None
queryaccount_email
optional
관리자 계정 이메일
Example : admin@example.com
any of [string, null]None
querystate
optional
초대 상태
Example : INVITING
any of [enum (INVITING, REFUSED, INVITED, CANCELED, EXPIRED), null]None
querylogin_id
optional
로그인 ID
Example : log-archive@samsung.com
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKOrganizationInvitationPageResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    ]
}

18.2 - 1.0

get /v1/organization-invitations

Description

get organization invitation list

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
queryorganization_id
optional
조직 ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
any of [string, null]None
querysize
optional
size
Example : 20
any of [integer, null]20
querypage
optional
page
Example : 0
any of [integer, null]0
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
queryaccount_id
optional
관리자 계정명
Example : 9f8e7d6c5b4a3z2y1x0w9v8u7t6s5r
any of [string, null]None
queryaccount_name
optional
관리자 계정명
Example : CoreKim
any of [string, null]None
queryaccount_email
optional
관리자 계정 이메일
Example : admin@example.com
any of [string, null]None
querystate
optional
초대 상태
Example : INVITING
any of [enum (INVITING, REFUSED, INVITED, CANCELED, EXPIRED), null]None
querylogin_id
optional
로그인 ID
Example : log-archive@samsung.com
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKOrganizationInvitationPageResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    ]
}

19 - ListOrganizations

19.1 - 1.1

get /v1/organizations

Description

get organizations list

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
queryorganization_id
optional
조직 ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
any of [string, null]None
querysize
optional
size
Example : 20
any of [integer, null]20
querypage
optional
page
Example : 0
any of [integer, null]0
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
queryname
optional
조직 이름
Example : My Organization
any of [string, null]None
querymaster_account_id
optional
조직 계정 ID
Example : b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKOrganizationPageResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    ]
}

19.2 - 1.0

get /v1/organizations

Description

get organizations list

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
queryorganization_id
optional
조직 ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
any of [string, null]None
querysize
optional
size
Example : 20
any of [integer, null]20
querypage
optional
page
Example : 0
any of [integer, null]0
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
queryname
optional
조직 이름
Example : My Organization
any of [string, null]None
querymaster_account_id
optional
조직 계정 ID
Example : b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKOrganizationPageResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    ]
}

20 - ListOrganizationUnits

20.1 - 1.1

get /v1/organization-units

Description

get organization unit list

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
queryorganization_id
optional
조직 ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
any of [string, null]None
queryparent_unit_id
required
ROOT 또는 부모 조직 단위 ID
Example : ou-fc8c29a138d78e24bf1fa86812fc8b
stringNone
queryname
optional
조직 단위명
Example : score-organization-unit
any of [string, null]None
queryexclude_policy_id
optional
제외할 정책 ID
Example : 238c2fc8c29a449dbfa8681f8f1d78e2
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKOrganizationUnitListResponseV1dot1
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
        }
    ]
}

20.2 - 1.0

get /v1/organization-units

Description

get organization unit list

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
queryorganization_id
optional
조직 ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
any of [string, null]None
queryparent_unit_id
required
ROOT 또는 부모 조직 단위 ID
Example : ou-fc8c29a138d78e24bf1fa86812fc8b
stringNone
queryname
optional
조직 단위명
Example : score-organization-unit
any of [string, null]None
queryexclude_policy_id
optional
제외할 정책 ID
Example : 238c2fc8c29a449dbfa8681f8f1d78e2
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKOrganizationUnitListResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
        }
    ]
}

21 - ListParents

21.1 - 1.1

get /v1/organization-units/{unit_id}/parents

Description

get organization unit parent list

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathunit_id
required
조직 단위 ID
Example : ou-c29a138f8f1d78e24dbfa8681fc2fc8
stringNone
queryorganization_id
optional
조직 ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKOrganizationUnitParentsResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
        }
    ]
}

21.2 - 1.0

get /v1/organization-units/{unit_id}/parents

Description

get organization unit parent list

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathunit_id
required
조직 단위 ID
Example : ou-c29a138f8f1d78e24dbfa8681fc2fc8
stringNone
queryorganization_id
optional
조직 ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKOrganizationUnitParentsResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
        }
    ]
}

22 - ListPoliciesForTarget

22.1 - 1.1

get /v1/assignments/policies

Description

list policies for target

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
queryorganization_id
optional
조직 ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
any of [string, null]None
querysize
optional
size
Example : 20
any of [integer, null]20
querypage
optional
page
Example : 0
any of [integer, null]0
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
querytarget_id
required
타겟 ID
Example : ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5
stringNone
querypolicy_category
optional
정책 카테고리
Example : SCP
any of [enum (SCP, RCP, TAG, DGP), null]SCP
queryname
optional
제어 정책 이름
Example : test-policy-name
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKListPoliciesForTargetResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    ]
}

22.2 - 1.0

get /v1/assignments/policies

Description

list policies for target

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
queryorganization_id
optional
조직 ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
any of [string, null]None
querysize
optional
size
Example : 20
any of [integer, null]20
querypage
optional
page
Example : 0
any of [integer, null]0
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
querytarget_id
required
타겟 ID
Example : ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5
stringNone
querypolicy_category
optional
정책 카테고리
Example : SCP
any of [enum (SCP, RCP, TAG, DGP), null]SCP
queryname
optional
제어 정책 이름
Example : test-policy-name
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKListPoliciesForTargetResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    ]
}

23 - ListServiceControlPolicies

23.1 - 1.1

get /v1/service-control-policies

Description

get service control policies list

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional
size
Example : 20
any of [integer, null]20
querypage
optional
page
Example : 0
any of [integer, null]0
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
queryorganization_id
required
조직 ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
stringNone
queryid
optional
서비스 제어 정책 ID
Example : 138c2fc8c29a449dbfa8681f8f1d78e2
any of [string, null]None
queryname
optional
서비스 제어 정책 이름
Example : MyPolicy
any of [array[string], string, null]None
querytype
optional
서비스 제어 정책 유형
Example : MANAGED
any of [enum (SYSTEM_MANAGED, USER_DEFINED), null]None
queryexclude_target_id
optional
제외 대상 ID
Example : 112c2fc8c29a449dbfa8681f8f1d7442
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKServiceControlPolicyPageResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    ]
}

23.2 - 1.0

get /v1/service-control-policies

Description

get service control policies list

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional
size
Example : 20
any of [integer, null]20
querypage
optional
page
Example : 0
any of [integer, null]0
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
queryorganization_id
required
조직 ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
stringNone
queryid
optional
서비스 제어 정책 ID
Example : 138c2fc8c29a449dbfa8681f8f1d78e2
any of [string, null]None
queryname
optional
서비스 제어 정책 이름
Example : MyPolicy
any of [array[string], string, null]None
querytype
optional
서비스 제어 정책 유형
Example : MANAGED
any of [enum (SYSTEM_MANAGED, USER_DEFINED), null]None
queryexclude_target_id
optional
제외 대상 ID
Example : 112c2fc8c29a449dbfa8681f8f1d7442
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKServiceControlPolicyPageResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    ]
}

24 - ListTargetsForPolicy

24.1 - 1.1

get /v1/assignments/targets

Description

list targets for policy

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
queryorganization_id
optional
조직 ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
any of [string, null]None
querysize
optional
size
Example : 20
any of [integer, null]20
querypage
optional
page
Example : 0
any of [integer, null]0
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
querypolicy_id
required
제어 정책 ID
Example : f98e76d54c32b10a9z8y7x6w5v4u3
stringNone
querypolicy_category
optional
정책 카테고리
Example : SCP
any of [enum (SCP, RCP, TAG, DGP), null]SCP
querytarget_type
required
타겟 유형
Example : OU
enum (ROOT, ACCOUNT, OU)None
queryname
optional
타겟명
Example : example-target
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKListTargetsForPolicyResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
        }
    ]
}

24.2 - 1.0

get /v1/assignments/targets

Description

list targets for policy

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
queryorganization_id
optional
조직 ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
any of [string, null]None
querysize
optional
size
Example : 20
any of [integer, null]20
querypage
optional
page
Example : 0
any of [integer, null]0
querysort
optional
sort
Example : created_at:desc
any of [string, null]None
querypolicy_id
required
제어 정책 ID
Example : f98e76d54c32b10a9z8y7x6w5v4u3
stringNone
querypolicy_category
optional
정책 카테고리
Example : SCP
any of [enum (SCP, RCP, TAG, DGP), null]SCP
querytarget_type
required
타겟 유형
Example : OU
enum (ROOT, ACCOUNT, OU)None
queryname
optional
타겟명
Example : example-target
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKListTargetsForPolicyResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
        }
    ]
}

25 - MoveAccount

25.1 - 1.1

put /v1/organization-accounts/parent

Description

move a specific account to a different OU

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

MoveAccountRequest

Responses

HTTP CodeDescriptionSchema
200OKAccountMoveResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
        }
    ]
}

25.2 - 1.0

put /v1/organization-accounts/parent

Description

move a specific account to a different OU

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

MoveAccountRequest

Responses

HTTP CodeDescriptionSchema
200OKAccountMoveResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
        }
    ]
}

26 - RemoveAccounts

26.1 - 1.1

delete /v1/organization-accounts

Description

Remove accounts from organization

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

RemoveAccountsRequest

Responses

HTTP CodeDescriptionSchema
200OKAccountRemoveResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
        }
    ]
}

26.2 - 1.0

delete /v1/organization-accounts

Description

Remove accounts from organization

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

RemoveAccountsRequest

Responses

HTTP CodeDescriptionSchema
200OKAccountRemoveResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
        }
    ]
}

27 - RemovePolicyBindings

27.1 - 1.1

delete /v1/assignments/policy-bindings

Description

remove policy bindings

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

PolicyRemoveRequest

Responses

HTTP CodeDescriptionSchema
200OKControlPolicyAssignmentResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    ]
}

27.2 - 1.0

delete /v1/assignments/policy-bindings

Description

remove policy bindings

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

PolicyRemoveRequest

Responses

HTTP CodeDescriptionSchema
200OKControlPolicyAssignmentResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    ]
}

28 - SetDelegationPolicy

28.1 - 1.1

put /v1/delegation-policies

Description

set a specific delegation policy

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

DelegationPolicySetRequest

Responses

HTTP CodeDescriptionSchema
200OKDelegationPolicyShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    }
}

28.2 - 1.0

put /v1/delegation-policies

Description

set a specific delegation policy

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

DelegationPolicySetRequest

Responses

HTTP CodeDescriptionSchema
200OKDelegationPolicyShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    }
}

29 - SetOrganization

29.1 - 1.1

put /v1/organizations/{organization_id}

Description

set a specific organization

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathorganization_id
required
조직 ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
stringNone
bodybody
required

OrganizationSetRequest

Responses

HTTP CodeDescriptionSchema
200OKOrganizationShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

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 = en-US",
"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
    }
}

29.2 - 1.0

put /v1/organizations/{organization_id}

Description

set a specific organization

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathorganization_id
required
조직 ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
stringNone
bodybody
required

OrganizationSetRequest

Responses

HTTP CodeDescriptionSchema
200OKOrganizationShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone
409ConflictNone

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 = en-US",
"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
    }
}

30 - SetOrganizationUnit

30.1 - 1.1

put /v1/organization-units/{unit_id}

Description

set a specific organization unit

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathunit_id
required
조직 단위 ID
Example : ou-c29a138f8f1d78e24dbfa8681fc2fc8
stringNone
bodybody
required

OrganizationUnitSetRequest

Responses

HTTP CodeDescriptionSchema
200OKOrganizationUnitShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    }
}

30.2 - 1.0

put /v1/organization-units/{unit_id}

Description

set a specific organization unit

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathunit_id
required
조직 단위 ID
Example : ou-c29a138f8f1d78e24dbfa8681fc2fc8
stringNone
bodybody
required

OrganizationUnitSetRequest

Responses

HTTP CodeDescriptionSchema
200OKOrganizationUnitShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    }
}

31 - SetServiceControlPolicy

31.1 - 1.1

put /v1/service-control-policies/{policy_id}

Description

set a specific service control policy

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathpolicy_id
required
서비스 제어 정책 ID
Example : 138c2fc8c29a449dbfa8681f8f1d78e2
stringNone
bodybody
required

ServiceControlPolicySetRequest

Responses

HTTP CodeDescriptionSchema
200OKServiceControlPolicyShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    }
}

31.2 - 1.0

put /v1/service-control-policies/{policy_id}

Description

set a specific service control policy

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathpolicy_id
required
서비스 제어 정책 ID
Example : 138c2fc8c29a449dbfa8681f8f1d78e2
stringNone
bodybody
required

ServiceControlPolicySetRequest

Responses

HTTP CodeDescriptionSchema
200OKServiceControlPolicyShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    }
}

32 - ShowAccount

32.1 - 1.1

get /v1/organization-accounts/{account_id}

Description

show a specific account

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathaccount_id
required
조직 계정 ID
Example : b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
stringNone
queryorganization_id
optional
조직 ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
any of [string, null]None
querylazy_policy
optional
연결된 정책 조회 여부
Example : True
any of [boolean, null]True

Responses

HTTP CodeDescriptionSchema
200OKAccountShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    }
}

32.2 - 1.0

get /v1/organization-accounts/{account_id}

Description

show a specific account

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathaccount_id
required
조직 계정 ID
Example : b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0
stringNone
queryorganization_id
optional
조직 ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
any of [string, null]None
querylazy_policy
optional
연결된 정책 조회 여부
Example : True
any of [boolean, null]True

Responses

HTTP CodeDescriptionSchema
200OKAccountShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    }
}

33 - ShowDelegationPolicy

33.1 - 1.1

get /v1/delegation-policies

Description

show a specific delegation policy

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
queryorganization_id
optional
조직 ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKDelegationPolicyShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    }
}

33.2 - 1.0

get /v1/delegation-policies

Description

show a specific delegation policy

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
queryorganization_id
optional
조직 ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKDelegationPolicyShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    }
}

34 - ShowOrganization

34.1 - 1.1

get /v1/organizations/{organization_id}

Description

show a specific organization

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathorganization_id
required
조직 ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
stringNone

Responses

HTTP CodeDescriptionSchema
200OKOrganizationShowResponse
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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
    }
}

34.2 - 1.0

get /v1/organizations/{organization_id}

Description

show a specific organization

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathorganization_id
required
조직 ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
stringNone

Responses

HTTP CodeDescriptionSchema
200OKOrganizationShowResponse
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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
    }
}

35 - ShowOrganizationUnit

35.1 - 1.1

get /v1/organization-units/{unit_id}

Description

show a specific organization unit

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathunit_id
required
조직 단위 ID
Example : ou-c29a138f8f1d78e24dbfa8681fc2fc8
stringNone
queryorganization_id
optional
조직 ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKOrganizationUnitShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    }
}

35.2 - 1.0

get /v1/organization-units/{unit_id}

Description

show a specific organization unit

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathunit_id
required
조직 단위 ID
Example : ou-c29a138f8f1d78e24dbfa8681fc2fc8
stringNone
queryorganization_id
optional
조직 ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKOrganizationUnitShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    }
}

36 - ShowServiceControlPolicy

36.1 - 1.1

get /v1/service-control-policies/{policy_id}

Description

show a specific service control policy

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathpolicy_id
required
서비스 제어 정책 ID
Example : 138c2fc8c29a449dbfa8681f8f1d78e2
stringNone
queryorganization_id
optional
조직 ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKServiceControlPolicyShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    }
}

36.2 - 1.0

get /v1/service-control-policies/{policy_id}

Description

show a specific service control policy

State ACTIVE (DEPRECATED)

VersionSupported Until
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathpolicy_id
required
서비스 제어 정책 ID
Example : 138c2fc8c29a449dbfa8681f8f1d78e2
stringNone
queryorganization_id
optional
조직 ID
Example : o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKServiceControlPolicyShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

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 = en-US",
"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"
    }
}