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

Return to the regular view of this page.

ListPermissionSetPolicies

1 - 1.4

get /v1/permission-sets/{permission_set_id}/policies

Description

get policies to a specific permission set

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

TypeNameDescriptionSchemaDefault
pathpermission_set_id
required
Permission Set ID
Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
stringNone
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
queryinstance_id
required
Instance ID
Example : ssoins-12345
stringNone
querycategory
optional
Policy Type
Example : INLINE_POLICY
any of [enum (MANAGED_POLICY, CUSTOM_POLICY, INLINE_POLICY), null]None
queryname
optional
None
Example : Permission Set
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKPermissionSetPoliciesPageResponseV1Dot2
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/permission-sets/{permission_set_id}/policies?instance_id={instance_id}

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "policies": [],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

2 - 1.3

get /v1/permission-sets/{permission_set_id}/policies

Description

get policies to a specific permission set

State ACTIVE (SUPPORTED)

VersionNot Before
1.320261130

Parameters

TypeNameDescriptionSchemaDefault
pathpermission_set_id
required
Permission Set ID
Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
stringNone
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
queryinstance_id
required
Instance ID
Example : ssoins-12345
stringNone
querycategory
optional
Policy Type
Example : INLINE_POLICY
any of [enum (MANAGED_POLICY, CUSTOM_POLICY, INLINE_POLICY), null]None
queryname
optional
None
Example : Permission Set
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKPermissionSetPoliciesPageResponseV1Dot2
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/permission-sets/{permission_set_id}/policies?instance_id={instance_id}

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "policies": [],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

3 - 1.2

get /v1/permission-sets/{permission_set_id}/policies

Description

get policies to a specific permission set

State ACTIVE (SUPPORTED)

VersionNot Before
1.220260930

Parameters

TypeNameDescriptionSchemaDefault
pathpermission_set_id
required
Permission Set ID
Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
stringNone
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
queryinstance_id
required
Instance ID
Example : ssoins-12345
stringNone
querycategory
optional
Policy Type
Example : INLINE_POLICY
any of [enum (MANAGED_POLICY, CUSTOM_POLICY, INLINE_POLICY), null]None
queryname
optional
None
Example : Permission Set
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKPermissionSetPoliciesPageResponseV1Dot2
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/permission-sets/{permission_set_id}/policies?instance_id={instance_id}

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "policies": [],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

4 - 1.1

get /v1/permission-sets/{permission_set_id}/policies

Description

get policies to a specific permission set

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
pathpermission_set_id
required
Permission Set ID
Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
stringNone
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
queryinstance_id
required
Instance ID
Example : ssoins-12345
stringNone
querycategory
optional
Policy Type
Example : INLINE_POLICY
any of [enum (MANAGED_POLICY, CUSTOMER_POLICY, INLINE_POLICY), null]None
queryname
optional
None
Example : Permission Set
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKPermissionSetPoliciesPageResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/permission-sets/{permission_set_id}/policies?instance_id={instance_id}

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "policies": [],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

5 - 1.0

get /v1/permission-sets/{permission_set_id}/policies

Description

get policies to a specific permission set

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
pathpermission_set_id
required
Permission Set ID
Example : e8d4b9f2c1a7e5d3f0b6c9a2d8e4f7b1
stringNone
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
queryinstance_id
required
Instance ID
Example : ssoins-12345
stringNone
querycategory
optional
Policy Type
Example : INLINE_POLICY
any of [enum (MANAGED_POLICY, CUSTOMER_POLICY, INLINE_POLICY), null]None
queryname
optional
None
Example : Permission Set
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKPermissionSetPoliciesPageResponse
400Bad RequestNone
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/permission-sets/{permission_set_id}/policies?instance_id={instance_id}

Request header

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

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "policies": [],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}