Jump to

• Request
• Response

Get the IdentityProvider object by its id.

get

https://{host}:{port}/{basePath}/IdentityProvider/{identityProviderId}

get the IdentityProvider object by its id.

Request

Path Parameters

• IdentityProviderId(required):
  IdentityProviderId to retrieve the associated IdentityProvider.

Header Parameters

• Auth-Token(required): string
  Auth-Token received from a successful login response.
• opc-request-id: string
  Unique identifier for the request

There's no request body for this operation.

Security

• basicAuth: http
  Type: http

Back to Top

Response

Supported Media Types

• application/json

200 Response

Request completed successfully.

Body ()

Root Schema : IdentityProvider

Type: object

Show Source

• authnContexts(required): string
  Maximum Length: 512
• description(required): string
  Maximum Length: 1000
• encryptAssertion(required): boolean
• faultIds: array faultIds
• forceAuthentication(required): boolean
• generation: integer
• idpGroupMappingIds: array idpGroupMappingIds
• metadata: string
  Maximum Length: 5000
• metadataUrl(required): string
  Maximum Length: 512
• name(required): string
  Maximum Length: 256
• redirectUrl: string
  Maximum Length: 2000
• signingCertificate: string
  Maximum Length: 3000
• statusMessage: string
  Maximum Length: 512
• useProxy(required): boolean
• workState: string

{
    "properties":{
        "metadata":{
            "description":"",
            "maxLength":5000,
            "type":"string"
        },
        "metadataUrl":{
            "description":"",
            "maxLength":512,
            "type":"string"
        },
        "encryptAssertion":{
            "description":"",
            "type":"boolean"
        },
        "forceAuthentication":{
            "description":"",
            "type":"boolean"
        },
        "signingCertificate":{
            "description":"",
            "maxLength":3000,
            "type":"string"
        },
        "redirectUrl":{
            "description":"",
            "maxLength":2000,
            "type":"string"
        },
        "statusMessage":{
            "description":"",
            "maxLength":512,
            "type":"string"
        },
        "authnContexts":{
            "description":"",
            "maxLength":512,
            "type":"string"
        },
        "useProxy":{
            "description":"",
            "type":"boolean"
        },
        "idpGroupMappingIds":{
            "description":"",
            "type":"array"
        },
        "description":{
            "description":"",
            "maxLength":1000,
            "type":"string"
        },
        "generation":{
            "description":"",
            "type":"integer"
        },
        "name":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "workState":{
            "description":"",
            "type":"string"
        },
        "faultIds":{
            "description":"",
            "type":"array"
        }
    },
    "required":[
        "metadataUrl",
        "encryptAssertion",
        "forceAuthentication",
        "authnContexts",
        "useProxy",
        "description",
        "name"
    ],
    "type":"object",
    "description":""
}

Nested Schema : faultIds

Type: array

Nested Schema : idpGroupMappingIds

Type: array

400 Response

Bad request

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

401 Response

Unauthorized

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

404 Response

Not Found

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

500 Response

Internal Server Error

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Default Response

An error has occurred

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Back to Top