GetIdpGroupMapping
get
/20160918/identityProviders/{identity_provider_id}/groupMappings/{mapping_id}
Deprecated. Get the specified group mapping.
Request
Supported Media Types
- application/json
Path Parameters
-
identityProviderId(required): string
The OCID of the identity provider.
-
mappingId(required): string
The OCID of the group mapping.
Response
Supported Media Types
- application/json
200 Response
The mapping is being retrieved.
Headers
-
etag: string
For optimistic concurrency control. See if-match.
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : IdpGroupMapping
Type:
object
A mapping between a single group defined by the identity provider (IdP) you're federating with and a single IAM Service group. A given IdP group can be mapped to zero, one, or multiple IAM Service groups, and vice versa. But each IdPGroupMapping object is between only a single IdP group and IAM Service group. Each IdPGroupMapping object has its own OCID.
Show Source
Note: Any users who are in more than 50 IdP groups cannot be authenticated to use the Compute Web UI.
-
compartmentId(required):
string
The OCID of the tenancy containing the IdentityProvider.
-
groupId(required):
string
The OCID of the IAM Service group that is mapped to the IdP group.
-
id(required):
string
The OCID of the IdpGroupMapping.
-
idpGroupName(required):
string
The name of the IdP group that is mapped to the IAM Service group.
-
idpId(required):
string
The OCID of the IdentityProvider this mapping belongs to.
-
inactiveStatus:
integer(int64)
The detailed status of INACTIVE lifecycleState.
-
lifecycleState(required):
string
Minimum Length:
1
Maximum Length:64
Allowed Values:[ "CREATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED" ]
The mapping's current state. After creating a mapping object, make sure its lifecycleState changes from CREATING to ACTIVE before using it. -
timeCreated(required):
string(date-time)
Date and time the mapping was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
400 Response
Bad Request
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
403 Response
Forbidden
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
404 Response
Not Found
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
500 Response
Internal Server Error
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
Default Response
An error has occurred.
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload