Generate Sync Client Token

Generate Sync Client Token

Generates a new sync client token

Request
URI
POST
https://sfo-vcf01.rainpole.io/v1/identity-providers/{id}/sync-client
COPY
Path Parameters
string
id
Required

ID of Identity Provider

Responses
200

OK

Returns SyncClientTokenInfo of type(s) */* 
{
    "expireAt": "The date and time when the token expires",
    "token": "string",
    "scimUrl": "string"
}
string
expireAt
Required

expireAt

string
token
Required

The sync client bearer token

string
scimUrl
Required

The WS1B SCIM URL to push users and groups data from external identity provider


401

Unauthorized

Returns ErrorResponse of type(s) */* 
{
    "arguments": [
        "string"
    ],
    "cause": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "context": {
        "context": "string"
    },
    "errorCode": "string",
    "message": "string",
    "nestedErrors": [
        "ErrorResponse Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}
array of string
arguments
Optional

arguments

array of ErrorCause
cause
Optional

cause

object
context
Optional

context

string
errorCode
Optional

errorCode

string
message
Optional

message

array of ErrorResponse
nestedErrors
Optional

nestedErrors

string
referenceToken
Optional

referenceToken

string
remediationMessage
Optional

remediationMessage


404

IDP is not found

Returns ErrorResponse of type(s) */* 
{
    "arguments": [
        "string"
    ],
    "cause": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "context": {
        "context": "string"
    },
    "errorCode": "string",
    "message": "string",
    "nestedErrors": [
        "ErrorResponse Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}
array of string
arguments
Optional

arguments

array of ErrorCause
cause
Optional

cause

object
context
Optional

context

string
errorCode
Optional

errorCode

string
message
Optional

message

array of ErrorResponse
nestedErrors
Optional

nestedErrors

string
referenceToken
Optional

referenceToken

string
remediationMessage
Optional

remediationMessage


500

Internal server error

Returns ErrorResponse of type(s) */* 
{
    "arguments": [
        "string"
    ],
    "cause": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "context": {
        "context": "string"
    },
    "errorCode": "string",
    "message": "string",
    "nestedErrors": [
        "ErrorResponse Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}
array of string
arguments
Optional

arguments

array of ErrorCause
cause
Optional

cause

object
context
Optional

context

string
errorCode
Optional

errorCode

string
message
Optional

message

array of ErrorResponse
nestedErrors
Optional

nestedErrors

string
referenceToken
Optional

referenceToken

string
remediationMessage
Optional

remediationMessage


On This Page
Identity Providers Operations
POST
Add Embedded Identity Source
POST
Add External Identity Provider
DELETE
Delete External Identity Provider
DELETE
Delete Identity Source
POST
Generate Sync Client Token
GET
Get Identity Provider By Id
GET
Get Identity Providers
PATCH
Update Embedded Identity Source
PATCH
Update External Identity Provider