Rippling: Retrieve my SSO information
Rippling restApi.listSsoMe: arguments, response, policy and SDK examples.
← Rest API operations · Get started
Operation rippling.rest_api.list_sso_me
Provider route: GET /sso-me/. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/rippling with npm, or alter-sdk-rippling with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { RipplingIntegration } from "@alter-ai/rippling";
async function execute(input: Parameters<RipplingIntegration["restApi"]["listSsoMe"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new RipplingIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.restApi.listSsoMe(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_rippling import RipplingIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = RipplingIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.rest_api.list_sso_me(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.expand | string | Optional | |
query.limit | integer | Optional | Default: 50 Maximum: 100 Minimum: 1 |
query.cursor | string | Optional |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
company | object | Optional | The company of the user. Expandable field |
company.created_at | string | Required within parent | Record creation date |
company.doing_business_as_name | string | Optional | The doing business as name for the company. |
company.id | string | Required within parent | Identifier field |
company.legal_entities | array | Required within parent | A list of the company’s entities. Expandable field |
company.legal_entities[] | Model | Each item | Expand Retrieve my SSO information — response body — company legal entities item |
company.legal_entities_id | array | Required within parent | A list of the company’s entities. |
company.legal_entities_id[] | string | Each item | |
company.legal_name | string | Optional | The legal name of the company. |
company.name | string | Required within parent | The name of the company. |
company.parent_legal_entity | Model | Optional | Expand Retrieve my SSO information — response body — company parent legal entity |
company.parent_legal_entity_id | string | Optional | The company’s ultimate holding entity. |
company.phone | string | Optional | The phone number for the company. |
company.physical_address | Model | Optional | Expand Retrieve my SSO information — response body — company physical address |
company.primary_email | string | Optional | The email address used when registering this company. |
company.updated_at | string | Required within parent | Record update date |
company_id | string | Optional | The company ID of the user. |
created_at | string | Required within parent | Record creation date |
id | string | Required within parent | Identifier field |
updated_at | string | Required within parent | Record update date |
work_email | string | Optional | The user’s work email address. |
Referenced models: Retrieve my SSO information — response body — company legal entities item, Retrieve my SSO information — response body — company parent legal entity, Retrieve my SSO information — response body — company physical address
Schemas
Section titled “Schemas”5 more schemas are linked from the tables above, on the schema pages.
Retrieve my SSO information — response body — company legal entities item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
company | Model | Optional | Expand List companies — response body — results item The company or organization associated with the legal entity Expandable field |
company_id | string | Optional | The company or organization associated with the legal entity |
country | Model | Optional | Expand Retrieve a specific legal entity — response body — country |
created_at | string | Required within parent | Record creation date |
entity_level | string | Optional | The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity. Known values: PARENT, SUBSIDIARY, BRANCH |
id | string | Required within parent | Identifier field |
legal_name | string | Optional | The legal name of the legal entity. |
mailing_address | Model | Optional | Expand Retrieve a specific legal entity — response body — mailing address |
management_type | string | Optional | The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR). Known values: PEO, EOR, COR |
parent | Model | Optional | Expand Retrieve a specific legal entity — response body — parent The parent legal entity. Expandable field |
parent_id | string | Optional | The parent legal entity. |
physical_address | Model | Optional | Expand Retrieve a specific legal entity — response body — physical address |
registration_date | string | Optional | The registration date of the entity. |
tax_identifier | string | Optional | The tax identifier for the legal entity. |
updated_at | string | Required within parent | Record update date |
Referenced models: List companies — response body — results item, Retrieve a specific legal entity — response body — parent, Retrieve a specific legal entity — response body — country, Retrieve a specific legal entity — response body — mailing address, Retrieve a specific legal entity — response body — physical address
Retrieve my SSO information — response body — company parent legal entity
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The company's ultimate holding entity. Expandable field |
company | Model | Optional | Expand List companies — response body — results item The company or organization associated with the legal entity Expandable field |
company_id | string | Optional | The company or organization associated with the legal entity |
country | Model | Optional | Expand Retrieve a specific legal entity — response body — country |
created_at | string | Required within parent | Record creation date |
entity_level | string | Optional | The legal entity's level in a hierarchy. * `PARENT`: The legal entity is considered the ultimate holding entity. * `SUBSIDIARY`: The legal entity is considered a subsidiary, fully or partially held by another. * `BRANCH`: The legal entity is considered a branch, associated with a parent legal entity. Known values: PARENT, SUBSIDIARY, BRANCH |
id | string | Required within parent | Identifier field |
legal_name | string | Optional | The legal name of the legal entity. |
mailing_address | Model | Optional | Expand Retrieve a specific legal entity — response body — mailing address |
management_type | string | Optional | The legal entity management type in the case of an employer of record (EOR) or professional employment organization (PEO). * `PEO`: The legal entity is considered a Professional Employment Organization (PEO). * `EOR`: The legal entity is considered an Employer of Record (EOR). Known values: PEO, EOR, COR |
parent | Model | Optional | Expand Retrieve a specific legal entity — response body — parent The parent legal entity. Expandable field |
parent_id | string | Optional | The parent legal entity. |
physical_address | Model | Optional | Expand Retrieve a specific legal entity — response body — physical address |
registration_date | string | Optional | The registration date of the entity. |
tax_identifier | string | Optional | The tax identifier for the legal entity. |
updated_at | string | Required within parent | Record update date |
Referenced models: List companies — response body — results item, Retrieve a specific legal entity — response body — parent, Retrieve a specific legal entity — response body — country, Retrieve a specific legal entity — response body — mailing address, Retrieve a specific legal entity — response body — physical address
Retrieve my SSO information — response body — company physical address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The physical address of the holding entity. |
country | string | Optional | The country component, pursuant to SCIM RFC 7643 4.1.2. Known values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IQ, IR, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SY, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SE, CH, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW |
formatted | string | Optional | The formatted mailing address. |
locality | string | Optional | The city or locality component. |
postal_code | string | Optional | The zip code or postal code component, pursuant to SCIM RFC 7643 4.1.2. |
region | string | Optional | The state or region component, pursuant to SCIM RFC 7643 4.1.2. |
street_address | string | Optional | The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information, pursuant to SCIM RFC 7643 4.1.2.. |
type | string | Optional | The classification of the address. Known values: HOME, WORK, OTHER |
List companies — response body — results item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Record creation date |
doing_business_as_name | string | Optional | The doing business as name for the company. |
id | string | Required within parent | Identifier field |
legal_entities | array | Required within parent | A list of the company's entities. Expandable field |
legal_entities[] | Model | Each item | Expand Retrieve my SSO information — response body — company legal entities item |
legal_entities_id | array | Required within parent | A list of the company's entities. |
legal_entities_id[] | string | Each item | |
legal_name | string | Optional | The legal name of the company. |
name | string | Required within parent | The name of the company. |
parent_legal_entity | Model | Optional | Expand Retrieve my SSO information — response body — company parent legal entity |
parent_legal_entity_id | string | Optional | The company's ultimate holding entity. |
phone | string | Optional | The phone number for the company. |
physical_address | Model | Optional | Expand Retrieve my SSO information — response body — company physical address |
primary_email | string | Optional | The email address used when registering this company. |
updated_at | string | Required within parent | Record update date |
Referenced models: Retrieve my SSO information — response body — company legal entities item, Retrieve my SSO information — response body — company parent legal entity, Retrieve my SSO information — response body — company physical address
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: rippling.rest_api.list_sso_me. Catalog operation: list-sso-me. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["sso-me.read"]
Provider entitlements: ["API_Tier_1"]
Pinned headers: {"Rippling-Api-Version": "2024-08-01"}