DeregisterIdentityProvider
Deregisters the Active Directory identity provider from License Manager user-based subscriptions.
Request Syntax
POST /identity-provider/DeregisterIdentityProvider HTTP/1.1
Content-type: application/json
{
"IdentityProvider": { ... },
"IdentityProviderArn": "string
",
"Product": "string
"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- IdentityProvider
-
An object that specifies details for the Active Directory identity provider.
Type: IdentityProvider object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
- IdentityProviderArn
-
The Amazon Resource Name (ARN) that identifies the identity provider to deregister.
Type: String
Pattern:
^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{1,63}:[a-zA-Z0-9-\.]{1,510}/[a-zA-Z0-9-\.]{1,510}$
Required: No
- Product
-
The name of the user-based subscription product.
Valid values:
VISUAL_STUDIO_ENTERPRISE
|VISUAL_STUDIO_PROFESSIONAL
|OFFICE_PROFESSIONAL_PLUS
Type: String
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"IdentityProviderSummary": {
"FailureMessage": "string",
"IdentityProvider": { ... },
"IdentityProviderArn": "string",
"Product": "string",
"Settings": {
"SecurityGroupId": "string",
"Subnets": [ "string" ]
},
"Status": "string"
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- IdentityProviderSummary
-
Metadata that describes the results of an identity provider operation.
Type: IdentityProviderSummary object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have sufficient access to perform this action.
HTTP Status Code: 400
- ConflictException
-
The request couldn't be completed because it conflicted with the current state of the resource.
HTTP Status Code: 500
- InternalServerException
-
An exception occurred with the service.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource couldn't be found.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
The request failed because a service quota is exceeded.
HTTP Status Code: 400
- ThrottlingException
-
The request was denied because of request throttling. Retry the request.
HTTP Status Code: 400
- ValidationException
-
A parameter is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: