REST API for Oracle B2C Service

Get an SSO token reference

get

/services/rest/connect/v1.4/sSOTokenReferences/{id}

Request

Path Parameters

id: integer

The unique identifier of the Single Sign On (SSO) token.

Response

Default Response

Root Schema : sSOTokenReferences

Type: object

The Single Sign On (SSO) token used for authentication.

Show Source

account(optional): object account

The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.
attributes(optional): object sSOTokenReferences-attributes

The information about the Single Sign On (SSO) token attributes.
comment(optional): [ "string", "null" ]

Maximum Length: 1333

The comment provided on Single Sign On (SSO) token revocation.
createdTime(optional): string

The date and time when the Single Sign On (SSO) token was created. This attribute is read-only.
expiresTime(optional): string

The date and time when the Single Sign On (SSO) token expires.
id(optional): integer

Minimum Value: 1

Maximum Value: 9.223372036854776E18

The unique identifier of the Single Sign On (SSO) token.
issuedTime(optional): [ "string", "null" ]

The date and time when the Single Sign On (SSO) token was issued.
lookupName(optional): string

Maximum Length: 255

The name used to look up the Single Sign On (SSO) token.
sSOProvider(optional): object sSOTokenReferences-sSOProvider

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
sSOTokenType(optional): object namedIDs-sSOTokenReferences-sSOTokenType

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
updatedTime(optional): string

The date and time when the Single Sign On (SSO) token was last updated. This attribute is read-only.

{
    "type":"object",
    "description":"The Single Sign On (SSO) token used for authentication.",
    "properties":{
        "comment":{
            "type":[
                "string",
                "null"
            ],
            "description":"The comment provided on Single Sign On (SSO) token revocation.",
            "maxLength":1333
        },
        "updatedTime":{
            "type":"string",
            "description":"The date and time when the Single Sign On (SSO) token was last updated. This attribute is read-only."
        },
        "account":{
            "type":"object",
            "description":"The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "sSOTokenType":{
            "type":"object",
            "description":"The Single Sign On (SSO) token type.",
            "$ref":"#/definitions/namedIDs-sSOTokenReferences-sSOTokenType"
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the Single Sign On (SSO) token.",
            "maxLength":255
        },
        "issuedTime":{
            "type":[
                "string",
                "null"
            ],
            "description":"The date and time when the Single Sign On (SSO) token was issued."
        },
        "sSOProvider":{
            "type":"object",
            "description":"The ID of the identity provider which issued the Single Sign On (SSO) token.",
            "$ref":"#/definitions/sSOTokenReferences-sSOProvider"
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the Single Sign On (SSO) token was created. This attribute is read-only."
        },
        "attributes":{
            "type":"object",
            "description":"The Single Sign On (SSO) token attributes.",
            "$ref":"#/definitions/sSOTokenReferences-attributes"
        },
        "expiresTime":{
            "type":"string",
            "description":"The date and time when the Single Sign On (SSO) token expires."
        },
        "id":{
            "minimum":1,
            "type":"integer",
            "description":"The unique identifier of the Single Sign On (SSO) token.",
            "maximum":9.223372036854776E18
        }
    }
}

Nested Schema : account

Type: object

The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.

Nested Schema : sSOTokenReferences-attributes

Type: object

The information about the Single Sign On (SSO) token attributes.

Show Source

revoked(optional): [ "boolean", "null" ]

Indicates whether the Single Sign On (SSO) token is revoked. This attribute does not have a default value.
singleUse(optional): boolean

Indicates whether the Single Sign On (SSO) token is intended for single use. This attribute does not have a default value.
used(optional): [ "boolean", "null" ]

Indicates whether the Single Sign On (SSO) token has been used. This attribute does not have a default value.

{
    "type":"object",
    "description":"The information about the Single Sign On (SSO) token attributes.",
    "properties":{
        "used":{
            "type":[
                "boolean",
                "null"
            ],
            "description":"Indicates whether the Single Sign On (SSO) token has been used. This attribute does not have a default value."
        },
        "singleUse":{
            "type":"boolean",
            "description":"Indicates whether the Single Sign On (SSO) token is intended for single use. This attribute does not have a default value."
        },
        "revoked":{
            "type":[
                "boolean",
                "null"
            ],
            "description":"Indicates whether the Single Sign On (SSO) token is revoked. This attribute does not have a default value."
        }
    }
}

Nested Schema : sSOTokenReferences-sSOProvider

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

id(optional): integer

Minimum Value: 0

ID value
lookupName(optional): string

Maximum Length: 255

Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":0,
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":255
        }
    }
}

Nested Schema : namedIDs-sSOTokenReferences-sSOTokenType

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

id(optional): integer

Minimum Value: 0

ID value
lookupName(optional): string

Maximum Length: 255

Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":0,
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":255
        }
    }
}

Examples

Use GET with the following syntax to retrieve data for a specific SSO token reference:

https://your_site_interface/services/rest/connect/version/sSOTokenReferences/SSO_token_reference_id

Note:

TokenHash attribute is not supported, use the "id" attribute to fetch an SSOTokenReference object instead.

Request URI example

https://mysite.example.com/services/rest/connect/latest/sSOTokenReferences/33

Response body example

{
  "id": 33,
  "lookupName": "y/e4fanNQ5ZuYTRvW9uMEQfPt5eTfoKUK59y10eQ/w4=",
  "attributes": {
    "revoked": false,
    "singleUse": false,
    "used": false
  },
  "comment": null,
  "account": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/latest/accounts/389"
      },
      {
        "rel": "canonical",
        "href": "https://mysite.example.com/services/rest/connect/latest/accounts/389"
      },
      {
        "rel": "describedby",
        "href": "https://mysite.example.com/services/rest/connect/latest/metadata-catalog/accounts",
        "mediaType": "application/schema+json"
      }
    ]
  },
  "expiresTime": "2030-11-24T18:04:18.000Z",
  "issuedTime": "2010-11-24T17:54:18.000Z",
  "sSOProvider": null,
  "sSOTokenType": {
    "id": 2
  },

  "links": [
    {
      "rel": "self",
      "href": "https://mysite.example.com/services/rest/connect/latest/sSOTokenReferences/33"
    },
    {
      "rel": "canonical",
      "href": "https://mysite.example.com/services/rest/connect/latest/sSOTokenReferences/33"
    },
    {
      "rel": "describedby",
      "href": "https://mysite.example.com/services/rest/connect/latest/metadata-catalog/sSOTokenReferences",
      "mediaType": "application/schema+json"
    }
  ]
}