--- updatedAt: 2026-06-04T19:58:43.000Z agentTools: projectIndex: https://docs.wristband.dev/llms.txt --- # Query External IdP Profiles For Authenticated User Queries the external IdP profiles associated with the authenticated user based on a query expression. ### Query Filter Attributes | Name | Type | Case Sensitive | Supported Comparison Operators | | ---------------------- | ------ | -------------- | ----------------------------------- | | `identityProviderName` | String | No | eq, ne, sw, lt, le, gt, ge, in, nin | ### Sort Attributes * `identityProviderName` # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Resource Management APIs", "version": "1.0.0", "description": "Resource Management APIs", "license": { "name": "Private", "url": "https://wristband.dev/terms/" }, "termsOfService": "https://wristband.dev/terms/", "contact": { "name": "Wristband Support", "email": "support@wristband.dev", "url": "https://wristband.dev/contact/" } }, "servers": [ { "url": "https://{application_vanity_domain}", "description": "Wristband application scoped URL.", "variables": { "application_vanity_domain": { "default": "yourapp-yourorg.us.wristband.dev", "description": "Wristband vanity domain scoped to a specific application." } } } ], "tags": [ { "name": "External IdP Profiles", "description": "External IdP Profiles", "x-displayName": "External IdP Profiles" } ], "paths": { "/api/v1/users/self/external-idp-profiles": { "get": { "summary": "Query External IdP Profiles For Authenticated User", "operationId": "queryExternalIdpProfilesForAuthenticatedUserV1", "tags": [ "External IdP Profiles" ], "parameters": [ { "$ref": "#/components/parameters/Resource_Management_APIs_Query" }, { "$ref": "#/components/parameters/Resource_Management_APIs_SortBy" }, { "$ref": "#/components/parameters/Resource_Management_APIs_StartIndex" }, { "$ref": "#/components/parameters/Resource_Management_APIs_Count" }, { "$ref": "#/components/parameters/Resource_Management_APIs_Fields" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Resource_Management_APIs_ExternalIdpProfileOffsetPaginatedResults" }, "examples": { "Example 1": { "$ref": "#/components/examples/Resource_Management_APIs_ExternalIdpProfileOffsetPaginatedResults" } } } } }, "400": { "$ref": "#/components/responses/Resource_Management_APIs_400-default" }, "401": { "$ref": "#/components/responses/Resource_Management_APIs_401" }, "403": { "$ref": "#/components/responses/Resource_Management_APIs_403" }, "405": { "$ref": "#/components/responses/Resource_Management_APIs_405" }, "406": { "$ref": "#/components/responses/Resource_Management_APIs_406" }, "500": { "$ref": "#/components/responses/Resource_Management_APIs_500" }, "503": { "$ref": "#/components/responses/Resource_Management_APIs_503" } }, "security": [ { "Resource_Management_APIs_BearerAuth": [] } ] } } }, "components": { "securitySchemes": { "Resource_Management_APIs_BearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } }, "parameters": { "Resource_Management_APIs_Fields": { "name": "fields", "in": "query", "required": false, "schema": { "type": "string", "default": "*", "example": "field1,field2", "minLength": 0 }, "description": "List of resource fields that should be returned in a response. The wildcard value of `*` can be used to return all fields for the resource.", "style": "form" }, "Resource_Management_APIs_Query": { "name": "query", "in": "query", "required": false, "schema": { "type": "string", "default": "\"\"", "example": "foo eq 'bar'", "minLength": 0 }, "description": "Query expression used to filter returned results in a query API call." }, "Resource_Management_APIs_SortBy": { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "example": "foo:desc,bar:asc" }, "description": "List of attributes that the results of a query should be sorted by along with their corresponding sort orders. The items that occur earlier in the list will have higher sorting precedence than those that occur later in the list." }, "Resource_Management_APIs_StartIndex": { "name": "start_index", "in": "query", "required": false, "schema": { "type": "number", "default": 1, "example": 1, "minimum": 1 }, "description": "A 1-based index indicating the position of the first item that should be returned in the query response." }, "Resource_Management_APIs_Count": { "name": "count", "in": "query", "required": false, "schema": { "type": "number", "minimum": 0, "default": 20, "example": 20 }, "description": "The maximum number of results that can be returned in a query response. If the value is set to 0 then the items array in the response will be empty; however the total results will still be set so you can see how many items this query matched." } }, "schemas": { "Resource_Management_APIs_api-error": { "title": "ApiError", "type": "object", "description": "API error object", "x-examples": { "Example 1": { "code": "invalid_request", "message": "The request was invalid", "ticket": "11t7n71hi5e6t" } }, "properties": { "type": { "type": "string", "example": "base_error", "minLength": 1, "description": "The type of the API error.", "readOnly": true }, "code": { "type": "string", "example": "invalid_request", "minLength": 1, "description": "A code identifying the error that occurred.", "readOnly": true }, "message": { "type": "string", "example": "The request was invalid", "description": "A free text message describing the error. This error message is only meant to help developers understand the cause of the error. It should not be used for programmatic purposes.", "readOnly": true }, "ticket": { "type": "string", "example": "11t7n71hi5e6t", "description": "Ticket that can help correlate the error to the backend", "readOnly": true }, "details": { "type": "object", "description": "A map of details about the error. The keys are defined by the API.", "additionalProperties": {}, "example": { "attemptsRemaining": 4 } } }, "required": [ "type", "code" ] }, "Resource_Management_APIs_constraint-violations-api-error": { "title": "ConstraintViolationsApiError", "description": "An API error that occurred due to a constraint violation", "allOf": [ { "$ref": "#/components/schemas/Resource_Management_APIs_api-error" }, { "type": "object", "readOnly": true, "required": [ "violations" ], "properties": { "violations": { "type": "object", "readOnly": true, "required": [ "code" ], "properties": { "code": { "type": "string", "description": "A code identifying the constraint violation.", "minLength": 1, "example": "too_long" }, "constraintAttributes": { "type": "object", "description": "A map of constraint attribute values.", "additionalProperties": { "type": "string" }, "example": { "maxLength": "10" } } } } } } ], "x-examples": { "Example 1": { "type": "constraint_violations_error", "code": "message_body_constraint_violations", "message": "The request contained invalid fields", "ticket": "11t7n71hi5e6t", "violations": { "field1": { "code": "too_long", "constraintAttributes": { "maxLength": "10" } }, "field2": { "code": "not_null" } } } } }, "Resource_Management_APIs_modification-metadata": { "title": "ModificationMetadata", "type": "object", "description": "Modification metadata associated to a resource.", "properties": { "lastModifiedTime": { "type": "string", "format": "date-time", "example": "2016-06-13T19:49:31.686Z", "description": "The time at which the resource was last modified", "readOnly": true }, "creationTime": { "type": "string", "format": "date-time", "example": "2016-06-13T19:49:31.686Z", "description": "The time at which the resource was created", "readOnly": true } } }, "Resource_Management_APIs_offset-paginated-results": { "title": "OffsetPaginatedResults", "type": "object", "description": "Offset paginated results returned from a query API call.", "x-examples": { "Example 1": { "totalResults": 200, "startIndex": 1, "itemsPerPage": 10 } }, "properties": { "totalResults": { "type": "integer", "format": "int64", "example": 200, "minimum": 0, "description": "The total number of results that satisfied the query expression.", "readOnly": true }, "startIndex": { "type": "integer", "format": "int32", "example": 1, "minimum": 1, "description": "A 1-based index representing the position of the first result in the returned query response.", "readOnly": true }, "itemsPerPage": { "type": "integer", "format": "int32", "example": 10, "minimum": 0, "description": "The number of results returned in a page.", "readOnly": true } }, "required": [ "totalResults", "startIndex", "itemsPerPage" ] }, "Resource_Management_APIs_ExternalIdpProfile": { "title": "External IdP Profile", "type": "object", "description": "External IdP Profile", "x-tags": [ "Models" ], "required": [ "identityProviderName", "identityProviderType", "subjectId" ], "properties": { "identityProviderName": { "type": "string", "example": "google", "readOnly": true, "minLength": 1, "maxLength": 70, "description": "The name of the identity provider that the external IdP profiles are associated to." }, "identityProviderType": { "type": "string", "enum": [ "APPLE", "BITBUCKET", "CUSTOM", "GITHUB", "GITLAB", "GOOGLE", "GOOGLE_WORKSPACE", "MICROSOFT", "MICROSOFT_ENTRA_ID", "OKTA" ], "example": "GOOGLE", "readOnly": true, "minLength": 1, "maxLength": 25, "description": "The type of the identity provider that the external IdP profiles are associated to." }, "subjectId": { "type": "string", "example": "00u50lxx9rZpbudsa78971", "readOnly": true, "minLength": 1, "description": "The ID of the user from the external IdP." }, "email": { "type": "string", "example": "fake@email.com", "readOnly": true, "minLength": 1, "maxLength": 200, "description": "The user's email." }, "fullName": { "type": "string", "example": "Mike Smith", "readOnly": true, "minLength": 1, "maxLength": 200, "description": "The user's full name, including all middle names, titles, and suffixes as appropriate, formatted for display (e.g., \"Ms. Barbara Jane Jensen, III”)." }, "givenName": { "type": "string", "example": "Mike", "readOnly": true, "minLength": 1, "maxLength": 200, "description": "Given name" }, "familyName": { "type": "string", "example": "Smith", "readOnly": true, "minLength": 1, "description": "Family name." }, "birthdate": { "type": "string", "example": "1999-03-29", "readOnly": true, "minLength": 1, "description": "The user's birthday represented in ISO 8601 YYYY-MM-DD format.", "format": "date" }, "phoneNumber": { "type": "string", "example": "+16045551234", "readOnly": true, "minLength": 1, "description": "The user's telephone number in E.164 format." }, "groups": { "description": "List of groups that the user belongs to.", "type": "array", "readOnly": true, "maxItems": 50, "uniqueItems": true, "items": { "description": "Group name", "type": "string", "minLength": 1, "maxLength": 200, "example": "Admin" }, "example": [ "Admin", "Payer" ] }, "rawData": { "description": "JSON containing raw user data returned from the IdP. The fields included in the JSON are typically derived from \none of the following locations: the IdP's user APIs, the ID token claims, or the SAML response assertions. The \nactual fields returned in the raw data varies depending on the IdP.\n", "readOnly": true, "example": { "fieldA": "a", "fieldB": "b" } }, "metadata": { "$ref": "#/components/schemas/Resource_Management_APIs_modification-metadata" } }, "example": { "identityProviderName": "google", "identityProviderType": "GOOGLE", "subjectId": "00u50lxx9rZpbudsa78971", "email": "fake@email.com", "fullName": "Mike Smith", "givenName": "Mike", "familyName": "Smith", "birthdate": "1999-03-29", "phoneNumber": "+16045551234", "groups": [ "Admin", "Payer" ], "rawData": { "fieldA": "a", "fieldB": "b" }, "metadata": { "lastModifiedTime": "2021-06-13T19:49:31.686Z", "creationTime": "2021-06-13T19:49:31.686Z" } } }, "Resource_Management_APIs_ExternalIdpProfileOffsetPaginatedResults": { "title": "External IdP Profile Offset Paginated Results", "description": "External IdP Profile Offset Paginated Results", "x-tags": [ "Models" ], "allOf": [ { "$ref": "#/components/schemas/Resource_Management_APIs_offset-paginated-results" }, { "type": "object", "description": "External IdP Profile Offset Paginated Results", "properties": { "items": { "type": "array", "description": "Array of external IdP profiles that satisfied the query criteria", "uniqueItems": true, "items": { "$ref": "#/components/schemas/Resource_Management_APIs_ExternalIdpProfile" }, "readOnly": true } }, "required": [ "items" ] } ], "example": { "totalResults": 200, "startIndex": 1, "itemsPerPage": 10, "items": [ { "identityProviderName": "google", "identityProviderType": "GOOGLE", "subjectId": "00u50lxx9rZpbudsa78971", "email": "fake@email.com", "fullName": "Mike Smith", "givenName": "Mike", "familyName": "Smith", "groups": [ "Admin", "Payer" ], "rawData": { "fieldA": "a", "fieldB": "b" }, "metadata": { "lastModifiedTime": "2021-06-13T19:49:31.686Z", "creationTime": "2021-06-13T19:49:31.686Z" } } ] } } }, "examples": { "Resource_Management_APIs_ExternalIdpProfileOffsetPaginatedResults": { "description": "External IdP Token Batch Offset Paginated Results JSON object.", "value": { "totalResults": 1, "startIndex": 1, "itemsPerPage": 10, "items": [ { "identityProviderName": "google", "identityProviderType": "GOOGLE", "subjectId": "00u50lxx9rZpbudsa78971", "email": "fake@email.com", "fullName": "Mike Smith", "givenName": "Mike", "familyName": "Smith", "groups": [ "Admin", "Payer" ], "rawData": { "fieldA": "a", "fieldB": "b" }, "metadata": { "lastModifiedTime": "2021-06-13T19:49:31.686Z", "creationTime": "2021-06-13T19:49:31.686Z" } } ] } } }, "responses": { "Resource_Management_APIs_401": { "description": "Unauthorized", "headers": { "WWW-Authenticate": { "description": "Includes details on the failed authentication condition. This header is set in accordance with the [OAuth2 specification](https://datatracker.ietf.org/doc/html/rfc6750#section-3).", "schema": { "type": "string", "example": "Bearer error=\"invalid_token\", error_description=\"The provided access token was invalid\"" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Resource_Management_APIs_api-error" }, "examples": { "code - unauthenticated": { "value": { "type": "base_error", "code": "invalid_access_token", "message": "The provided access token was invalid", "ticket": "1u0d0edhwbjsd" } } } } } }, "Resource_Management_APIs_403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Resource_Management_APIs_api-error" }, "examples": { "code - unauthorized": { "value": { "type": "base_error", "code": "unauthorized", "message": "The request failed authorization", "ticket": "11t7n71hi5e6t" } } } } } }, "Resource_Management_APIs_405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Resource_Management_APIs_api-error" }, "examples": { "code - method_not_supported": { "value": { "type": "base_error", "code": "method_not_supported", "message": "The specified HTTP method is not supported", "ticket": "11t7n71hi5e6t" } } } } } }, "Resource_Management_APIs_406": { "description": "Not Acceptable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Resource_Management_APIs_api-error" }, "examples": { "code - not_acceptable": { "value": { "type": "base_error", "code": "not_acceptable", "message": "The Accept header was invalid", "ticket": "11t7n71hi5e6t" } } } } } }, "Resource_Management_APIs_500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Resource_Management_APIs_api-error" }, "examples": { "code - internal_server_failure ": { "value": { "type": "base_error", "code": "internal_server_failure", "message": "An unexpected error occurred while processing the request", "ticket": "11t7n71hi5e6t" } } } } } }, "Resource_Management_APIs_503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Resource_Management_APIs_api-error" }, "examples": { "code - service_unavailable": { "value": { "type": "base_error", "code": "service_unavailable", "message": "The service is currently unavailable", "ticket": "11t7n71hi5e6t" } } } } } }, "Resource_Management_APIs_400-default": { "description": "Bad Request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Resource_Management_APIs_api-error" }, { "$ref": "#/components/schemas/Resource_Management_APIs_constraint-violations-api-error" } ] }, "examples": { "code - invalid_request": { "value": { "type": "base_error", "code": "invalid_request", "message": "The request was invalid", "ticket": "11t7n71hi5e6t" } }, "code - request_constraint_violations": { "value": { "type": "constraint_violations_error", "code": "message_body_constraint_violations", "message": "The message body contained invalid fields", "ticket": "11t7n71hi5e6t", "violations": { "field1": { "code": "too_long", "constraintAttributes": { "maxLength": 10 } }, "field2": { "code": "not_null" } } } } } } } } } }, "x-tagGroups": [ { "name": "Resource Management APIs", "tags": [ "Applications", "Auth Factors", "Auth Sessions", "Auth Session Policies", "Bot Detection Policies", "Custom Claims", "Custom Domains", "Email Brandings", "Email Domains", "Email Policies", "External IdP Profiles", "External IdP Tokens", "Identity Providers", "IdP Attribute Mappings", "IdP Role Mappings", "MFA Policies", "OAuth2 Clients", "Page Brandings", "Password Policies", "Permissions", "Permission Boundaries", "Permission Groups", "Refresh Tokens", "Remembered Tenants", "Roles", "Role Assignment Policies", "Signing Keys", "Tenants", "Users", "User Schemas", "Vanity Domains", "Webhook Policies", "Workflow Policies" ] } ] } ```