Saml-Identity-Provider-Config - Flexible Secure Gateway API References (1.10.0)

Download OpenAPI specification:Download

Saml-Identity-Provider-Config Settings.

Authentication

X-Auth-Token

Security Scheme Type	API Key
Header parameter name:	{keystone_token}

saml-identity-provider-config

Get Saml-Identity-Provider-Configs

Get Saml-Identity-Provider-Config resources.

Authorizations:

X-Auth-Token

query Parameters

id	string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The ID of Saml-Identity-Provider-Config.
cellGroupId	string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The Cell-Group ID which the resource belongs.
_limit	integer >= 1 The maximum number of items to return.
_offset	integer >= 0 The number of items to skip before starting to return results.
_order_by	Array of strings Items Enum: "id" "name" "metadata" "metadataEncoding" "cellGroupId" "tenantId" "createdAt" "updatedAt" Sort keys.

header Parameters

X-Auth-Token

required

string

The keystone token.

Responses

200

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/v1/saml-identity-provider-configs

https://api.ntt.com/dsigw-erg/v1/saml-identity-provider-configs

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"samlIdentityProviderConfigs": 
[
{"id": "2944a32f-3fb7-430e-9134-5eb611be23f6",
"cellGroupId": "047ae2a5-c763-4bea-9171-e178d08951ca",
"name": "idp_config_example",
"metadata": "<encoded_metadata>",
"metadataEncoding": "base64",
"tenantId": "12345678abcdabcdabcd1234567890ab",
"createdAt": "2020-08-27T10:04:04Z",
"updatedAt": "2020-08-27T10:04:04Z"
}
]
}

Create Saml-Identity-Provider-Config

Create a Saml-Identity-Provider-Config resource.

Authorizations:

X-Auth-Token

header Parameters

X-Auth-Token

string

The keystone token.

Request Body schema: application/json

samlIdentityProviderConfig

required

object (SamlIdentityProviderConfigCreateRequest)

Saml-Identity-Provider-Config create request schema.

Responses

200

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/v1/saml-identity-provider-configs

https://api.ntt.com/dsigw-erg/v1/saml-identity-provider-configs

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"samlIdentityProviderConfig": 
{"cellGroupId": "047ae2a5-c763-4bea-9171-e178d08951ca",
"name": "idp_config_example",
"metadata": "<encoded_metadata>"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"samlIdentityProviderConfig": 
{"id": "2944a32f-3fb7-430e-9134-5eb611be23f6",
"cellGroupId": "047ae2a5-c763-4bea-9171-e178d08951ca",
"name": "idp_config_example",
"metadata": "<encoded_metadata>",
"metadataEncoding": "base64",
"operationId": "047ae2a5-c763-4bea-9171-e178d08951ca",
"tenantId": "12345678abcdabcdabcd1234567890ab",
"createdAt": "2020-08-27T10:04:04Z",
"updatedAt": "2020-08-27T10:04:04Z"
}
}

Get Saml-Identity-Provider-Config Details

Get a Saml-Identity-Provider-Config resource.

Authorizations:

X-Auth-Token

path Parameters

saml_identity_provider_config_id

required

string

The ID of the Saml-Identity-Provider-Config.

header Parameters

X-Auth-Token

string

The keystone token.

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

get/v1/saml-identity-provider-configs/{saml_identity_provider_config_id}

https://api.ntt.com/dsigw-erg/v1/saml-identity-provider-configs/{saml_identity_provider_config_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"samlIdentityProviderConfig": 
{"id": "2944a32f-3fb7-430e-9134-5eb611be23f6",
"cellGroupId": "047ae2a5-c763-4bea-9171-e178d08951ca",
"name": "idp_config_example",
"metadata": "<encoded_metadata>",
"metadataEncoding": "base64",
"tenantId": "12345678abcdabcdabcd1234567890ab",
"createdAt": "2020-08-27T10:04:04Z",
"updatedAt": "2020-08-27T10:04:04Z"
}
}

Update Saml-Identity-Provider-Config

Update a Saml-Identity-Provider-Config resource.

Authorizations:

X-Auth-Token

path Parameters

saml_identity_provider_config_id

required

string

The ID of the Saml-Identity-Provider-Config.

header Parameters

X-Auth-Token

string

The keystone token.

Request Body schema: application/json

samlIdentityProviderConfig

required

object (SamlIdentityProviderConfigUpdateRequest)

Saml-Identity-Provider-Config update request schema.

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

patch/v1/saml-identity-provider-configs/{saml_identity_provider_config_id}

https://api.ntt.com/dsigw-erg/v1/saml-identity-provider-configs/{saml_identity_provider_config_id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"samlIdentityProviderConfig": 
{"name": "modifiedName"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"samlIdentityProviderConfig": 
{"id": "2944a32f-3fb7-430e-9134-5eb611be23f6",
"cellGroupId": "047ae2a5-c763-4bea-9171-e178d08951ca",
"name": "idp_config_example",
"metadata": "<encoded_metadata>",
"metadataEncoding": "base64",
"operationId": "047ae2a5-c763-4bea-9171-e178d08951ca",
"tenantId": "12345678abcdabcdabcd1234567890ab",
"createdAt": "2020-08-27T10:04:04Z",
"updatedAt": "2020-08-27T10:04:04Z"
}
}

Delete Saml-Identity-Provider-Config

Delete a Saml-Identity-Provider-Config resource.

Authorizations:

X-Auth-Token

path Parameters

saml_identity_provider_config_id

required

string

The ID of the Saml-Identity-Provider-Config.

header Parameters

X-Auth-Token

string

The keystone token.

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/v1/saml-identity-provider-configs/{saml_identity_provider_config_id}

https://api.ntt.com/dsigw-erg/v1/saml-identity-provider-configs/{saml_identity_provider_config_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"errorCode": 400,
"errorMessage": "Invalid request",
"moreInfo": "{{moreInfo}}"
}