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

Return to the regular view of this page.

CreateAccountAssignment

1 - 1.4

post /v1/account-assignments

Description

set a specific account Assignment

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

AccountAssignmentsCreateRequestV1Dot2

Responses

HTTP CodeDescriptionSchema
201CreatedAccountAssignmentsCreateResponseV1Dot2
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/account-assignments

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = iam-identity-center 1.4"

Request body

{
    "accounts": [
        {
            "target_account_email": "target_account@example.com",
            "target_account_id": "3265ab469f0d406d83073da3e11e7a6c",
            "target_account_name": "target_account@example.com"
        }
    ],
    "instance_id": "ssoins-12345",
    "permission_sets": [
        {
            "custom_policies": [],
            "inline_policies": [],
            "managed_policies": [],
            "permission_set_id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
            "permission_set_name": "Permission Set",
            "permission_set_srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
            "session_duration": 3600
        }
    ],
    "principals": [
        {
            "principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "principal_type": "USER"
        }
    ]
}

Example HTTP response

Response 201

{
    "account_assignments": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "permission_set_id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
            "principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "principal_type": "USER",
            "target_account_id": "3265ab469f0d406d83073da3e11e7a6c"
        }
    ],
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

2 - 1.3

post /v1/account-assignments

Description

set a specific account Assignment

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261130

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

AccountAssignmentsCreateRequestV1Dot2

Responses

HTTP CodeDescriptionSchema
201CreatedAccountAssignmentsCreateResponseV1Dot2
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/account-assignments

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = iam-identity-center 1.3"

Request body

{
    "accounts": [
        {
            "target_account_email": "target_account@example.com",
            "target_account_id": "3265ab469f0d406d83073da3e11e7a6c",
            "target_account_name": "target_account@example.com"
        }
    ],
    "instance_id": "ssoins-12345",
    "permission_sets": [
        {
            "custom_policies": [],
            "inline_policies": [],
            "managed_policies": [],
            "permission_set_id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
            "permission_set_name": "Permission Set",
            "permission_set_srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
            "session_duration": 3600
        }
    ],
    "principals": [
        {
            "principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "principal_type": "USER"
        }
    ]
}

Example HTTP response

Response 201

{
    "account_assignments": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "permission_set_id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
            "principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "principal_type": "USER",
            "target_account_id": "3265ab469f0d406d83073da3e11e7a6c"
        }
    ],
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

3 - 1.2

post /v1/account-assignments

Description

set a specific account Assignment

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

AccountAssignmentsCreateRequestV1Dot2

Responses

HTTP CodeDescriptionSchema
201CreatedAccountAssignmentsCreateResponseV1Dot2
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/account-assignments

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = iam-identity-center 1.2"

Request body

{
    "accounts": [
        {
            "target_account_email": "target_account@example.com",
            "target_account_id": "3265ab469f0d406d83073da3e11e7a6c",
            "target_account_name": "target_account@example.com"
        }
    ],
    "instance_id": "ssoins-12345",
    "permission_sets": [
        {
            "custom_policies": [],
            "inline_policies": [],
            "managed_policies": [],
            "permission_set_id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
            "permission_set_name": "Permission Set",
            "permission_set_srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
            "session_duration": 3600
        }
    ],
    "principals": [
        {
            "principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "principal_type": "USER"
        }
    ]
}

Example HTTP response

Response 201

{
    "account_assignments": [
        {
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "permission_set_id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
            "principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "principal_type": "USER",
            "target_account_id": "3265ab469f0d406d83073da3e11e7a6c"
        }
    ],
    "count": 20,
    "links": [
        {
            "href": "http://scp.samsungsdscloud.com/v1/notices",
            "rel": "self"
        }
    ]
}

4 - 1.1

post /v1/account-assignments

Description

set a specific account Assignment

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.120260531

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

AccountAssignmentsCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedAccountAssignmentsCreateResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/account-assignments

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = iam-identity-center 1.1"

Request body

{
    "accounts": [
        {
            "target_account_email": "target_account@example.com",
            "target_account_id": "3265ab469f0d406d83073da3e11e7a6c",
            "target_account_name": "target_account@example.com"
        }
    ],
    "instance_id": "ssoins-12345",
    "permission_sets": [
        {
            "customer_policies": [],
            "inline_policies": [],
            "managed_policies": [],
            "permission_set_id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
            "permission_set_name": "Permission Set",
            "permission_set_srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
            "session_duration": 3600
        }
    ],
    "principals": [
        {
            "principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "principal_type": "USER"
        }
    ]
}

Example HTTP response

Response 201

{
    "account_assignment_id": "b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8",
    "permission_set_id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
    "principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
    "principal_type": "USER",
    "role_srn": "Permissions for administrators",
    "target_account_id": "3265ab469f0d406d83073da3e11e7a6c"
}

5 - 1.0

post /v1/account-assignments

Description

set a specific account Assignment

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260223

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required

AccountAssignmentsCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedAccountAssignmentsCreateResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/account-assignments

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = iam-identity-center 1.0"

Request body

{
    "accounts": [
        {
            "target_account_email": "target_account@example.com",
            "target_account_id": "3265ab469f0d406d83073da3e11e7a6c",
            "target_account_name": "target_account@example.com"
        }
    ],
    "instance_id": "ssoins-12345",
    "permission_sets": [
        {
            "customer_policies": [],
            "inline_policies": [],
            "managed_policies": [],
            "permission_set_id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
            "permission_set_name": "Permission Set",
            "permission_set_srn": "srn:<offering>::<project-id>:<region>::permissionSet/${InstanceId}/${permissionId}",
            "session_duration": 3600
        }
    ],
    "principals": [
        {
            "principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
            "principal_type": "USER"
        }
    ]
}

Example HTTP response

Response 201

{
    "account_assignment_id": "b2f9a7d3c1e5b8f4d0a6c9e2f7b3d1a8",
    "permission_set_id": "e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1",
    "principal_id": "138c2fc8c29a449dbfa8681f8f1d78e2",
    "principal_type": "USER",
    "role_srn": "Permissions for administrators",
    "target_account_id": "3265ab469f0d406d83073da3e11e7a6c"
}